JavaTM 2 Platform
Standard Ed. 5.0

java.awt.font
クラス TextAttribute

java.lang.Object
  上位を拡張 java.text.AttributedCharacterIterator.Attribute
      上位を拡張 java.awt.font.TextAttribute
すべての実装されたインタフェース:
Serializable

public final class TextAttribute
extends AttributedCharacterIterator.Attribute

TextAttribute クラスは、テキストの描画に使用する属性キーおよび属性値を定義します。

TextAttribute のインスタンスは、テキスト属性を扱う AttributedCharacterIteratorFont などのクラスで属性を識別するための属性キーとして使用されます。このクラスで定義されているその他の定数は属性値として使用されます。

各テキスト属性に関して、このドキュメントでは以下の項目について説明しています。

値の型

補間

関連項目:
AttributedCharacterIterator, Font, 直列化された形式

フィールドの概要
static TextAttribute BACKGROUND
          バックグラウンドの塗りつぶし装飾を表す属性キーです。
static TextAttribute BIDI_EMBEDDING
          入れ子になった双方向ランの埋め込みレベルを表す属性キーです。
static TextAttribute CHAR_REPLACEMENT
          文字の代わりにテキストに表示するためのユーザ定義グリフを表す属性キーです。
static TextAttribute FAMILY
          地域対応されていないフォントファミリ名を表す属性キーです。
static TextAttribute FONT
          テキストの描画に使用するフォントを表す属性キーです。
static TextAttribute FOREGROUND
          フォアグラウンドの塗りつぶし修飾を表す属性キーです。
static TextAttribute INPUT_METHOD_HIGHLIGHT
          インプットメソッドのハイライトのスタイルを表す属性キーです。
static TextAttribute INPUT_METHOD_UNDERLINE
          下線による修飾を表す属性キーです。
static TextAttribute JUSTIFICATION
          段落の位置揃えを表す属性キーです。
static Float JUSTIFICATION_FULL
          要求された幅全体に行を揃えます。
static Float JUSTIFICATION_NONE
          行の位置揃えを許可しません。
static TextAttribute NUMERIC_SHAPING
          ASCII の 10 進数をほかの 10 進数の範囲に変換するための属性キーです。
static TextAttribute POSTURE
          フォントのポスチャを表す属性キーです。
static Float POSTURE_OBLIQUE
          標準イタリックポスチャです。
static Float POSTURE_REGULAR
          標準ポスチャである垂直です。
static TextAttribute RUN_DIRECTION
          行のラン方向を表す属性キーです。
static Boolean RUN_DIRECTION_LTR
          ランの方向は左から右です。
static Boolean RUN_DIRECTION_RTL
          ランの方向は右から左です。
static TextAttribute SIZE
          フォントサイズを表す属性キーです。
static TextAttribute STRIKETHROUGH
          取り消し線による修飾を表す属性キーです。
static Boolean STRIKETHROUGH_ON
          一重取り消し線です。
static TextAttribute SUPERSCRIPT
          上付き文字や下付き文字を表す属性キーです。
static Integer SUPERSCRIPT_SUB
          標準の下付き文字です。
static Integer SUPERSCRIPT_SUPER
          標準の上付き文字です。
static TextAttribute SWAP_COLORS
          フォアグラウンドとバックグラウンドの塗りつぶし (色) の入れ替えを表す属性キーです。
static Boolean SWAP_COLORS_ON
          フォアグラウンドとバックグラウンドを入れ替えます。
static TextAttribute TRANSFORM
          フォントの変換を表す属性キーです。
static TextAttribute UNDERLINE
          下線による修飾を表す属性キーです。
static Integer UNDERLINE_LOW_DASHED
          シングルピクセルの破線の下線です。
static Integer UNDERLINE_LOW_DOTTED
          シングルピクセルの点線の下線です。
static Integer UNDERLINE_LOW_GRAY
          ダブルピクセルのグレーの下線です。
static Integer UNDERLINE_LOW_ONE_PIXEL
          シングルピクセルの実線の下線です。
static Integer UNDERLINE_LOW_TWO_PIXEL
          ダブルピクセルの実線の下線です。
static Integer UNDERLINE_ON
          ローマ字テキストのベースライン位置と、その他のテキストのディセンダの下に付ける標準の下線です。
static TextAttribute WEIGHT
          フォントのウェイトを表す属性キーです。
static Float WEIGHT_BOLD
          標準のボールドウェイトです。
static Float WEIGHT_DEMIBOLD
          BOLD よりやや軽いウェイトです。
static Float WEIGHT_DEMILIGHT
          LIGHT と STANDARD の中間のウェイトです。
static Float WEIGHT_EXTRA_LIGHT
          もっとも軽い定義済みウェイトです。
static Float WEIGHT_EXTRABOLD
          非常に重いウェイトです。
static Float WEIGHT_HEAVY
          BOLD よりやや重いウェイトです。
static Float WEIGHT_LIGHT
          標準の軽量ウェイトです。
static Float WEIGHT_MEDIUM
          REGULAR と BOLD の中間のウェイトです。
static Float WEIGHT_REGULAR
          標準のウェイトです。
static Float WEIGHT_SEMIBOLD
          REGULAR よりやや重いウェイトです。
static Float WEIGHT_ULTRABOLD
          もっとも重い定義済みウェイトです。
static TextAttribute WIDTH
          フォントの幅を表す属性キーです。
static Float WIDTH_CONDENSED
          もっとも狭い定義済みの幅です。
static Float WIDTH_EXTENDED
          もっとも広い定義済みの幅です。
static Float WIDTH_REGULAR
          標準の幅です。
static Float WIDTH_SEMI_CONDENSED
          やや狭い幅です。
static Float WIDTH_SEMI_EXTENDED
          やや広い幅です。
 
クラス java.text.AttributedCharacterIterator.Attribute から継承されたフィールド
INPUT_METHOD_SEGMENT, LANGUAGE, READING
 
コンストラクタの概要
protected TextAttribute(String name)
          指定された名前の TextAttribute を構築します。
 
メソッドの概要
protected  Object readResolve()
          直列化復元されるインスタンスを定義済み定数に解決します。
 
クラス java.text.AttributedCharacterIterator.Attribute から継承されたメソッド
equals, getName, hashCode, toString
 
クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

FAMILY

public static final TextAttribute FAMILY
地域対応されていないフォントファミリ名を表す属性キーです。

キー

FAMILY

String

定数

"Serif"、"SansSerif"

デフォルト

ホストのデフォルト

説明

フォントファミリの名前です。ファミリ名が見つからない場合には、デフォルトフォントが使用されます。名前には、完全フォント名やほかの属性 ("Helvetica Bold"名など) を指定しないでください。このような名前の場合、既知のファミリ名と一致しないために、デフォルトフォントが使用されることがあります。


WEIGHT

public static final TextAttribute WEIGHT
フォントのウェイトを表す属性キーです。

キー

WEIGHT

Float

定数

WEIGHT_EXTRA_LIGHT = 0.5、
WEIGHT_LIGHT = 0.75、
WEIGHT_DEMILIGHT = 0.875、
WEIGHT_REGULAR = 1.0、
WEIGHT_SEMIBOLD = 1.25、
WEIGHT_MEDIUM = 1.5、
WEIGHT_DEMIBOLD = 1.75、
WEIGHT_BOLD = 2.0、
WEIGHT_HEAVY = 2.25、
WEIGHT_EXTRABOLD = 2.5、
WEIGHT_ULTRABOLD = 2.75

デフォルト

WEIGHT_REGULAR

説明

この値は、標準ウェイトの幅に対するステム幅の比率にほぼ等しくなります。フォントが特定の定数に対して別の値を持っている場合、値はクラスの解説で説明したように補間されます。

代替

現在はありません。ただし、将来的にはウェイトのバリエーションを持たないフォントで
ウェイトのバリエーションをシミュレートするために、形状を操作できるようになる予定です。


WEIGHT_EXTRA_LIGHT

public static final Float WEIGHT_EXTRA_LIGHT
もっとも軽い定義済みウェイトです。

関連項目:
WEIGHT

WEIGHT_LIGHT

public static final Float WEIGHT_LIGHT
標準の軽量ウェイトです。

関連項目:
WEIGHT

WEIGHT_DEMILIGHT

public static final Float WEIGHT_DEMILIGHT
LIGHT と STANDARD の中間のウェイトです。

関連項目:
WEIGHT

WEIGHT_REGULAR

public static final Float WEIGHT_REGULAR
標準のウェイトです。WEIGHT が指定されていない場合は、このウェイトが使用されます。

関連項目:
WEIGHT

WEIGHT_SEMIBOLD

public static final Float WEIGHT_SEMIBOLD
REGULAR よりやや重いウェイトです。

関連項目:
WEIGHT

WEIGHT_MEDIUM

public static final Float WEIGHT_MEDIUM
REGULAR と BOLD の中間のウェイトです。

関連項目:
WEIGHT

WEIGHT_DEMIBOLD

public static final Float WEIGHT_DEMIBOLD
BOLD よりやや軽いウェイトです。

関連項目:
WEIGHT

WEIGHT_BOLD

public static final Float WEIGHT_BOLD
標準のボールドウェイトです。

関連項目:
WEIGHT

WEIGHT_HEAVY

public static final Float WEIGHT_HEAVY
BOLD よりやや重いウェイトです。

関連項目:
WEIGHT

WEIGHT_EXTRABOLD

public static final Float WEIGHT_EXTRABOLD
非常に重いウェイトです。

関連項目:
WEIGHT

WEIGHT_ULTRABOLD

public static final Float WEIGHT_ULTRABOLD
もっとも重い定義済みウェイトです。

関連項目:
WEIGHT

WIDTH

public static final TextAttribute WIDTH
フォントの幅を表す属性キーです。

キー

WIDTH

Float

定数

WIDTH_CONDENSED = 0.75、
WIDTH_SEMI_CONDENSED = 0.875、
WIDTH_REGULAR = 1.0、
WIDTH_SEMI_EXTENDED = 1.25、
WIDTH_EXTENDED = 1.5

デフォルト

WIDTH_REGULAR

説明

この値は、標準幅に対する有効幅の比率にほぼ等しくなります。フォントが特定の定数に対して別の値を持っている場合、値はクラスの解説で説明したように補間されます。

代替

Narrow フォントが使用可能で、一致した場合には、そのフォントを使用します。そうでない場合には、その値に基づいた変換を使ってスケーリングします。


WIDTH_CONDENSED

public static final Float WIDTH_CONDENSED
もっとも狭い定義済みの幅です。

関連項目:
WIDTH

WIDTH_SEMI_CONDENSED

public static final Float WIDTH_SEMI_CONDENSED
やや狭い幅です。

関連項目:
WIDTH

WIDTH_REGULAR

public static final Float WIDTH_REGULAR
標準の幅です。WIDTH が指定されていない場合は、この幅が使用されます。

関連項目:
WIDTH

WIDTH_SEMI_EXTENDED

public static final Float WIDTH_SEMI_EXTENDED
やや広い幅です。

関連項目:
WIDTH

WIDTH_EXTENDED

public static final Float WIDTH_EXTENDED
もっとも広い定義済みの幅です。

関連項目:
WIDTH

POSTURE

public static final TextAttribute POSTURE
フォントのポスチャを表す属性キーです。

キー

POSTURE

Float

定数

POSTURE_REGULAR = 0、
POSTURE_OBLIQUE = 0.20

デフォルト

POSTURE_REGULAR

説明

通常、この値は右側への正の傾きを持つ傾斜として解釈されます。フォントが特定の定数に対して別の値を持っている場合、値はクラスの解説で説明したように補間されます。イタリックフェースを持つフォントの場合、文字の傾きだけでなく、文字の形状も変わることがあります。
注:
値を角度で設定するには、次のように指定します。
value = new Float(Math.tan(Math.PI*degrees/180.0)
値から角度を設定するには、次のように指定します。
angle = Math.atan(value.floatValue())*180/Math.PI

代替

Oblique フォントが使用可能で、一致する場合には、そのフォントを使用します。そうでない場合には、水平距離/垂直高さとして解釈されるポスチャ (傾き) 値による変換を使用して傾斜をつけます。

関連項目:
Font.getItalicAngle()

POSTURE_REGULAR

public static final Float POSTURE_REGULAR
標準ポスチャである垂直です。

関連項目:
POSTURE

POSTURE_OBLIQUE

public static final Float POSTURE_OBLIQUE
標準イタリックポスチャです。

関連項目:
POSTURE

SIZE

public static final TextAttribute SIZE
フォントサイズを表す属性キーです。

キー

SIZE

Float

デフォルト

システムのプロパティから

説明

ポイントサイズを表します。2X に変換された 12pt のフォントの外観およびメトリックスは、変換されていない 24pt のフォントの外観およびメトリックスと異なる場合があります。

代替

指定されたサイズにスケーリングします。


TRANSFORM

public static final TextAttribute TRANSFORM
フォントの変換を表す属性キーです。

キー

TRANSFORM

TransformAttribute

デフォルト

恒等変換

説明

このフォントによって描画されたグリフを変換するために使用されます。主な目的は、スケーリング、スキュー、および平行移動をサポートすることです。大きな回転は、通常は有効な結果を得られません。変換によって、グリフと有効幅の両方が変更されます。変換時の平行移動は、ポイントサイズの比率として解釈されます。つまりポイントサイズ 12 は、0.5 の平行移動によって、6 ポイント分移動されます。

変換されたグリフの有効幅のポイントは、ベースライン上に投影された有効幅のポイントの変換です。有効幅がグリフの原点の左 (上) になる場合、2 つのポイントは交替されます。

例 1: ポイントサイズが 20、元の有効幅が 10.0 で、反時計方向に 60 度回転して、上に 0.1、右に -0.1 のオフセットで変換を行います。平行移動によって、オフセットは <2.0, -2.0> になります。元の有効幅のポイント <10.0, 0.0> は回転後 <6.0, -8.0> になり、オフセットを追加すると <8.0,-10.0> になり、これを (水平) のベースライン上に投影すると、新しい有効幅のポイントは <8.0, 0.0> になります。有効幅は、原点と有効幅のポイント 8.0 との距離になります。グリフを回転することによって、その原点の上側および右側に 2 つのポイントが描画および回転されます。この処理は、後続のグリフのベースラインには影響しません。


SUPERSCRIPT

public static final TextAttribute SUPERSCRIPT
上付き文字や下付き文字を表す属性キーです。

キー

SUPERSCRIPT

整数

定数

SUPERSCRIPT_NONE = 0、
SUPERSCRIPT_SUPER = 1、
SUPERSCRIPT_SUB = -1

デフォルト

SUPERSCRIPT_NONE

説明

フォントに、特定の上付きまたは下付きレベル (0 = none、1 = superscript、2 = superscript of superscript、...、-1 = subscript、-2 = subscript of subscript、...) のグリフで文字を表示させます。フォントに、デフォルトの上付き (または下付き) グリフおよび/またはスケーリングを使用したテキストを表示させます。

代替

各レベルに合わせて、+/-1/2 移動して 2/3 にスケーリングします。つまり、レベル N (N != 0) での変換の場合
offset = sign(N)*1/2*(2/3)^(abs(N)-1)
scale = (2/3)^abs(N)


SUPERSCRIPT_SUPER

public static final Integer SUPERSCRIPT_SUPER
標準の上付き文字です。

関連項目:
SUPERSCRIPT

SUPERSCRIPT_SUB

public static final Integer SUPERSCRIPT_SUB
標準の下付き文字です。

関連項目:
SUPERSCRIPT

FONT

public static final TextAttribute FONT
テキストの描画に使用するフォントを表す属性キーです。

キー

FONT

Font

デフォルト

なし。デフォルトの解決を実行

説明

ユーザがフォント属性の Font への解釈をオーバーライドしたり、特定の Font のインスタンスを使用したりするための方法です。これにより、Font がサブクラス化できる場合に、ユーザが Font のサブクラスを指定することもできます。


CHAR_REPLACEMENT

public static final TextAttribute CHAR_REPLACEMENT
文字の代わりにテキストに表示するためのユーザ定義グリフを表す属性キーです。

キー

CHAR_REPLACEMENT

GraphicAttribute

説明

これにより、ユーザは空の位置とメトリックス情報を指定できます。このメソッドは、図形などの埋め込みコンポーネントの領域を確保するために使用されます。行の中の「インライン」コンポーネントの正確な BIDI 位置を出すために必要です。単純なケースでは、オプションの簡易メソッドを使って描画できます。これを適用する文字を \uFFFC とする Microsoft のモデルに従います。


FOREGROUND

public static final TextAttribute FOREGROUND
フォアグラウンドの塗りつぶし修飾を表す属性キーです。

キー

FOREGROUND

Paint

デフォルト

Color.black

説明

テキストのフォアグラウンドの塗りつぶし (色) を指定します。


BACKGROUND

public static final TextAttribute BACKGROUND
バックグラウンドの塗りつぶし装飾を表す属性キーです。

キー

BACKGROUND

Paint

デフォルト

null

説明

テキストのバックグラウンドの塗りつぶし (色) を指定します。


UNDERLINE

public static final TextAttribute UNDERLINE
下線による修飾を表す属性キーです。

キー

UNDERLINE

整数

定数

UNDERLINE_ON = 0

デフォルト

なし

説明

フォントによって描画されたグリフに追加する修飾

代替


UNDERLINE_ON

public static final Integer UNDERLINE_ON
ローマ字テキストのベースライン位置と、その他のテキストのディセンダの下に付ける標準の下線です。

関連項目:
UNDERLINE

STRIKETHROUGH

public static final TextAttribute STRIKETHROUGH
取り消し線による修飾を表す属性キーです。

キー

STRIKETHROUGH

Boolean

定数

true = on、 false = off

デフォルト

off

説明

フォントによって描画されたグリフに追加する修飾


STRIKETHROUGH_ON

public static final Boolean STRIKETHROUGH_ON
一重取り消し線です。

関連項目:
STRIKETHROUGH

RUN_DIRECTION

public static final TextAttribute RUN_DIRECTION
行のラン方向を表す属性キーです。

キー

RUN_DIRECTION

Boolean

定数

RUN_DIRECTION_LTR = true、 RUN_DIRECTION_RTL = false

デフォルト

BIDI アルゴリズムに基づいて、デフォルトの Unicode の基準方向を使用します。

説明

段落内でさまざまな方向のランの位置を決めるときの基準ランの方向を指定します。この値が RUN_DIRECTION_DEFAULT の場合、TextLayout は BIDI アルゴリズムに基づいて、デフォルトの Unicode の基準方向を使用します。

この属性は、段落全体で同じ値でなければなりません。


RUN_DIRECTION_LTR

public static final Boolean RUN_DIRECTION_LTR
ランの方向は左から右です。

関連項目:
RUN_DIRECTION

RUN_DIRECTION_RTL

public static final Boolean RUN_DIRECTION_RTL
ランの方向は右から左です。

関連項目:
RUN_DIRECTION

BIDI_EMBEDDING

public static final TextAttribute BIDI_EMBEDDING
入れ子になった双方向ランの埋め込みレベルを表す属性キーです。

キー

BIDI_EMBEDDING

整数

リミット

1 〜 61 の正の値は「埋め込み」レベル、
0 〜 -61 の負の値は「オーバーライド」レベルです。

デフォルト

標準の BIDI を使用して、テキスト内の書式化文字からレベルを計算します。

説明

文字の BIDI 埋め込みレベルを指定します。この属性が段落内に指定されている場合、Unicode 文字の RLO、LRO、RLE、LRE、PDF は、その段落内の BIDI 解析で無視されます。Unicode Standard v. 2.0 の 3 〜 11 節を参照してください。


JUSTIFICATION

public static final TextAttribute JUSTIFICATION
段落の位置揃えを表す属性キーです。

キー

JUSTIFICATION

Float

リミット

0.0 〜 1.0

デフォルト

1.0

説明

位置揃えが要求された場合に、余分な領域のどの部分を使用するかを指定します。たとえば、行が 50 ポイント幅で、マージンが 70 ポイント幅の場合、値 0.5 は、幅が 60 ポイントになるまで行を引き伸ばすことを意味します。

この属性は、段落全体で同じ値でなければなりません。


JUSTIFICATION_FULL

public static final Float JUSTIFICATION_FULL
要求された幅全体に行を揃えます。

関連項目:
JUSTIFICATION

JUSTIFICATION_NONE

public static final Float JUSTIFICATION_NONE
行の位置揃えを許可しません。

関連項目:
JUSTIFICATION

INPUT_METHOD_HIGHLIGHT

public static final TextAttribute INPUT_METHOD_HIGHLIGHT
インプットメソッドのハイライトのスタイルを表す属性キーです。

値は InputMethodHighlight のインスタンスです。複数のセグメントを別々に強調表示する必要がある場合、これらのインスタンスを Annotation のインスタンスでラップする必要があります。

インプットメソッドのハイライトは、テキストをインプットメソッドで変換する場合に使用されます。通常は書式化されていないテキストだけを扱うものであっても、テキスト編集コンポーネントはハイライトを保持し、描画ルーチンで使用できるようにします。

関連項目:
InputMethodHighlight

INPUT_METHOD_UNDERLINE

public static final TextAttribute INPUT_METHOD_UNDERLINE
下線による修飾を表す属性キーです。

キー

INPUT_METHOD_UNDERLINE

整数

定数

UNDERLINE_LOW_ONE_PIXEL、UNDERLINE_LOW_TWO_PIXEL、UNDERLINE_LOW_DOTTED、UNDERLINE_LOW_GRAY、UNDERLINE_LOW_DASHED

デフォルト

下線なし

導入されたバージョン:
1.3

UNDERLINE_LOW_ONE_PIXEL

public static final Integer UNDERLINE_LOW_ONE_PIXEL
シングルピクセルの実線の下線です。

導入されたバージョン:
1.3
関連項目:
INPUT_METHOD_UNDERLINE

UNDERLINE_LOW_TWO_PIXEL

public static final Integer UNDERLINE_LOW_TWO_PIXEL
ダブルピクセルの実線の下線です。

導入されたバージョン:
1.3
関連項目:
INPUT_METHOD_UNDERLINE

UNDERLINE_LOW_DOTTED

public static final Integer UNDERLINE_LOW_DOTTED
シングルピクセルの点線の下線です。

導入されたバージョン:
1.3
関連項目:
INPUT_METHOD_UNDERLINE

UNDERLINE_LOW_GRAY

public static final Integer UNDERLINE_LOW_GRAY
ダブルピクセルのグレーの下線です。

導入されたバージョン:
1.3
関連項目:
INPUT_METHOD_UNDERLINE

UNDERLINE_LOW_DASHED

public static final Integer UNDERLINE_LOW_DASHED
シングルピクセルの破線の下線です。

導入されたバージョン:
1.3
関連項目:
INPUT_METHOD_UNDERLINE

SWAP_COLORS

public static final TextAttribute SWAP_COLORS
フォアグラウンドとバックグラウンドの塗りつぶし (色) の入れ替えを表す属性キーです。

値は Boolean のインスタンスです。デフォルトでは、フォアグラウンドとバックグラウンドを入れ替えません。フォアグラウンドおよびバックグラウンドの属性がどちらも定義されている場合、これにより、テキストの描画時に色が入れ替えられます。どちらか一方が不履行な場合、正確な効果は保証されません。通常は「反転した」外観になります。


SWAP_COLORS_ON

public static final Boolean SWAP_COLORS_ON
フォアグラウンドとバックグラウンドを入れ替えます。


NUMERIC_SHAPING

public static final TextAttribute NUMERIC_SHAPING
ASCII の 10 進数をほかの 10 進数の範囲に変換するための属性キーです。

値は NumericShaping のインスタンスです。デフォルトでは、数字の形状決定は行いません。

コンストラクタの詳細

TextAttribute

protected TextAttribute(String name)
指定された名前の TextAttribute を構築します。

パラメータ:
name - この TextAttribute に割り当てる属性名
メソッドの詳細

readResolve

protected Object readResolve()
                      throws InvalidObjectException
直列化復元されるインスタンスを定義済み定数に解決します。

オーバーライド:
クラス AttributedCharacterIterator.Attribute 内の readResolve
例外:
InvalidObjectException

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。