javax.swing
インタフェース Scrollable

既知の実装クラスの一覧:

JTextComponent, JTree, JTable, JList

public abstract 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

public Dimension getPreferredScrollableViewportSize()

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

戻り値:

ビューがこの Scrollable である JViewport の望ましいサイズ

関連項目:

JComponent.getPreferredSize()

getScrollableUnitIncrement

public 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

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

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

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

パラメータ:

visibleRect - ビューポート内で可視である表示領域

orientation - SwingConstants.VERTICAL または SwingConstants.HORIZONTAL

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

戻り値:

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

関連項目:

JScrollBar.setBlockIncrement(int)

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

ビューポートでこの Scrollable の幅を常にビューポートの幅に合わせる場合に、true を返します。たとえば、行末での折返しをサポートしている通常のテキストビューの場合、このメソッドで true を返します。折り返された行がビューポートの右端から表示されなくなると不都合だからです。祖先が JScrollPane である Scrollable に対して true を返すと、水平方向のスクロールが結果的に無効になることに注意してください。

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

戻り値:

ビューポートで Scrollable の幅をビューポートの幅に合わせる場合は true

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

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

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

戻り値:

ビューポートで Scrollable の高さをビューポートの高さに合わせる場合は true