javax.swing

インタフェースScrollable

既知のすべての実装クラス:

DefaultTreeCellEditor.DefaultTextField, JEditorPane, JFormattedTextField, JLayer, JList, JPasswordField, JTable, JTextArea, JTextComponent, JTextField, JTextPane, JTree

public interface Scrollable

JScrollPaneなどのスクロール・コンテナに情報を提供するインタフェースです。JScrollPaneビュー・ポート(またはほかのスクロール・コンテナ)でビューとして使われる可能性のある複合コンポーネントは、このインタフェースを実装しなければいけません。

関連項目:

JViewport, JScrollPane, JScrollBar

メソッドのサマリー

修飾子と型	メソッドと説明
Dimension	getPreferredScrollableViewportSize() ビュー・コンポーネントのビュー・ポートの適切なサイズを返します。
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) 論理行または論理列を表示するコンポーネントは、orientationの値によって、1ブロック分の行または列を完全にエクスポーズするスクロール増分値を計算します。
boolean	getScrollableTracksViewportHeight() ビュー・ポートでこのScrollableの高さを常にビュー・ポートの高さに合わせる場合に、trueを返します。
boolean	getScrollableTracksViewportWidth() ビュー・ポートが常にこのScrollableの幅を強制的にビュー・ポートの幅に一致させようとする場合にtrueを返します。
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) 論理行または論理列を表示するコンポーネントは、orientationの値によって、新しい1行または1列を完全にエクスポーズするスクロール増分値を計算します。

メソッドの詳細

getPreferredScrollableViewportSize

Dimension getPreferredScrollableViewportSize()

ビュー・コンポーネントのビュー・ポートの適切なサイズを返します。たとえば、JListコンポーネントの優先サイズは、そのリストのセルをすべて収めるのに必要なサイズですが、preferredScrollableViewportSizeの値はJList.getVisibleRowCountの行を収めるのに必要なサイズです。ビューポートのサイズに影響を与えるプロパティがないコンポーネントは、ここでgetPreferredSizeのみを返します。

戻り値:

このScrollableをビューとして持つJViewportのpreferredSize

関連項目:

JComponent.getPreferredSize()

getScrollableUnitIncrement

int getScrollableUnitIncrement(Rectangle visibleRect,
                               int orientation,
                               int direction)

論理行または論理列を表示するコンポーネントは、orientationの値によって、新しい1行または1列を完全にエクスポーズするスクロール増分値を計算します。理論的には、コンポーネントは項目を完全にエクスポーズするために必要な距離を返すことで、部分的にエクスポーズされている行または列を処理します。

JScrollPaneなどのスクロール・コンテナは、ユーザーがユニット・スクロールを要求すると、このメソッドを使用します。

パラメータ:

visibleRect - ビュー・ポート内の可視のビュー領域

orientation - SwingConstants.VERTICALまたはSwingConstants.HORIZONTAL。

direction - 上または左にスクロールする場合は0より小さく、下または右にスクロールする場合は0より大きい。

戻り値:

指定された方向にスクロールするための「ユニット」増分値。常に正の値。

関連項目:

JScrollBar.setUnitIncrement(int)

getScrollableBlockIncrement

int getScrollableBlockIncrement(Rectangle visibleRect,
                                int orientation,
                                int direction)

論理行または論理列を表示するコンポーネントは、orientationの値によって、1ブロック分の行または列を完全にエクスポーズするスクロール増分値を計算します。

JScrollPaneなどのスクロール・コンテナは、ユーザーがブロック・スクロールを要求すると、このメソッドを使用します。

パラメータ:

visibleRect - ビュー・ポート内の可視のビュー領域

orientation - SwingConstants.VERTICALまたはSwingConstants.HORIZONTAL。

direction - 上または左にスクロールする場合は0より小さく、下または右にスクロールする場合は0より大きい。

戻り値:

指定された方向にスクロールするための「ブロック」増分値。常に正の値。

関連項目:

JScrollBar.setBlockIncrement(int)

getScrollableTracksViewportWidth

boolean getScrollableTracksViewportWidth()

ビュー・ポートが常にこのScrollableの幅を強制的にビュー・ポートの幅に一致させようとする場合にtrueを返します。たとえば、折返し行がビュー・ポートの右端を越えて消えてしまうようでは不都合なので、行折返しをサポートした通常のテキスト・ビューはここでtrueを返します。上位クラスにJScrollPaneを持つScrollableにtrueを返すと、水平スクロールが事実上無効になります。

JViewportなどのスクロール・コンテナは、検証されるとこのメソッドを使用します。

戻り値:

ビュー・ポートがScrollableの幅を強制的にビュー・ポート自体の幅に一致させる場合はtrue。

getScrollableTracksViewportHeight

boolean getScrollableTracksViewportHeight()

ビュー・ポートでこのScrollableの高さを常にビュー・ポートの高さに合わせる場合に、trueを返します。たとえば、左から右の列へテキストを表示する段組みのテキスト・ビューの場合、このメソッドでtrueを返すと、垂直方向のスクロールが結果的に無効になります。

JViewportなどのスクロール・コンテナは、検証されるとこのメソッドを使用します。

戻り値:

ビュー・ポートがScrollableの高さを強制的にビュー・ポート自体の高さに一致させる場合はtrue。