PlainView (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.swing.text
クラス PlainView

java.lang.Object
  javax.swing.text.View
      javax.swing.text.PlainView

すべての実装されたインタフェース:: SwingConstants, TabExpander

直系の既知のサブクラス:: FieldView

public class PlainView
extends View
implements TabExpander
extends View
implements TabExpander

フォントと色が 1 種類ずつのテキストを含む単純な複数行テキストビューのために、View インタフェースを実装します。ビューは、子要素をそれぞれ 1 行のテキストで表します。

関連項目:: View

フィールドの概要
`protected FontMetrics`	`metrics` 現在のフォントのフォントメトリックスです。

クラス javax.swing.text.View から継承されたフィールド
`BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS`

インタフェース javax.swing.SwingConstants から継承されたフィールド
`BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST`

コンストラクタの概要
`PlainView(Element elem)` 要素でラップされた新しい PlainView を構築します。

メソッドの概要
`void`	`changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)` このビューが扱う位置で属性が変更されたことをドキュメントから通知します。
`protected void`	`damageLineRange(int line0, int line1, Shape a, Component host)` 指定した行範囲を描画し直します。
`protected void`	`drawLine(int lineIndex, Graphics g, int x, int y)` 末尾の余白を削除し、タブを拡張しながら、1 行のテキストを描画します。
`protected int`	`drawSelectedText(Graphics g, int x, int y, int p0, int p1)` モデル内の指定された範囲を、選択されたテキストとして描画します。
`protected int`	`drawUnselectedText(Graphics g, int x, int y, int p0, int p1)` モデル内の指定された範囲を、選択解除した通常のテキストで描画します。
`protected Segment`	`getLineBuffer()` 関連するドキュメントからテキストを取得するために使用できるバッファへのアクセスを提供します。
`float`	`getPreferredSpan(int axis)` このビューに適切なスパンを軸に沿って指定します。
`protected int`	`getTabSize()` ドキュメントに設定されたタブのサイズを返します。
`void`	`insertUpdate(DocumentEvent changes, Shape a, ViewFactory f)` このビューが扱う位置でドキュメントに何かが挿入されたことを通知します。
`protected Rectangle`	`lineToRect(Shape a, int line)` 指定した行を表す矩形を判別します。
`Shape`	`modelToView(int pos, Shape a, Position.Bias b)` ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。
`float`	`nextTabStop(float x, int tabOffset)` 指定された参照位置より後の次のタブストップ位置を返します。
`void`	`paint(Graphics g, Shape a)` 指定された描画表面とその領域を使って描画します。
`void`	`removeUpdate(DocumentEvent changes, Shape a, ViewFactory f)` このビューが扱うドキュメント内の位置から何かが削除されたということを通知します。
`void`	`setSize(float width, float height)` ビューのサイズを設定します。
`protected void`	`updateDamage(DocumentEvent changes, Shape a, ViewFactory f)`
`protected void`	`updateMetrics()` フォントメトリックスと最長の線が最新であるかどうかを確認します。
`int`	`viewToModel(float fx, float fy, Shape a, Position.Bias[] bias)` ビューの座標空間からモデルの論理座標空間へのマッピングを提供します。

クラス javax.swing.text.View から継承されたメソッド
append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, updateChildren, updateLayout, viewToModel

クラス javax.swing.text.View から継承されたメソッド

append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, updateChildren, updateLayout, viewToModel

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

metrics

protected FontMetrics metrics

現在のフォントのフォントメトリックスです。

コンストラクタの詳細

PlainView

public PlainView(Element elem)

要素でラップされた新しい PlainView を構築します。

パラメータ:: elem - 要素

メソッドの詳細

getTabSize

protected int getTabSize()

ドキュメントに設定されたタブのサイズを返します。デフォルトは 8 です。

戻り値:: タブのサイズ

drawLine

protected void drawLine(int lineIndex,
                        Graphics g,
                        int x,
                        int y)

末尾の余白を削除し、タブを拡張しながら、1 行のテキストを描画します。このメソッドは、選択されたテキストまたは選択されていないテキストが描画される方法をカスタマイズできるように、drawUnselectedText および drawSelectedText メソッドを呼び出すために実装されます。

パラメータ:: lineIndex - 描画する行 >= 0; g - Graphics コンテキスト; x - 開始 X 位置 >= 0; y - 開始 Y 位置 >= 0
関連項目:: drawUnselectedText(java.awt.Graphics, int, int, int, int), drawSelectedText(java.awt.Graphics, int, int, int, int)

drawUnselectedText

protected int drawUnselectedText(Graphics g,
                                 int x,
                                 int y,
                                 int p0,
                                 int p1)
                          throws BadLocationException

モデル内の指定された範囲を、選択解除した通常のテキストで描画します。フォアグラウンドカラーまたは使用不可の色を使ってテキストを描画します。

パラメータ:: g - グラフィックスコンテキスト; x - 開始 X 座標 >= 0; y - 開始 Y 座標 >= 0; p0 - モデル内の開始位置 >= 0; p1 - モデル内の終了位置 >= 0
戻り値:: 範囲の終了の X 位置 >= 0
例外:: BadLocationException - 範囲が無効な場合

drawSelectedText

protected int drawSelectedText(Graphics g,
                               int x,
                               int y,
                               int p0,
                               int p1)
                        throws BadLocationException

モデル内の指定された範囲を、選択されたテキストとして描画します。このメソッドは、収容側コンポーネントで指定された色でテキストを描画するために実装されます。このメソッドは、ハイライタが選択されたバックグラウンドを描画することを前提にしています。

パラメータ:: g - グラフィックスコンテキスト; x - 開始 X 座標 >= 0; y - 開始 Y 座標 >= 0; p0 - モデル内の開始位置 >= 0; p1 - モデル内の終了位置 >= 0
戻り値:: 範囲の終了の位置
例外:: BadLocationException - 範囲が無効な場合

getLineBuffer

protected final Segment getLineBuffer()

関連するドキュメントからテキストを取得するために使用できるバッファへのアクセスを提供します。

戻り値:: バッファ

updateMetrics

protected void updateMetrics()

フォントメトリックスと最長の線が最新であるかどうかを確認します。

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

getPreferredSpan

public float getPreferredSpan(int axis)

このビューに適切なスパンを軸に沿って指定します。

定義:: クラス View 内の getPreferredSpan

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

paint

public void paint(Graphics g,
                  Shape a)

指定された描画表面とその領域を使って描画します。ビューは、指定された割り当てにそれ自体を描画するために、レイアウトを行なったり、子ビューを作成したりする必要がある場合があります。

定義:: クラス View 内の paint

パラメータ:: g - 使用する描画表面; a - 描画のために割り当てられた領域
関連項目:: View.paint(java.awt.Graphics, java.awt.Shape)

modelToView

public Shape modelToView(int pos,
                         Shape a,
                         Position.Bias b)
                  throws BadLocationException

ドキュメントモデルの座標空間からビューの座標空間へのマッピングを提供します。

定義:: クラス View 内の modelToView

パラメータ:

pos - 変換対象の位置 >= 0

a - 描画のために割り当てられた領域

b - 位置が 2 つのビューの境界である場合に、オフセットによって表される直前の文字または次の文字へのバイアス。b の値は次のどれかになる

Position.Bias.Forward
Position.Bias.Backward

戻り値:

指定された位置のバウンディングボックス

例外:

BadLocationException - 指定された位置が、関連するドキュメント内の有効な位置を表さない場合

viewToModel

public int viewToModel(float fx,
                       float fy,
                       Shape a,
                       Position.Bias[] bias)

ビューの座標空間からモデルの論理座標空間へのマッピングを提供します。

定義:: クラス View 内の viewToModel

パラメータ:: fx - X 座標 >= 0; fy - Y 座標 >= 0; a - 描画のために割り当てられた領域
戻り値:: ビュー内の指定された点をもっともよく表すモデル内の位置 >= 0
関連項目:: View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

insertUpdate

public void insertUpdate(DocumentEvent changes,
                         Shape a,
                         ViewFactory f)

このビューが扱う位置でドキュメントに何かが挿入されたことを通知します。

オーバーライド:: クラス View 内の insertUpdate

パラメータ:: changes - 関連するドキュメントからの変更情報; a - ビューの現在の割り当て; f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:: View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

removeUpdate

public void removeUpdate(DocumentEvent changes,
                         Shape a,
                         ViewFactory f)

このビューが扱うドキュメント内の位置から何かが削除されたということを通知します。

オーバーライド:: クラス View 内の removeUpdate

パラメータ:: changes - 関連するドキュメントからの変更情報; a - ビューの現在の割り当て; f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:: View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

changedUpdate

public void changedUpdate(DocumentEvent changes,
                          Shape a,
                          ViewFactory f)

このビューが扱う位置で属性が変更されたことをドキュメントから通知します。

オーバーライド:: クラス View 内の changedUpdate

パラメータ:: changes - 関連するドキュメントからの変更情報; a - ビューの現在の割り当て; f - ビューが子を持つ場合に再構築に使用するファクトリ
関連項目:: View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

setSize

public void setSize(float width,
                    float height)

ビューのサイズを設定します。レイアウトの必要がある場合は、指定した軸に沿ったビューのレイアウトを表示します。

オーバーライド:: クラス View 内の setSize

パラメータ:: width - 幅 >= 0; height - 高さ >= 0

nextTabStop

public float nextTabStop(float x,
                         int tabOffset)

指定された参照位置より後の次のタブストップ位置を返します。この実装は中央揃えなどの機能をサポートしていないので、tabOffset 引数を無視します。

定義:: インタフェース TabExpander 内の nextTabStop

パラメータ:: x - 現在位置 >= 0; tabOffset - タブが発生するテキストストリーム内の位置 >= 0
戻り値:: ポイント単位で測定されたタブストップ >= 0

updateDamage

protected void updateDamage(DocumentEvent changes,
                            Shape a,
                            ViewFactory f)

damageLineRange

protected void damageLineRange(int line0,
                               int line1,
                               Shape a,
                               Component host)

指定した行範囲を描画し直します。

パラメータ:: host - ビューを収容するコンポーネント (再描画の呼び出しに使用); a - 描画のためにビューに割り当てられた領域; line0 - 再描画の開始行番号。モデル内の有効な行番号でなければならない; line1 - 再描画の終了行番号。モデル内の有効な行番号でなければならない
導入されたバージョン:: 1.4

lineToRect

protected Rectangle lineToRect(Shape a,
                               int line)

指定した行を表す矩形を判別します。

パラメータ:: a - 描画のためにビューに割り当てられた領域; line - 範囲の検索に使用する行番号。モデル内の有効な行番号でなければならない
導入されたバージョン:: 1.4

概要