Java プラットフォーム 1.2

javax.swing.text
クラス View

java.lang.Object
  |
  +--javax.swing.text.View
直接の既知のサブクラス:
ComponentView, CompositeView, IconView, LabelView, PlainView

public abstract class View
extends Object
implements SwingConstants

ドキュメントモデルの一部のビューです。ビュー座標からモデル座標へのマッピング、およびモデル座標からビュー座標へのマッピングを提供します。また、ビューは描画およびレイアウトのサービスも提供します。


フィールドの概要
static int BadBreakWeight
          ビューがフォーマットを目的として分割するには悪い機会であることを示すウェイトです。
static int ExcellentBreakWeight
          ビューが分割をサポートし、分割するのに適した位置であることを示すウェイトです。
static int ForcedBreakWeight
          ビューが分割をサポートし、子分割することで子をフォーマットするビューに配置されている場合に、ビューを正しく表わすには分割しなければならないことを示すウェイトです。
static int GoodBreakWeight
          ビューが分割をサポートしているが、もっと良い機会が存在する可能性があることを示すウェイトです。
static int X_AXIS
          フォーマット/分割処理の軸です。
static int Y_AXIS
          フォーマット/分割処理の軸です。
 
コンストラクタの概要
View(Element elem)
          新しい View オブジェクトを作成します。
 
メソッドの概要
 View breakView(int axis, int offset, float pos, float len)
          指定された軸でこのビューの分割を試みます。
 void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
          このビューが担当する位置で属性が変更されたことをドキュメントから通知します。
 View createFragment(int p0, int p1)
          要素の一部を表すビューを作成します。
 float getAlignment(int axis)
          このビューに適切な配置を軸に沿って決定します。
 AttributeSet getAttributes()
          描画するときに使用する属性を取得します。
 int getBreakWeight(int axis, float pos, float len)
          このビューで分割のウェイトがどのくらい適切かを示します。
 Shape getChildAllocation(int index, Shape a)
          指定された子ビューの割り当てを取得します。
 Container getContainer()
          ビューを収容するコンテナを取得します。
 Document getDocument()
          ビューと関連付けられているモデルを取得します。
 Element getElement()
          このビューがマッピングされる対象の構造部分を取得します。
 int getEndOffset()
          このビューが担当するモデルの一部を取得します。
 float getMaximumSpan(int axis)
          このビューの最大スパンを軸に沿って指定します。
 float getMinimumSpan(int axis)
          このビューの最小スパンを軸に沿って指定します。
 int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)
          キャレットが配置される可能性のある、視覚的に表された次のモデル位置を決定する手段を提供します。
 View getParent()
          ビューの親を返します。
abstract  float getPreferredSpan(int axis)
          このビューに適切なスパンを軸に沿って指定します。
 int getResizeWeight(int axis)
          指定された軸に沿ってビューをサイズ変更できるかどうかを指定します。
 int getStartOffset()
          このビューが担当するモデルの一部を取得します。
 View getView(int n)
          n 番目の子ビューを取得します。
 int getViewCount()
          このビュー内のビューの数を返します。
 ViewFactory getViewFactory()
          ビュー階層を供給している ViewFactory の実装を取得します。
 void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)
          このビューが担当する位置でドキュメントに何かが挿入されたことを通知します。
 boolean isVisible()
          ビューが可視かどうかを示す boolean 型の値を返します。
 Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a)
          ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。
 Shape modelToView(int pos, Shape a)
          推奨されません。  
abstract  Shape modelToView(int pos, Shape a, Position.Bias b)
          ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。
abstract  void paint(Graphics g, Shape allocation)
          指定された描画表面とその領域を使って描画します。
 void preferenceChanged(View child, boolean width, boolean height)
          子ビューは親でこのメソッドを呼び出し、設定が変更されたこと、および再度レイアウトが考慮されなければならないことを示すことができます。
 void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)
          このビューが担当する位置で属性が削除されたことをドキュメントから通知します。
 void setParent(View parent)
          このビューの親ビューを確立します。
 void setSize(float width, float height)
          ビューのサイズを設定します。
 int viewToModel(float x, float y, Shape a)
          推奨されません。  
abstract  int viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)
          ビューの座標空間からモデルの論理座標空間へのマッピングを提供します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

BadBreakWeight

public static final int BadBreakWeight
ビューがフォーマットを目的として分割するには悪い機会であることを示すウェイトです。この値は、ビューが断片化をサポートするように記述されていないため、ビューをフラグメントに分割してはならないことを示します。
関連項目:
getBreakWeight(int, float, float), GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight

GoodBreakWeight

public static final int GoodBreakWeight
ビューが分割をサポートしているが、もっと良い機会が存在する可能性があることを示すウェイトです。
関連項目:
getBreakWeight(int, float, float), BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight

ExcellentBreakWeight

public static final int ExcellentBreakWeight
ビューが分割をサポートし、分割するのに適した位置であることを示すウェイトです。
関連項目:
getBreakWeight(int, float, float), BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight

ForcedBreakWeight

public static final int ForcedBreakWeight
ビューが分割をサポートし、子分割することで子をフォーマットするビューに配置されている場合に、ビューを正しく表わすには分割しなければならないことを示すウェイトです。
関連項目:
getBreakWeight(int, float, float), BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight

X_AXIS

public static final int X_AXIS
フォーマット/分割処理の軸です。

Y_AXIS

public static final int Y_AXIS
フォーマット/分割処理の軸です。
コンストラクタの詳細

View

public View(Element elem)
新しい View オブジェクトを作成します。
パラメータ:
elem - 表す要素
メソッドの詳細

getParent

public View getParent()
ビューの親を返します。
戻り値:
親。ない場合は null

isVisible

public boolean isVisible()
ビューが可視かどうかを示す boolean 型の値を返します。デフォルトではすべてのビューが可視です。
戻り値:
boolean 型の値

getPreferredSpan

public abstract float getPreferredSpan(int axis)
このビューに適切なスパンを軸に沿って指定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューの描画対象のスパン。通常、ビューは返されたスパン内に描画されることになるが、保証はない。親はビューのサイズ変更や分割を行う可能性がある
関連項目:
getPreferredSpan(int)

getMinimumSpan

public float getMinimumSpan(int axis)
このビューの最小スパンを軸に沿って指定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューを描画できる最小スパン
関連項目:
getPreferredSpan(int)

getMaximumSpan

public float getMaximumSpan(int axis)
このビューの最大スパンを軸に沿って指定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューを描画できる最大スパン
関連項目:
getPreferredSpan(int)

preferenceChanged

public void preferenceChanged(View child,
                              boolean width,
                              boolean height)
子ビューは親でこのメソッドを呼び出し、設定が変更されたこと、および再度レイアウトが考慮されなければならないことを示すことができます。デフォルトでは、このメソッドは単純に次の親に向かって通知します。ルートビューは、関連付けられているテキストコンポーネントで revalidate を呼び出します。
パラメータ:
child - 子ビュー
width - 幅の設定が変更されている場合は true
height - 高さの設定が変更されている場合は true
関連項目:
JComponent.revalidate()

getAlignment

public float getAlignment(int axis)
このビューに適切な配置を軸に沿って決定します。デフォルトでは、単純に中央で揃えられます。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
望ましい配置。値の範囲は 0.0 〜 1.0 で 、0 は起点への配置、1.0 は起点から最大スパン離れた配置を表す。0.5 は、ビューの中央への配置になる

paint

public abstract void paint(Graphics g,
                           Shape allocation)
指定された描画表面とその領域を使って描画します。ビューは、指定された割り当てにそれ自体を描画するために、レイアウトを行なったり、子ビューを作成したりする必要がある場合があります。
パラメータ:
g - 使用する描画表面
allocation - 描画に割り当てられた領域
関連項目:
paint(java.awt.Graphics, java.awt.Shape)

setParent

public void setParent(View parent)
このビューの親ビューを確立します。親ビューが正しく機能している場合、このメソッドはほかのメソッドよりも必ず前に呼び出されます。また、このメソッドは階層からビューが削除されたことを示すためにも呼び出されるので、最後に呼び出されるメソッドでもあります。このメソッドを再実装する場合は、super.setParent() を呼び出さなければなりません。
パラメータ:
parent - 新しい親。ビューが以前に追加された親から削除される場合は null

getViewCount

public int getViewCount()
このビュー内のビューの数を返します。デフォルトでは複合ビューにならないので、このメソッドは 0 を返します。
戻り値:
ビューの数 >= 0
関連項目:
getViewCount()

getView

public View getView(int n)
n 番目の子ビューを取得します。デフォルトでは子がないので、このメソッドは null を返します。
パラメータ:
n - 取得するビューの番号 >= 0 && < getViewCount()
戻り値:
ビュー

getChildAllocation

public Shape getChildAllocation(int index,
                                Shape a)
指定された子ビューの割り当てを取得します。このメソッドを使用すると、ビューがそれらの位置を格納していることを仮定することなく、さまざまなビューがどこにあるかを知ることができます。デフォルトでは子ビューを持たないので、このメソッドは null を返します。
パラメータ:
index - 子のインデックス >= 0 && < getViewCount()
a - このビューに対する割り当て
戻り値:
子に対する割り当て

getNextVisualPositionFrom

public int getNextVisualPositionFrom(int pos,
                                     Position.Bias b,
                                     Shape a,
                                     int direction,
                                     Position.Bias[] biasRet)
                              throws BadLocationException
キャレットが配置される可能性のある、視覚的に表された次のモデル位置を決定する手段を提供します。ビューによっては、可視ではないか、モデル内と同じ順序でないか、またはモデル内の位置へのアクセスを許可しない場合があります。
パラメータ:
pos - 変換する位置 >= 0
a - 描画するために割り当てられた領域
direction - キーボード上に通常ある矢印キーと見なすことができる、現在の位置からの方向。SwingConstants.WEST、SwingConstants.EAST、SwingConstants.NORTH、または SwingConstants.SOUTH
戻り値:
次の可視の位置をもっともよく表すモデル内の位置
例外:
BadLocationException -  
IllegalArgumentException - 方向が無効な場合

modelToView

public abstract Shape modelToView(int pos,
                                  Shape a,
                                  Position.Bias b)
                           throws BadLocationException
ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。
パラメータ:
pos - 変換する位置 >= 0
a - 描画するために割り当てられた領域
b - 位置が 2 つのビューの境界である場合のための、オフセットによって表される前の文字または次の文字へのバイアス
戻り値:
指定された位置のバウンディングボックス
例外:
BadLocationException - 指定された位置が、関連付けられているドキュメント内の有効な位置を表さない場合
IllegalArgumentException - bias 引数が無効な場合
関連項目:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

modelToView

public Shape modelToView(int p0,
                         Position.Bias b0,
                         int p1,
                         Position.Bias b1,
                         Shape a)
                  throws BadLocationException
ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。
パラメータ:
p0 - 変換する位置 >= 0
b0 - 位置が 2 つのビューの境界である場合に、p0 によって表される直前の文字または次の文字へのバイアス
p0 - 変換する位置 >= 0
b0 - 位置が 2 つのビューの境界である場合に、p1 によって表される直前の文字または次の文字へのバイアス
a - 描画対象として割り当てられた領域
戻り値:
指定された位置のバウンディングボックス
例外:
BadLocationException - 指定された位置が、関連付けられているドキュメント内の有効な位置を表さない場合
IllegalArgumentException - bias 引数が無効な場合
関連項目:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

viewToModel

public abstract int viewToModel(float x,
                                float y,
                                Shape a,
                                Position.Bias[] biasReturn)
ビューの座標空間からモデルの論理座標空間へのマッピングを提供します。biasReturn 引数は、指定された点がモデル内の次の文字と近いのか、あるいはモデル内の前の文字と近いのかを示します。
パラメータ:
x - X 座標 >= 0
y - Y 座標 >= 0
a - 描画するために割り当てられた領域
戻り値:
ビュー内の指定された点をもっともよく表すモデル内の位置 >= 0。biasReturn 引数は、指定された点がモデル内の次の文字と近いのか、あるいはモデル内の前の文字と近いのかを示す

insertUpdate

public void insertUpdate(DocumentEvent e,
                         Shape a,
                         ViewFactory f)
このビューが担当する位置でドキュメントに何かが挿入されたことを通知します。
パラメータ:
e - 関連付けられているドキュメントからの変更情報
a - ビューの現在の割り当て
f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:
insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

removeUpdate

public void removeUpdate(DocumentEvent e,
                         Shape a,
                         ViewFactory f)
このビューが担当する位置で属性が削除されたことをドキュメントから通知します。
パラメータ:
e - 関連付けられているドキュメントからの変更情報
a - ビューの現在の割り当て
f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:
removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

changedUpdate

public void changedUpdate(DocumentEvent e,
                          Shape a,
                          ViewFactory f)
このビューが担当する位置で属性が変更されたことをドキュメントから通知します。
パラメータ:
e - 関連付けられているドキュメントからの変更情報
a - ビューの現在の割り当て
f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:
changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

getDocument

public Document getDocument()
ビューと関連付けられているモデルを取得します。
戻り値:
ビューモデル。ない場合は null
関連項目:
getDocument()

getStartOffset

public int getStartOffset()
このビューが担当するモデルの一部を取得します。
戻り値:
モデル内の開始オフセット >= 0
関連項目:
getStartOffset()

getEndOffset

public int getEndOffset()
このビューが担当するモデルの一部を取得します。
戻り値:
モデルへの終了オフセット >= 0
関連項目:
getEndOffset()

getElement

public Element getElement()
このビューがマッピングされる対象の構造部分を取得します。ビューは、要素の全体を担当しない場合があります。
戻り値:
対象
関連項目:
getElement()

getAttributes

public AttributeSet getAttributes()
描画するときに使用する属性を取得します。デフォルトでは、このメソッドは単純に関連付けられている要素の属性を返します。ビュー固有の属性を追加できるようにするため、またはビューがサブクラスによるビュー固有の属性の変換を持てるようにするために属性へのアクセスを取得するには、要素を直接使用するのではなく、このメソッドを使用しなければなりません。各ビューは、描画またはレイアウトの目的のためにどの属性を認識するのかを記述しなければならず、またこのメソッドによって返される AttributeSet を介してそれらに常にアクセスしなければなりません。

breakView

public View breakView(int axis,
                      int offset,
                      float pos,
                      float len)
指定された軸でこのビューの分割を試みます。このメソッドは、子のフォーマットを目的とするビューによって呼び出されます。たとえば、段落のビューは通常その子を行に配置しようとし、テキストのチャンクを表すビューは小さく分割されることがあります。

このメソッドはビュー自体を返すために実装され、それは分割できないデフォルトの動作を表します。ビューが分割をサポートする場合、返されるビューの開始オフセットは指定されたオフセットでなければならず、終了オフセットは分割されるビューの終了オフセット以下でなければなりません。

パラメータ:
axis - View.X_AXIS または View.Y_AXIS
offset - 分割されたフラグメントが占めるドキュメントモデル内の位置 >= 0。これは返されるフラグメントの開始オフセットになる
pos - 分割されたビューが占める軸に沿った位置 >= 0。これはタブの計算などで便利な場合がある
len - 分割が望まれる軸に沿った距離 >= 0
戻り値:
ビューが分割できる場合は、指定されたスパンを表すビューのフラグメント。ビューが分割動作をサポートしていない場合は、ビュー自体
関連項目:
ParagraphView

createFragment

public View createFragment(int p0,
                           int p1)
要素の一部を表すビューを作成します。このメソッドは、フォーマット処理でビューのフラグメントを測定するために便利な場合があります。ビューが断片化をサポートしない場合は (デフォルト)、ビュー自体が返されます。
パラメータ:
p0 - 開始オフセット >= 0。この値は要素の開始オフセット以上で、要素の終了オフセットより小さくなければならない
p1 - 終了オフセット > p0。この値は要素の終了オフセット以下で、要素の開始オフセットより大きくなければならない
戻り値:
ビューのフラグメント。ビューがフラグメントへの分割をサポートしない場合はビュー自体
関連項目:
LabelView

getBreakWeight

public int getBreakWeight(int axis,
                          float pos,
                          float len)
このビューで分割のウェイトがどのくらい適切かを示します。このメソッドは、フォーマットの過程で breakView を呼び出すもっとも適切なビューを判断するために使用できます。たとえば、余白を含むテキストを表すビューは、余白を含まないビューよりも適切です。ウェイトが高いほど、分割がより適切になります。BadBreakWeight 以下の値は、分割を考慮してはなりません。ForcedBreakWeight 以上の値は、分割しなければなりません。

このメソッドは、長さがビューの長さより長い場合 (ビュー全体がフラグメントを表す) を除いて BadBreakWeight を返すデフォルトの動作を提供します。ビューが分割動作をサポートするように記述されていない限り、ビューを分割しようとするのは適切ではありません。分割をサポートするビューには LabelView などがあります。分割ウェイトを使用するビューには ParagraphView などがあります。

パラメータ:
axis - View.X_AXIS または View.Y_AXIS
pos - 分割されたビューの開始の可能性のある位置 >= 0。これはタブ位置の計算に便利な場合がある
len - 分割が望まれる pos からの相対的な長さ >= 0
戻り値:
ウェイト。ForcedBreakWeight と BadBreakWeight の間の値でなければならない
関連項目:
LabelView, ParagraphView, BadBreakWeight, GoodBreakWeight, ExcellentBreakWeight, ForcedBreakWeight

getResizeWeight

public int getResizeWeight(int axis)
指定された軸に沿ってビューをサイズ変更できるかどうかを指定します。値が 0 以下の場合はサイズ変更できません。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ウェイト

setSize

public void setSize(float width,
                    float height)
ビューのサイズを設定します。レイアウト義務がある場合はビューのレイアウトを生じさせます。デフォルトでは何も行いません。
パラメータ:
width - 幅 >= 0
height - 高さ >= 0

getContainer

public Container getContainer()
ビューを収容するコンテナを取得します。これは、再描画のスケジューリング、収容側コンポーネントフォントの検索などに便利です。デフォルトの実装では、照会を親ビューに転送します。
戻り値:
コンテナ。ない場合は null

getViewFactory

public ViewFactory getViewFactory()
ビュー階層を供給している ViewFactory の実装を取得します。ビューには通常、もっともファクトリを必要とするときにモデルから更新するための引数として渡されますが、このメソッドはそれ以外のときに実装を提供するために機能します。
戻り値:
ファクトリ。ない場合は null

modelToView

public Shape modelToView(int pos,
                         Shape a)
                  throws BadLocationException
推奨されません。  
ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。これは、バイアスのデフォルトを以前に暗示された Position.Bias.Forward にするために実装されます。
パラメータ:
pos - 変換対象の位置 >= 0
a - 描画のために割り当てられた領域
戻り値:
指定された位置のバウンディングボックス
例外:
BadLocationException - 指定された位置が、関連付けられているドキュメント内の有効な位置を表さない場合
関連項目:
modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

viewToModel

public int viewToModel(float x,
                       float y,
                       Shape a)
推奨されません。  
ビューの座標空間からモデルの論理座標空間へのマッピングを提供します。
パラメータ:
x - X 座標 >= 0
y - Y 座標 >= 0
a - 描画のために割り当てられた領域
戻り値:
ビュー内の指定された点をもっともよく表すモデル内の位置 >= 0
関連項目:
viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

Java プラットフォーム 1.2

バグや機能要求の報告
新しい javadoc の表示についてのコメントやご提案
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.