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。