モジュール java.desktop

パッケージ javax.swing

クラスJScrollPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

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

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

@JavaBean(defaultProperty="UI", description="A specialized container that manages a viewport, optional scrollbars and headers") 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の長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:

1.2

関連項目:

• 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で宣言されたフィールド

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

クラスjava.awt.Componentで宣言されたフィールド

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェースjava.awt.image.ImageObserverで宣言されているフィールド

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

インタフェース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

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

コンストラクタ

コンストラクタ	説明
JScrollPane()	必要に応じて水平および垂直の両方のスクロール・バーが表示される空の(ビュー・ポートのビューがない) JScrollPaneを作成します。
JScrollPane(int vsbPolicy, int hsbPolicy)	スクロール・バーのポリシーを指定して空の(ビュー・ポートのビューがない) JScrollPaneを作成します。
JScrollPane(Component view)	指定されたコンポーネントのコンテンツを表示するJScrollPaneを作成します。コンポーネントのコンテンツがビューより大きい場合は、常に水平および垂直スクロール・バーの両方が表示されます。
JScrollPane(Component view, int vsbPolicy, int hsbPolicy)	ビューの位置を1組のスクロール・バーを使用して制御できるビュー・ポート内にビュー・コンポーネントを表示する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()	このコンポーネントを描画するルック・アンド・フィール (L&F)オブジェクトを返します。
String	getUIClassID()	L&Fクラスの名前の構築に使用された接尾辞を返します。このクラスは、このコンポーネントをレンダリングするのに使用されます。
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)	このコンポーネントのルック・アンド・フィール (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オブジェクトを現在のデフォルトのルック・アンド・フィールのバージョンで置き換えます。

クラスjavax.swing.JComponentで宣言されたメソッド

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public ScrollPaneUI getUI()

このコンポーネントを描画するルック・アンド・フィール (L&F)オブジェクトを返します。

オーバーライド:

クラスJComponentのgetUI

戻り値:

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

関連項目:

• setUI(javax.swing.plaf.ScrollPaneUI)

setUI

public void setUI(ScrollPaneUI ui)

このコンポーネントのルック・アンド・フィール (L&F)を提供するScrollPaneUIオブジェクトを設定します。

パラメータ:

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

関連項目:

• getUI()

updateUI

public void updateUI()

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

オーバーライド:

updateUI、クラスJComponent

関連項目:

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

getUIClassID

@BeanProperty(bound=false, hidden=true) public String getUIClassID()

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

オーバーライド:

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

@BeanProperty(hidden=true) 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

@BeanProperty(preferred=true, enumerationValues={"ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED","ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER","ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS"}, description="The scrollpane vertical scrollbar policy") 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

@BeanProperty(preferred=true, enumerationValues={"ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED","ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER","ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS"}, description="The scrollpane scrollbar policy") 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

@BeanProperty(preferred=true, description="The border around the viewport.") public void setViewportBorder(Border viewportBorder)

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

このプロパティのデフォルト値はルック・アンド・フィールの実装によって算出されます。

パラメータ:

viewportBorder - 追加されるボーダー

関連項目:

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

getViewportBorderBounds

@BeanProperty(bound=false) 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

@BeanProperty(expert=true, description="The horizontal scrollbar.") 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

@BeanProperty(expert=true, description="The vertical scrollbar.") 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

@BeanProperty(expert=true, visualUpdate=true, description="The viewport child for this scrollpane") 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

@BeanProperty(expert=true, description="The row header child for this scrollpane") 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

@BeanProperty(visualUpdate=true, description="The column header child for this scrollpane") public void setColumnHeader(JViewport columnHeader)

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

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

パラメータ:

columnHeader - 新しい列見出しであるJViewport

関連項目:

• 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

@BeanProperty(description="Flag for enabling/disabling mouse wheel scrolling") public boolean isWheelScrollingEnabled()

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

戻り値:

マウス・ホイール・スクロールが有効な場合はtrue、それ以外の場合はfalse

導入されたバージョン:

1.4

関連項目:

• setWheelScrollingEnabled(boolean)

setWheelScrollingEnabled

@BeanProperty(description="Flag for enabling/disabling mouse wheel scrolling") public void setWheelScrollingEnabled(boolean handleWheel)

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

パラメータ:

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

導入されたバージョン:

1.4

関連項目:

• isWheelScrollingEnabled()
• MouseWheelEvent
• MouseWheelListener

paramString

protected String paramString()

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

オーバーライド:

paramString、クラスJComponent

戻り値:

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

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

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

定義:

getAccessibleContext、インタフェースAccessible

オーバーライド:

getAccessibleContext、クラスComponent

戻り値:

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