Java プラットフォーム 1.2

javax.swing.text
クラス BoxView

java.lang.Object
  |
  +--javax.swing.text.View
        |
        +--javax.swing.text.CompositeView
              |
              +--javax.swing.text.BoxView
直接の既知のサブクラス:
BlockView, ParagraphView, TableView, TableView.TableCell, TableView.TableRow, WrappedPlainView
public class BoxView
extends CompositeView

テキストモデルのビューです。テキストモデルの子を、ひとつのボックスに配置します。行、段落、リスト項目、テキストのチャンクなどのコレクションを表示するのに便利です。このボックスは、子の配列をするところでは子の柔軟性も考慮されるという点で、TeX に用意されているボックスと似ています。

クラス javax.swing.text.View から継承したフィールド
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
 
コンストラクタの概要
BoxView(Element elem, int axis)
          BoxView を構築します。
 
メソッドの概要
protected  void baselineLayout(int targetSpan, int axis, int[] offsets, int[] spans)
           
protected  SizeRequirements baselineRequirements(int axis, SizeRequirements r)
           
protected  SizeRequirements calculateMajorAxisRequirements(int axis, SizeRequirements r)
           
protected  SizeRequirements calculateMinorAxisRequirements(int axis, SizeRequirements r)
           
 void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
          ビューが扱う位置で属性が変更されたという、ドキュメントからの通知を伝えます。
protected  void childAllocation(int index, Rectangle alloc)
          子ビューに領域を割り当てます。
protected  boolean flipEastAndWestAtEnds(int position, Position.Bias bias)
           
 float getAlignment(int axis)
          ビューの望ましい配置を、軸に沿って決定します。
 int getHeight()
          ボックスの現在の高さです。
 float getMaximumSpan(int axis)
          ビューのスパンの最大値を軸に沿って決定します。
 float getMinimumSpan(int axis)
          ビューのスパンの最小値を軸に沿って決定します。
protected  int getOffset(int axis, int childIndex)
          特定の子について、現在のレイアウトのオフセットを取得します。
 float getPreferredSpan(int axis)
          ビューの望ましいスパンを軸に沿って決定します。
 int getResizeWeight(int axis)
          サイズ変更のウェイトを取得します。
protected  int getSpan(int axis, int childIndex)
          特定の子について、現在のレイアウトのスパンを取得します。
protected  View getViewAtPoint(int x, int y, Rectangle alloc)
          指定された点の子ビューを取得します。
 int getWidth()
          ボックスの現在の幅です。
 void insertUpdate(DocumentEvent e, Shape a, ViewFactory f)
          ドキュメント内の、ビューが扱う位置に何かが挿入されたことを通知します。
protected  boolean isAfter(int x, int y, Rectangle innerAlloc)
          ある点が、割り当てられた領域の後にあるかどうかを判定します。
protected  boolean isAllocationValid()
          子への割り当てが現在も有効かどうかを判定します。
protected  boolean isBefore(int x, int y, Rectangle innerAlloc)
          ある点が、割り当てられた領域の前にあるかどうかを判定します。
protected  void layout(int width, int height)
          子のレイアウトを実行します。
protected  void layoutMajorAxis(int targetSpan, int axis, int[] offsets, int[] spans)
          ボックスの主軸、すなわちボックスが表示する軸のレイアウトを実行します。
protected  void layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans)
          ボックスの副軸 (つまり、それが表す軸に直角の軸) のレイアウトを実行します。
 Shape modelToView(int pos, Shape a, Position.Bias b)
          ドキュメントモデルの座標空間から、それにマップされるビューの座標空間へのマッピングを提供します。
 void paint(Graphics g, Shape allocation)
          指定された描画表面、および描画表面上の領域を使用して描画します。
protected  void paintChild(Graphics g, Rectangle alloc, int index)
          子を描画します。
 void preferenceChanged(View child, boolean width, boolean height)
          子に呼び出され、その望ましいスパンが変更されたことを示します。
 void removeUpdate(DocumentEvent e, Shape a, ViewFactory f)
          ドキュメント内の、ビューが扱う位置から何かが削除されたことを通知します。
 void replace(int offset, int length, View[] elems)
          レイアウトを無効にして、要求/割り当てのキャッシュのサイズを変更します。
 void setSize(float width, float height)
          ビューのサイズを設定します。
 int viewToModel(float x, float y, Shape a, Position.Bias[] bias)
          ビューの座標空間から、モデルの論理座標空間へのマッピングを提供します。
 
クラス javax.swing.text.CompositeView から継承したメソッド
append, getBottomInset, getChildAllocation, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndexAtPosition, insert, loadChildren, modelToView, removeAll, setInsets, setParagraphInsets, setParent
 
クラス javax.swing.text.View から継承したメソッド
breakView, createFragment, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getParent, getStartOffset, getViewFactory, isVisible, modelToView, viewToModel
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

BoxView

public BoxView(Element elem,
               int axis)
BoxView を構築します。
パラメータ:
elem - このビューが扱う要素
axis - View.X_AXIS または View.Y_AXIS
メソッドの詳細

paintChild

protected void paintChild(Graphics g,
                          Rectangle alloc,
                          int index)
子を描画します。デフォルトの機能はそれだけですが、サブクラスはこれを使って、子に関連するものを描画できます。
パラメータ:
g - グラフィックコンテキスト
alloc - 描画の対象として割り当てられる領域
index - 子のインデックス >= 0 && < getViewCount()

replace

public void replace(int offset,
                    int length,
                    View[] elems)
レイアウトを無効にして、要求/割り当てのキャッシュのサイズを変更します。
パラメータ:
offset - 子のビューの開始オフセット >= 0
length - 置き換える既存のビューの数 >= 0
elems - 挿入する子ビュー
オーバーライド:
クラス CompositeView 内の replace

preferenceChanged

public void preferenceChanged(View child,
                              boolean width,
                              boolean height)
子に呼び出され、その望ましいスパンが変更されたことを示します。次回に子の割り当てが必要なときに新しく計算が実行されるように、キャッシュされたレイアウト情報を捨てるために実装されています。
パラメータ:
child - 子のビュー
width - 幅の設定が変更された場合に true
height - 高さの設定が変更された場合に true
オーバーライド:
クラス View 内の preferenceChanged

getResizeWeight

public int getResizeWeight(int axis)
サイズ変更のウェイトを取得します。値が 0 または負の数の場合、サイズ変更はできません。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ウェイト
例外:
IllegalArgumentException - 軸が無効な場合
オーバーライド:
クラス View 内の getResizeWeight

setSize

public void setSize(float width,
                    float height)
ビューのサイズを設定します。サイズが変更された場合、レイアウトが再実行されます。サイズは、インセット領域も含むビュー全体のサイズです。
パラメータ:
width - 幅 >= 0
height - 高さ >= 0
オーバーライド:
クラス View 内の setSize

paint

public void paint(Graphics g,
                  Shape allocation)
指定された描画表面、および描画表面上の領域を使用して描画します。
パラメータ:
g - 使用する描画表面
allocation - 描画に割り当てられた領域
オーバーライド:
クラス View 内の paint
関連項目:
View.paint(java.awt.Graphics, java.awt.Shape)

modelToView

public Shape modelToView(int pos,
                         Shape a,
                         Position.Bias b)
                  throws BadLocationException
ドキュメントモデルの座標空間から、それにマップされるビューの座標空間へのマッピングを提供します。スーパークラスに機能を実行させる前に、割り当てが有効であることを確認できます。
パラメータ:
pos - 変換する位置 >= 0
a - 描画に割り当てられた領域
戻り値:
指定された位置のバウンディングボックス
例外:
BadLocationException - 指定された位置が、関連付けられたドキュメントの有効な位置を表さない場合
オーバーライド:
クラス CompositeView 内の modelToView
関連項目:
View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

viewToModel

public int viewToModel(float x,
                       float y,
                       Shape a,
                       Position.Bias[] bias)
ビューの座標空間から、モデルの論理座標空間へのマッピングを提供します。
パラメータ:
x - 変換するビュー位置の x 座標 >= 0
y - 変換するビュー位置の y 座標 >= 0
a - 描画に割り当てられた領域
戻り値:
ビューの指定された点を最適に表すモデル内の位置 >= 0
オーバーライド:
クラス CompositeView 内の viewToModel
関連項目:
View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

getAlignment

public float getAlignment(int axis)
ビューの望ましい配置を、軸に沿って決定します。この実装が提供するのは、タイルされた軸と直交する軸に並べられた整列位置に沿って子を配置するために必要な、全体的な整列です。タイルされた軸は、中央揃え、すなわち 0.5f にする必要があります。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
望ましい配置 >= 0.0f && <= 1.0f。値の範囲は 0.0 〜 1.0 で、0 は起点への配置、1.0 は起点から最大スパン離れた配置を表す。0.5 は、ビューの中央への配置になる
例外:
IllegalArgumentException - 軸が無効な場合
オーバーライド:
クラス View 内の getAlignment

getPreferredSpan

public float getPreferredSpan(int axis)
ビューの望ましいスパンを軸に沿って決定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューの描画対象のスパン >= 0。通常、ビューは返されたスパン内に描画されることになるが、保証はない。親はビューのサイズ変更や分割を行う可能性がある
例外:
IllegalArgumentException - 軸が無効な場合
オーバーライド:
クラス View 内の getPreferredSpan

getMinimumSpan

public float getMinimumSpan(int axis)
ビューのスパンの最小値を軸に沿って決定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューの描画対象のスパン >= 0。通常、ビューは返されたスパン内に描画されることになるが、保証はない。親はビューのサイズ変更や分割を行う可能性がある
例外:
IllegalArgumentException - 軸が無効な場合
オーバーライド:
クラス View 内の getMinimumSpan

getMaximumSpan

public float getMaximumSpan(int axis)
ビューのスパンの最大値を軸に沿って決定します。
パラメータ:
axis - View.X_AXIS または View.Y_AXIS
戻り値:
ビューの描画対象のスパン >= 0。通常、ビューは返されたスパン内に描画されることになるが、保証はない。親はビューのサイズ変更や分割を行う可能性がある
例外:
IllegalArgumentException - 軸が無効な場合
オーバーライド:
クラス View 内の getMaximumSpan

insertUpdate

public void insertUpdate(DocumentEvent e,
                         Shape a,
                         ViewFactory f)
ドキュメント内の、ビューが扱う位置に何かが挿入されたことを通知します。
パラメータ:
e - 関連付けられたドキュメントからの更新情報
a - ビューの現在の割り当て
f - ビューに子がある場合に構築をやり直すためのファクトリ
オーバーライド:
クラス View 内の insertUpdate
関連項目:
View.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 - ビューに子がある場合に構築をやり直すためのファクトリ
オーバーライド:
クラス View 内の removeUpdate
関連項目:
View.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 - ビューに子がある場合に構築をやり直すためのファクトリ
オーバーライド:
クラス View 内の changedUpdate
関連項目:
View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

isAllocationValid

protected boolean isAllocationValid()
子への割り当てが現在も有効かどうかを判定します。
戻り値:
割り当てが現在も有効な場合は true

isBefore

protected boolean isBefore(int x,
                           int y,
                           Rectangle innerAlloc)
ある点が、割り当てられた領域の前にあるかどうかを判定します。
パラメータ:
x - X 座標 >= 0
y - Y 座標 >= 0
innerAlloc - 割り当てられた領域。インセットの内側の領域
戻り値:
点が領域の前にある場合は true、そうでない場合は false
オーバーライド:
クラス CompositeView 内の isBefore

isAfter

protected boolean isAfter(int x,
                          int y,
                          Rectangle innerAlloc)
ある点が、割り当てられた領域の後にあるかどうかを判定します。
パラメータ:
x - X 座標 >= 0
y - Y 座標 >= 0
innerAlloc - 割り当てられた領域。インセットの内側の領域
戻り値:
点が領域の後にある場合は true、そうでない場合は false
オーバーライド:
クラス CompositeView 内の isAfter

getViewAtPoint

protected View getViewAtPoint(int x,
                              int y,
                              Rectangle alloc)
指定された点の子ビューを取得します。
パラメータ:
x - X 座標 >= 0
y - Y 座標 >= 0
alloc - 入口では親の内部割り当て。出口で子の割り当てに変更
戻り値:
ビュー
オーバーライド:
クラス CompositeView 内の getViewAtPoint

childAllocation

protected void childAllocation(int index,
                               Rectangle alloc)
子ビューに領域を割り当てます。
パラメータ:
index - 割り当てる子ビューのインデックス >= 0 && < getViewCount()
alloc - 割り当てられる領域
オーバーライド:
クラス CompositeView 内の childAllocation

layout

protected void layout(int width,
                      int height)
子のレイアウトを実行します。サイズは、インセット内部の領域です。このメソッドは、必要に応じて layoutMajorAxis および layoutMinorAxis を呼び出します。レイアウトの方法を変更するには、これらのメソッドを実装してください。
パラメータ:
width - 幅 >= 0
height - 高さ >= 0

getWidth

public final int getWidth()
ボックスの現在の幅です。ボックスに割り当てられた最新の幅です。

getHeight

public final int getHeight()
ボックスの現在の高さです。ボックスに割り当てられた最新の高さです。

layoutMajorAxis

protected void layoutMajorAxis(int targetSpan,
                               int axis,
                               int[] offsets,
                               int[] spans)
ボックスの主軸、すなわちボックスが表示する軸のレイアウトを実行します。レイアウトの結果は、主軸に沿った子への割り当てを示す配列に置くようにしてください。
パラメータ:
targetSpan - ビューに指定された総スパン。子のレイアウトに使用
axis - レイアウトされる軸
offsets - ビューの起点から、個々の子ビューまでのオフセット。戻り値であり、このメソッドの実装によって埋め込まれる
spans - 個々の子ビューのスパン。戻り値であり、このメソッドの実装によって埋め込まれる
戻り値:
offsets および span パラメータに指定された個々の子ビューのオフセットおよびスパン

layoutMinorAxis

protected void layoutMinorAxis(int targetSpan,
                               int axis,
                               int[] offsets,
                               int[] spans)
ボックスの副軸 (つまり、それが表す軸に直角の軸) のレイアウトを実行します。レイアウトの結果は、副軸に沿った子への割り当てを表す配列に配置されなければなりません。
パラメータ:
targetSpan - ビューに指定された総スパン。子のレイアウトに使用
axis - レイアウトされる軸
offsets - ビューの起点から、個々の子ビューまでのオフセット。戻り値であり、このメソッドの実装によって埋め込まれる
spans - 個々の子ビューのスパン。戻り値であり、このメソッドの実装によって埋め込まれる
戻り値:
offsets および span パラメータに指定された個々の子ビューのオフセットおよびスパン

calculateMajorAxisRequirements

protected SizeRequirements calculateMajorAxisRequirements(int axis,
                                                          SizeRequirements r)

calculateMinorAxisRequirements

protected SizeRequirements calculateMinorAxisRequirements(int axis,
                                                          SizeRequirements r)

baselineLayout

protected void baselineLayout(int targetSpan,
                              int axis,
                              int[] offsets,
                              int[] spans)

baselineRequirements

protected SizeRequirements baselineRequirements(int axis,
                                                SizeRequirements r)

getOffset

protected final int getOffset(int axis,
                              int childIndex)
特定の子について、現在のレイアウトのオフセットを取得します。

getSpan

protected final int getSpan(int axis,
                            int childIndex)
特定の子について、現在のレイアウトのスパンを取得します。

flipEastAndWestAtEnds

protected boolean flipEastAndWestAtEnds(int position,
                                        Position.Bias bias)
オーバーライド:
クラス CompositeView 内の flipEastAndWestAtEnds
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.