javax.swing
クラス JScrollPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JScrollPane

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

Accessible, ImageObserver, MenuContainer, ScrollPaneConstants, Serializable

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 オブジェクトです。列ヘッダビューポートは自動的に左右にスクロールして、メインビューポートの左右へのスクロールを追跡します。垂直にはスクロールしません。行ヘッダも同じように動作します。

デフォルトでは、コーナーは空です。スクロール区画に追加したい機能や装飾がある場合には、setCorner を使ってコンポーネントをコーナーに追加することができます。コーナーコンポーネントのサイズは、ヘッダとその周りのスクロールバーのサイズによって決まります。

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

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JScrollPane のキーの割り当てを参照してください。

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

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

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

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK バージョン 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 から継承した入れ子クラス

クラス java.awt.Container から継承した入れ子クラス

クラス java.awt.Component から継承した入れ子クラス

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 を呼び出します。
boolean	isWheelScrollingEnabled() マウスホイールに応答してスクロールが行われるかどうかを示します。
protected String	paramString() この JScrollPane の文字列表現を返します。
void	setColumnHeader(JViewport columnHeader) 以前の列ヘッダがある場合はそれを削除します。
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) 以前の行ヘッダがある場合はそれを削除します。
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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

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

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

フィールドの詳細

verticalScrollBarPolicy

protected int verticalScrollBarPolicy

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

関連項目:

setVerticalScrollBarPolicy(int)

horizontalScrollBarPolicy

protected int horizontalScrollBarPolicy

水平スクロールバーの表示ポリシーです。デフォルトは JScrollPane.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 が変更されたときに呼び出されます。

オーバーライド:

クラス JComponent 内の updateUI

関連項目:

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

getUIClassID

public String getUIClassID()

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

オーバーライド:

クラス JComponent 内の getUIClassID

戻り値:

文字列「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 を呼び出します。

オーバーライド:

クラス Container 内の setLayout

パラメータ:

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

例外:

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

関連項目:

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

isValidateRoot

public boolean isValidateRoot()

JScrollPane の下位オブジェクトで revalidate を呼び出します。たとえば、ビューポートのビューは、JScrollPane とそのすべての下位オブジェクトを検証する要求がキューに入れられるようにします。

オーバーライド:

クラス JComponent 内の isValidateRoot

戻り値:

true

関連項目:

JComponent.revalidate()

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

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

戻り値:

verticalScrollBarPolicy プロパティ

関連項目:

setVerticalScrollBarPolicy(int)

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int policy)

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

• JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED
• JScrollPane.VERTICAL_SCROLLBAR_NEVER
• JScrollPane.VERTICAL_SCROLLBAR_ALWAYS

パラメータ:

policy - 上記の 3 つの値のどれか

例外:

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

関連項目:

getVerticalScrollBarPolicy()

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

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

戻り値:

horizontalScrollBarPolicy プロパティ

関連項目:

setHorizontalScrollBarPolicy(int)

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int policy)

水平スクロールバーがスクロール区画にいつ表示されるかを設定します。次に有効な値を示します。

• JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED
• JScrollPane.HORIZONTAL_SCROLLBAR_NEVER
• JScrollPane.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 座標とビューポート (存在する場合) を同期させてからスクロール区画に追加します。

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

関連項目:

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 値を次に示します。

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

パラメータ:

key - 上記の値のどれか

戻り値:

次のコンポーネントのどれか。key が無効な場合は null。

• lowerLeft
• lowerRight
• upperLeft
• upperRight

関連項目:

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

setCorner

public void setCorner(String key,
                      Component corner)

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

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

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

パラメータ:

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

corner - 次のコンポーネントのどれか。

• lowerLeft
• lowerRight
• upperLeft
• upperRight

例外:

IllegalArgumentException - キーが無効な場合

setComponentOrientation

public void setComponentOrientation(ComponentOrientation co)

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

オーバーライド:

クラス Component 内の setComponentOrientation

パラメータ:

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 にはなりません。

オーバーライド:

クラス JComponent 内の paramString

戻り値:

この JScrollPane の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス JComponent 内の getAccessibleContext

戻り値:

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