javax.swing

クラス JScrollPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

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

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class JScrollPane
extends JComponent
implements ScrollPaneConstants, Accessible

軽量コンポーネントのスクロール可能なビューを提供します。JScrollPane は、ビューポート、オプションの垂直スクロールバーと水平スクロールバー、およびオプションの行ヘッダービューポートと列ヘッダービューポートを管理します。詳細は、『The Java Tutorial』の「How to Use Scroll Panes」にある JScrollPane のタスク指向のドキュメントを参照してください。JScrollPane は、重量コンポーネントをサポートしていません。

JViewport は、たとえば、テキストファイルなど、データソースへのウィンドウまたは「ビューポート」を提供します。データソースは JViewport のビューによって表示される「スクロール可能なクライアント」(データモデル) です。JScrollPane は、右の図に示すように、基本的に JScrollBar、JViewport、およびそれらの接続から構成されます。

スクロールバーとビューポートのほかに、JScrollPane には列ヘッダーと行ヘッダーがある場合もあります。これらはそれぞれ setRowHeaderView と setColumnHeaderView を使用して指定する JViewport オブジェクトです。列ヘッダービューポートは自動的に左右にスクロールして、メインビューポートの左右へのスクロールを追跡します。垂直にはスクロールしません。行ヘッダーも同じように動作します。

2 つのスクロールバーが接するところ、行ヘッダーが列ヘッダーに接するところ、またはスクロールバーが一方のヘッダーに接するところで、両方のコンポーネントは隅に達する前に停止します。このため、矩形のスペース (デフォルトでは空のスペース) が残ります。これらのスペースは、四隅のどのコーナーにも存在することができます。前述の図では、四隅の右上にスペースが存在し、「コーナーコンポーネント」というラベルが付けられています。

setCorner メソッドを使ってコーナーにコンポーネントを追加することにより、これらの空のスペースをいくつでも置き換えることができます。(注:同じコンポーネントを複数のコーナーに追加することはできません。)この機能は、スクロールペインに装飾や機能を追加する場合に役立ちます。各コーナーコンポーネントのサイズは、ヘッダーおよびその周りのスクロールバーのサイズ、またはそのどちらかのサイズによって決まります。

コーナーコンポーネントは、それが存在するための空のスペースがある場合にかぎり可視になります。たとえば、列ヘッダーを持つスクロールペインの右上隅にコンポーネントがある場合について考えてみましょう。ビューコンポーネントがそれほど大きくないなどの理由で、スクロールペインに垂直スクロールバーが存在しない場合、コーナーコンポーネントは表示されません。これは、ヘッダーと垂直スクロールバーが接するところに空のスペースができないからです。setVerticalScrollBarPolicy(VERTICAL_SCROLLBAR_ALWAYS) を使って、スクロールバーを強制的に表示する設定にすると、コーナーコンポーネント用のスペースを常に確保することができます。

メインビューポートの周りにボーダーを追加するには、setViewportBorder を使用できます。もちろん、setBorder を使用してスクロールペイン全体にボーダーを追加することもできます。

メインのビューポートのビューがそのビューポートよりも小さいか、または不透明な場合、行う必要のある共通の操作は、使用されるバックグラウンドカラーを設定することです。この操作を実行するには、scrollPane.getViewport().setBackground() を使用して、ビューポートのバックグラウンドカラーを設定します。ビューポートの色を設定し、スクロールペインの色を設定しないのは、デフォルトで JViewport が不透明であるためです。特に、不透明だと、そのバックグラウンドをバックグラウンドカラーを使用して完全に塗りつぶすことになります。したがって、JScrollPane がそのバックグラウンドを描画するとき、ビューポートは通常、同じバックグラウンドの上から描画することになります。

デフォルトで、JScrollPane は ScrollPaneLayout を使用してその子 Components のレイアウトを処理します。 ScrollPaneLayout は、次のいずれかの方法でビューポートのビューを作成するサイズを決定します。

1. ビューが Scrollable を実装する場合は、getPreferredScrollableViewportSize、getScrollableTracksViewportWidth、および getScrollableTracksViewportHeight の組み合わせが使用される
2. そうでない場合は、getPreferredSize が使用される。

警告: Swing はスレッドに対して安全ではありません。詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeans^TM 用の長期間の格納サポートが java.beans パッケージに追加されています。XMLEncoder を参照してください。

関連項目:

JScrollBar, JViewport, ScrollPaneLayout, Scrollable, Component.getPreferredSize(), setViewportView(java.awt.Component), setRowHeaderView(java.awt.Component), setColumnHeaderView(java.awt.Component), setCorner(java.lang.String, java.awt.Component), setViewportBorder(javax.swing.border.Border)

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
protected class	JScrollPane.AccessibleJScrollPane このクラスは JScrollPane クラスのアクセシビリティーサポートを実装しています。
protected class	JScrollPane.ScrollBar デフォルトでは、JScrollPane は、このクラスのインスタンスであるスクロールバーを作成します。

クラス javax.swing.JComponent から継承されたネストされたクラス/インタフェース

JComponent.AccessibleJComponent

クラス java.awt.Container から継承されたネストされたクラス/インタフェース

Container.AccessibleAWTContainer

クラス java.awt.Component から継承されたネストされたクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected JViewport	columnHeader 列ヘッダーの子です。
protected JScrollBar	horizontalScrollBar スクロールペインの水平スクロールバーの子です。
protected int	horizontalScrollBarPolicy 水平スクロールバーの表示ポリシーです。
protected Component	lowerLeft 左下隅に表示するコンポーネントです。
protected Component	lowerRight 右下隅に表示するコンポーネントです。
protected JViewport	rowHeader 行ヘッダーの子です。
protected Component	upperLeft 左上隅に表示するコンポーネントです。
protected Component	upperRight 右上隅に表示するコンポーネントです。
protected JScrollBar	verticalScrollBar スクロールペインの垂直スクロールバーの子です。
protected int	verticalScrollBarPolicy 垂直スクロールバーの表示ポリシーです。
protected JViewport	viewport スクロールペインのビューポートの子です。

クラス javax.swing.JComponent から継承されたフィールド

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

クラス java.awt.Component から継承されたフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース javax.swing.ScrollPaneConstants から継承されたフィールド

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

インタフェース java.awt.image.ImageObserver から継承されたフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
JScrollPane() 必要に応じて水平および垂直の両方のスクロールバーが表示される空の (ビューポートのビューがない) JScrollPane を作成します。
JScrollPane(Component view) 指定されたコンポーネントのコンテンツを表示する JScrollPane を作成します。コンポーネントのコンテンツがビューより大きい場合は、常に水平および垂直スクロールバーの両方が表示されます。
JScrollPane(Component view, int vsbPolicy, int hsbPolicy) ビューの位置を 1 組のスクロールバーを使用して制御できるビューポート内にビューコンポーネントを表示する JScrollPane を作成します。
JScrollPane(int vsbPolicy, int hsbPolicy) スクロールバーのポリシーを指定して空の (ビューポートのビューがない) JScrollPane を作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
JScrollBar	createHorizontalScrollBar() デフォルトで JScrollPane.ScrollBar を返します。
JScrollBar	createVerticalScrollBar() デフォルトで JScrollPane.ScrollBar を返します。
protected JViewport	createViewport() デフォルトで新しい JViewport を返します。
AccessibleContext	getAccessibleContext() この JScrollPane に関連付けられた AccessibleContext を取得します。
JViewport	getColumnHeader() 列ヘッダーを返します。
Component	getCorner(String key) 指定されたコーナーにあるコンポーネントを返します。
JScrollBar	getHorizontalScrollBar() ビューポートの水平のビュー位置を制御する水平スクロールバーを返します。
int	getHorizontalScrollBarPolicy() 水平スクロールバーのポリシーの値を返します。
JViewport	getRowHeader() 行ヘッダーを返します。
ScrollPaneUI	getUI() このコンポーネントをレンダリングする Look & Feel (L&F) オブジェクトを返します。
String	getUIClassID() Look & Feel クラスの名前の構築に使用された接尾辞を返します。このクラスは、このコンポーネントをレンダリングするのに使用されます。
JScrollBar	getVerticalScrollBar() ビューポートの垂直のビュー位置を制御する垂直スクロールバーを返します。
int	getVerticalScrollBarPolicy() 垂直スクロールバーのポリシーの値を返します。
JViewport	getViewport() 現在の JViewport を返します。
Border	getViewportBorder() ビューポートを囲む Border オブジェクトを返します。
Rectangle	getViewportBorderBounds() ビューポートのボーダーの境界を返します。
boolean	isValidateRoot() この JScrollPane の下位オブジェクトで revalidate を呼び出せるようにこのメソッドをオーバーライドして true を返すと、この JScrollPane で始まるツリー全体が検証されます。
boolean	isWheelScrollingEnabled() マウスホイールに応答してスクロールが行われるかどうかを示します。
protected String	paramString() この JScrollPane の文字列表現を返します。
void	setColumnHeader(JViewport columnHeader) 以前の列ヘッダーがある場合はそれを削除します。新しい列ヘッダーが null でない場合は、ビュー位置の x 座標とビューポート (存在する場合) を同期させてからスクロールペインに追加します。
void	setColumnHeaderView(Component view) 必要に応じて列ヘッダーのビューポートを作成し、ビューを設定してから、列ヘッダーのビューポートをスクロールペインに追加します。
void	setComponentOrientation(ComponentOrientation co) 垂直および水平スクロールバーの方向を、ComponentOrientation 引数で指定された方向に設定します。
void	setCorner(String key, Component corner) スクロールペインのコーナーのいずれかに表示される子を追加します (スペースがある場合)。
void	setHorizontalScrollBar(JScrollBar horizontalScrollBar) スクロールペインにビューポートの水平のビュー位置を制御するスクロールバーを追加します。
void	setHorizontalScrollBarPolicy(int policy) 水平スクロールバーがスクロールペインにいつ表示されるかを設定します。
void	setLayout(LayoutManager layout) この JScrollPane のレイアウトマネージャーを設定します。
void	setRowHeader(JViewport rowHeader) 以前の行ヘッダーがある場合はそれを削除します。新しい行ヘッダーが null でない場合は、ビュー位置の y 座標とビューポート (存在する場合) を同期させてからスクロールペインに追加します。
void	setRowHeaderView(Component view) 必要に応じて行ヘッダーのビューポートを作成し、ビューを設定してから、行ヘッダーのビューポートをスクロールペインに追加します。
void	setUI(ScrollPaneUI ui) このコンポーネントの Look & Feel (L&F) を提供する ScrollPaneUI オブジェクトを設定します。
void	setVerticalScrollBar(JScrollBar verticalScrollBar) スクロールペインにビューポートの垂直のビュー位置を制御するスクロールバーを追加します。
void	setVerticalScrollBarPolicy(int policy) 垂直スクロールバーがスクロールペインにいつ表示されるかを設定します。
void	setViewport(JViewport viewport) 以前のビューポートがある場合はそれを削除し、新しいビューポートのビュー位置を +x、+y 四分区間内に設定し、行および列ヘッダー (存在する場合) と新しいビューポートを同期させ、結果としてスクロールバーとヘッダーと新しいビューポートを同期させます。
void	setViewportBorder(Border viewportBorder) ビューポートのボーダーを追加します。
void	setViewportView(Component view) 必要に応じてビューポートを作成してから、ビューを設定します。
void	setWheelScrollingEnabled(boolean handleWheel) マウスホイールの移動に応答してスクロールを有効または無効にします。
void	updateUI() 現在の ScrollPaneUI オブジェクトを現在のデフォルトの Look & Feel のバージョンで置き換えます。

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

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラス java.awt.Container から継承されたメソッド

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

クラス java.awt.Component から継承されたメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

verticalScrollBarPolicy

protected int verticalScrollBarPolicy

垂直スクロールバーの表示ポリシーです。デフォルトは ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED です。

関連項目:

setVerticalScrollBarPolicy(int)

horizontalScrollBarPolicy

protected int horizontalScrollBarPolicy

水平スクロールバーの表示ポリシーです。デフォルトは ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED です。

関連項目:

setHorizontalScrollBarPolicy(int)

viewport

protected JViewport viewport

スクロールペインのビューポートの子です。デフォルトは空の JViewport です。

関連項目:

setViewport(javax.swing.JViewport)

verticalScrollBar

protected JScrollBar verticalScrollBar

スクロールペインの垂直スクロールバーの子です。デフォルトは JScrollBar です。

関連項目:

setVerticalScrollBar(javax.swing.JScrollBar)

horizontalScrollBar

protected JScrollBar horizontalScrollBar

スクロールペインの水平スクロールバーの子です。デフォルトは JScrollBar です。

関連項目:

setHorizontalScrollBar(javax.swing.JScrollBar)

rowHeader

protected JViewport rowHeader

行ヘッダーの子です。デフォルトは null です。

関連項目:

setRowHeader(javax.swing.JViewport)

columnHeader

protected JViewport columnHeader

列ヘッダーの子です。デフォルトは null です。

関連項目:

setColumnHeader(javax.swing.JViewport)

lowerLeft

protected Component lowerLeft

左下隅に表示するコンポーネントです。デフォルトは null です。

関連項目:

setCorner(java.lang.String, java.awt.Component)

lowerRight

protected Component lowerRight

右下隅に表示するコンポーネントです。デフォルトは null です。

関連項目:

setCorner(java.lang.String, java.awt.Component)

upperLeft

protected Component upperLeft

左上隅に表示するコンポーネントです。デフォルトは null です。

関連項目:

setCorner(java.lang.String, java.awt.Component)

upperRight

protected Component upperRight

右上隅に表示するコンポーネントです。デフォルトは null です。

関連項目:

setCorner(java.lang.String, java.awt.Component)

コンストラクタの詳細

JScrollPane

public JScrollPane(Component view,
           int vsbPolicy,
           int hsbPolicy)

ビューの位置を 1 組のスクロールバーを使用して制御できるビューポート内にビューコンポーネントを表示する JScrollPane を作成します。スクロールバーのポリシーは、スクロールバーがいつ表示されるかを指定します。たとえば、vsbPolicy が VERTICAL_SCROLLBAR_AS_NEEDED であれば、垂直スクロールバーはビューが垂直方向に収まらない場合にだけ表示されます。利用可能なポリシーの設定は setVerticalScrollBarPolicy(int) および setHorizontalScrollBarPolicy(int) にリストされています。

パラメータ:

view - スクロールペインのビューポートに表示するコンポーネント

vsbPolicy - 垂直スクロールバーのポリシーを指定する整数

hsbPolicy - 水平スクロールバーのポリシーを指定する整数

関連項目:

setViewportView(java.awt.Component)

JScrollPane

public JScrollPane(Component view)

指定されたコンポーネントのコンテンツを表示する JScrollPane を作成します。コンポーネントのコンテンツがビューより大きい場合は、常に水平および垂直スクロールバーの両方が表示されます。

パラメータ:

view - スクロールペインのビューポートに表示するコンポーネント

関連項目:

setViewportView(java.awt.Component)

JScrollPane

public JScrollPane(int vsbPolicy,
           int hsbPolicy)

スクロールバーのポリシーを指定して空の (ビューポートのビューがない) JScrollPane を作成します。利用可能なポリシーの設定は setVerticalScrollBarPolicy(int) および setHorizontalScrollBarPolicy(int) にリストされています。

パラメータ:

vsbPolicy - 垂直スクロールバーのポリシーを指定する整数

hsbPolicy - 水平スクロールバーのポリシーを指定する整数

関連項目:

setViewportView(java.awt.Component)

JScrollPane

public JScrollPane()

必要に応じて水平および垂直の両方のスクロールバーが表示される空の (ビューポートのビューがない) JScrollPane を作成します。

メソッドの詳細

getUI

public ScrollPaneUI getUI()

このコンポーネントをレンダリングする Look & Feel (L&F) オブジェクトを返します。

戻り値:

このコンポーネントをレンダリングする ScrollPaneUI オブジェクト

関連項目:

setUI(javax.swing.plaf.ScrollPaneUI)

setUI

public void setUI(ScrollPaneUI ui)

このコンポーネントの Look & Feel (L&F) を提供する ScrollPaneUI オブジェクトを設定します。

パラメータ:

ui - ScrollPaneUI L&F オブジェクト

関連項目:

getUI()

updateUI

public void updateUI()

現在の ScrollPaneUI オブジェクトを現在のデフォルトの Look & Feel のバージョンで置き換えます。デフォルトの Look & Feel が変更されたときに呼び出されます。

オーバーライド:

updateUI 、クラス: JComponent

関連項目:

JComponent.updateUI(), UIManager.getUI(javax.swing.JComponent)

getUIClassID

public String getUIClassID()

Look & Feel クラスの名前の構築に使用された接尾辞を返します。このクラスは、このコンポーネントをレンダリングするのに使用されます。

オーバーライド:

getUIClassID 、クラス: JComponent

戻り値:

文字列「ScrollPaneUI」

関連項目:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setLayout

public void setLayout(LayoutManager layout)

この JScrollPane のレイアウトマネージャーを設定します。このメソッドは、java.awt.Container の setLayout をオーバーライドして、ScrollPaneLayout のサブクラスである LayoutManager だけが JScrollPane で使用できることが保証されるようにします。layout が null でない場合は、このメソッドはその上に syncWithScrollPane を呼び出します。

オーバーライド:

setLayout 、クラス: Container

パラメータ:

layout - 指定されたレイアウトマネージャー

例外:

ClassCastException - レイアウトが ScrollPaneLayout ではない場合

関連項目:

Container.getLayout(), Container.setLayout(java.awt.LayoutManager)

isValidateRoot

public boolean isValidateRoot()

この JScrollPane の下位オブジェクトで revalidate を呼び出せるようにこのメソッドをオーバーライドして true を返すと、この JScrollPane で始まるツリー全体が検証されます。

オーバーライド:

isValidateRoot 、クラス: JComponent

戻り値:

true

関連項目:

Container.validate(), JComponent.revalidate(), JComponent.isValidateRoot(), Container.isValidateRoot()

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

垂直スクロールバーのポリシーの値を返します。

戻り値:

verticalScrollBarPolicy プロパティー

関連項目:

setVerticalScrollBarPolicy(int)

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int policy)

垂直スクロールバーがスクロールペインにいつ表示されるかを設定します。次に有効な値を示します。

• ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
• ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER
• ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS

パラメータ:

policy - 上記の 3 つの値のいずれか

例外:

IllegalArgumentException - policy が上記の正当な値のどれでもない場合

関連項目:

getVerticalScrollBarPolicy()

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

水平スクロールバーのポリシーの値を返します。

戻り値:

horizontalScrollBarPolicy プロパティー

関連項目:

setHorizontalScrollBarPolicy(int)

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int policy)

水平スクロールバーがスクロールペインにいつ表示されるかを設定します。オプションは次のとおりです。

• ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
• ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
• ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS

パラメータ:

policy - 上記の 3 つの値のいずれか

例外:

IllegalArgumentException - policy が上記の正当な値のどれでもない場合

関連項目:

getHorizontalScrollBarPolicy()

getViewportBorder

public Border getViewportBorder()

ビューポートを囲む Border オブジェクトを返します。

戻り値:

viewportBorder プロパティー

関連項目:

setViewportBorder(javax.swing.border.Border)

setViewportBorder

public void setViewportBorder(Border viewportBorder)

ビューポートのボーダーを追加します。ボーダーはビューポートで直接設定されず、JViewport は JComponent のボーダープロパティーをサポートしません。同様に、JScrollPane のビューポートを設定しても、viewportBorder プロパティーには影響しません。

このプロパティーのデフォルト値は Look & Feel の実装によって算出されます。

パラメータ:

viewportBorder - 追加されるボーダー

関連項目:

getViewportBorder(), setViewport(javax.swing.JViewport)

getViewportBorderBounds

public Rectangle getViewportBorderBounds()

ビューポートのボーダーの境界を返します。

戻り値:

ビューポートのボーダーを指定する Rectangle オブジェクト

createHorizontalScrollBar

public JScrollBar createHorizontalScrollBar()

デフォルトで JScrollPane.ScrollBar を返します。サブクラスはこのメソッドをオーバーライドして ScrollPaneUI の実装に対して JScrollBar サブクラスを強制的に使用することもできます。水平スクロールバーを作成するために ScrollPaneUI の実装によって使用されます。

戻り値:

水平方向の JScrollBar

関連項目:

JScrollBar

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()

ビューポートの水平のビュー位置を制御する水平スクロールバーを返します。

戻り値:

horizontalScrollBar プロパティー

関連項目:

setHorizontalScrollBar(javax.swing.JScrollBar)

setHorizontalScrollBar

public void setHorizontalScrollBar(JScrollBar horizontalScrollBar)

スクロールペインにビューポートの水平のビュー位置を制御するスクロールバーを追加します。JScrollPane はデフォルトで水平および垂直スクロールバーを作成するので、このメソッドは通常不要です。

パラメータ:

horizontalScrollBar - 追加される水平スクロールバー

関連項目:

createHorizontalScrollBar(), getHorizontalScrollBar()

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()

デフォルトで JScrollPane.ScrollBar を返します。サブクラスはこのメソッドをオーバーライドして ScrollPaneUI の実装に対して JScrollBar サブクラスを強制的に使用することもできます。垂直スクロールバーを作成するために ScrollPaneUI の実装によって使用されます。

戻り値:

垂直方向の JScrollBar

関連項目:

JScrollBar

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()

ビューポートの垂直のビュー位置を制御する垂直スクロールバーを返します。

戻り値:

verticalScrollBar プロパティー

関連項目:

setVerticalScrollBar(javax.swing.JScrollBar)

setVerticalScrollBar

public void setVerticalScrollBar(JScrollBar verticalScrollBar)

スクロールペインにビューポートの垂直のビュー位置を制御するスクロールバーを追加します。JScrollPane はデフォルトで水平および垂直スクロールバーを作成するので、このメソッドは通常不要です。

パラメータ:

verticalScrollBar - 追加される新規の垂直スクロールバー

関連項目:

createVerticalScrollBar(), getVerticalScrollBar()

createViewport

protected JViewport createViewport()

デフォルトで新しい JViewport を返します。setViewportView、setRowHeaderView、および setColumnHeaderView に必要に応じてビューポートを作成するのに使います。サブクラスは、JViewport のサブクラスを返すようにこのメソッドをオーバーライドすることもできます。

戻り値:

新しい JViewport。

getViewport

public JViewport getViewport()

現在の JViewport を返します。

戻り値:

viewport プロパティー

関連項目:

setViewport(javax.swing.JViewport)

setViewport

public void setViewport(JViewport viewport)

以前のビューポートがある場合はそれを削除し、新しいビューポートのビュー位置を +x、+y 四分区間内に設定し、行および列ヘッダー (存在する場合) と新しいビューポートを同期させ、結果としてスクロールバーとヘッダーと新しいビューポートを同期させます。

ほとんどのアプリケーションの場合、ビューポートとスクロールペインへのビューの追加には setViewportView を使ったほうが便利です。

パラメータ:

viewport - 使用される新しいビューポート。ビューポートが null の場合、以前のビューポートは削除され、新しいビューポートが null に設定される

関連項目:

createViewport(), getViewport(), setViewportView(java.awt.Component)

setViewportView

public void setViewportView(Component view)

必要に応じてビューポートを作成してから、ビューを設定します。直接 JScrollPane のコンストラクタにビューを提供しないアプリケーションは、このメソッドを使用して、次のようにして、スクロールペインに表示されるスクロール可能な子を指定する必要があります。たとえば、

 JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);
 

アプリケーションは直接スクロールペインに子を追加すべきできありません。

パラメータ:

view - ビューポートに追加するコンポーネント

関連項目:

setViewport(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getRowHeader

public JViewport getRowHeader()

行ヘッダーを返します。

戻り値:

rowHeader プロパティー

関連項目:

setRowHeader(javax.swing.JViewport)

setRowHeader

public void setRowHeader(JViewport rowHeader)

以前の行ヘッダーがある場合はそれを削除します。新しい行ヘッダーが null でない場合は、ビュー位置の y 座標とビューポート (存在する場合) を同期させてからスクロールペインに追加します。

ほとんどのアプリケーションの場合、スクロールペインへの行ヘッダーコンポーネントとビューポートの追加には setRowHeaderView を使ったほうが便利です。

パラメータ:

rowHeader - 使用される新しい行ヘッダー。null の場合、以前の行ヘッダーは削除され、新しい行ヘッダーが null に設定される

関連項目:

getRowHeader(), setRowHeaderView(java.awt.Component)

setRowHeaderView

public void setRowHeaderView(Component view)

必要に応じて行ヘッダーのビューポートを作成し、ビューを設定してから、行ヘッダーのビューポートをスクロールペインに追加します。たとえば、

 JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);
 scrollpane.setRowHeaderView(myBigComponentsRowHeader);
 

パラメータ:

view - 行ヘッダーとして表示するコンポーネント

関連項目:

setRowHeader(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getColumnHeader

public JViewport getColumnHeader()

列ヘッダーを返します。

戻り値:

columnHeader プロパティー

関連項目:

setColumnHeader(javax.swing.JViewport)

setColumnHeader

public void setColumnHeader(JViewport columnHeader)

以前の列ヘッダーがある場合はそれを削除します。新しい列ヘッダーが null でない場合は、ビュー位置の x 座標とビューポート (存在する場合) を同期させてからスクロールペインに追加します。

ほとんどのアプリケーションの場合、スクロールペインへの列ヘッダーコンポーネントとビューポートの追加には setColumnHeaderView を使ったほうが便利です。

関連項目:

getColumnHeader(), setColumnHeaderView(java.awt.Component)

setColumnHeaderView

public void setColumnHeaderView(Component view)

必要に応じて列ヘッダーのビューポートを作成し、ビューを設定してから、列ヘッダーのビューポートをスクロールペインに追加します。たとえば、

 JScrollPane scrollpane = new JScrollPane();
 scrollpane.setViewportView(myBigComponentToScroll);
 scrollpane.setColumnHeaderView(myBigComponentsColumnHeader);
 

パラメータ:

view - 列ヘッダーとして表示するコンポーネント

関連項目:

setColumnHeader(javax.swing.JViewport), JViewport.setView(java.awt.Component)

getCorner

public Component getCorner(String key)

指定されたコーナーにあるコンポーネントを返します。コーナーを指定する key 値を次に示します。

• ScrollPaneConstants.LOWER_LEFT_CORNER
• ScrollPaneConstants.LOWER_RIGHT_CORNER
• ScrollPaneConstants.UPPER_LEFT_CORNER
• ScrollPaneConstants.UPPER_RIGHT_CORNER
• ScrollPaneConstants.LOWER_LEADING_CORNER
• ScrollPaneConstants.LOWER_TRAILING_CORNER
• ScrollPaneConstants.UPPER_LEADING_CORNER
• ScrollPaneConstants.UPPER_TRAILING_CORNER

パラメータ:

key - 上記の値のいずれか

戻り値:

指定されたキーで識別されるコーナーコンポーネント (null の場合もある)。キーが無効な場合は null

関連項目:

setCorner(java.lang.String, java.awt.Component)

setCorner

public void setCorner(String key,
             Component corner)

スクロールペインのコーナーのいずれかに表示される子を追加します (スペースがある場合)。たとえば、両方のスクロールバーが表示されていれば (スクロールペインの右端および下端に)、左下隅のコンポーネントが 2 つのスクロールバーの両端の間のスペースに表示されます。キーの有効な値は次のとおりです。

• ScrollPaneConstants.LOWER_LEFT_CORNER
• ScrollPaneConstants.LOWER_RIGHT_CORNER
• ScrollPaneConstants.UPPER_LEFT_CORNER
• ScrollPaneConstants.UPPER_RIGHT_CORNER
• ScrollPaneConstants.LOWER_LEADING_CORNER
• ScrollPaneConstants.LOWER_TRAILING_CORNER
• ScrollPaneConstants.UPPER_LEADING_CORNER
• ScrollPaneConstants.UPPER_TRAILING_CORNER

「コーナー」はどの beans プロパティーシグニチャーとも一致しませんが、プロパティー名をコーナーキーに設定すると PropertyChange イベントが生成されます。

パラメータ:

key - コンポーネントを表示するコーナーを識別する

corner - 次のコンポーネントのいずれか

• lowerLeft
• lowerRight
• upperLeft
• upperRight

例外:

IllegalArgumentException - コーナーキーが無効な場合

setComponentOrientation

public void setComponentOrientation(ComponentOrientation co)

垂直および水平スクロールバーの方向を、ComponentOrientation 引数で指定された方向に設定します。

オーバーライド:

setComponentOrientation 、クラス: Component

パラメータ:

co - 次の値のいずれか。

• java.awt.ComponentOrientation.LEFT_TO_RIGHT
• java.awt.ComponentOrientation.RIGHT_TO_LEFT
• java.awt.ComponentOrientation.UNKNOWN

関連項目:

ComponentOrientation

isWheelScrollingEnabled

public boolean isWheelScrollingEnabled()

マウスホイールに応答してスクロールが行われるかどうかを示します。ホイールスクロールはデフォルトで有効です。

導入されたバージョン:

1.4

関連項目:

setWheelScrollingEnabled(boolean)

setWheelScrollingEnabled

public void setWheelScrollingEnabled(boolean handleWheel)

マウスホイールの移動に応答してスクロールを有効または無効にします。ホイールスクロールはデフォルトで有効です。

パラメータ:

handleWheel - MouseWheelEvent に対してスクロールが自動的に行われる場合は true、そうでない場合は false。

導入されたバージョン:

1.4

関連項目:

isWheelScrollingEnabled(), MouseWheelEvent, MouseWheelListener

paramString

protected String paramString()

この JScrollPane の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

paramString 、クラス: JComponent

戻り値:

この JScrollPane を表す文字列表現。

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JScrollPane に関連付けられた AccessibleContext を取得します。スクロールペインの場合、AccessibleContext は AccessibleJScrollPane の形式を取ります。必要に応じて新規の AccessibleJScrollPane インスタンスが作成されます。

定義:

getAccessibleContext 、インタフェース: Accessible

オーバーライド:

getAccessibleContext 、クラス: JComponent

戻り値:

この JScrollPane の AccessibleContext として機能する AccessibleJScrollPane