Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> [ swing overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.swing
Class JScrollPane  

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JScrollPane

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, ScrollPaneConstants, java.io.Serializable

---

public class JScrollPane

extends JComponent

implements javax.accessibility.Accessible, ScrollPaneConstants

A component that embeds another component and enables it to be scrolled both in horizontal and vertical direction.

Property	Stored in	Bound?
columnHeader	scrollPane	yes
columnHeaderView	columnHeader	no
componentOrientation	scrollPane	yes
horizontalScrollBar	scrollPane	yes
horizontalScrollBarPolicy	scrollPane	yes
layout	scrollPane	yes
rowHeader	scrollPane	yes
rowHeaderView	rowHeader	no
validateRoot	scrollPane	no
verticalScrollBar	scrollPane	yes
verticalScrollBarPolicy	scrollPane	yes
viewport	scrollPane	yes
viewportBorder	scrollPane	yes
viewportBorderBounds	scrollPane	no
viewportView	viewport	no
wheelScrollingEnabled	scrollPane	yes

---

Nested Class Summary
protected  class	JScrollPane.AccessibleJScrollPane           Provides accessibility support for the JScrollPane.
protected  class	JScrollPane.ScrollBar

 

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

 

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

 

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

 

Field Summary
protected  JViewport	columnHeader
protected  JScrollBar	horizontalScrollBar
protected  int	horizontalScrollBarPolicy
protected  java.awt.Component	lowerLeft
protected  java.awt.Component	lowerRight
protected  JViewport	rowHeader
private static long	serialVersionUID
protected  java.awt.Component	upperLeft
protected  java.awt.Component	upperRight
protected  JScrollBar	verticalScrollBar
protected  int	verticalScrollBarPolicy
protected  JViewport	viewport
(package private)  javax.swing.border.Border	viewportBorder
(package private)  boolean	wheelScrollingEnabled

 

Fields inherited from class javax.swing.JComponent

accessibleContext, alignmentX, alignmentY, autoscrolls, border, debugGraphicsOptions, doubleBuffered, isCompletelyDirty, isPaintingDoubleBuffered, listenerList, maximumSize, minimumSize, opaque, preferredSize, requestFocusEnabled, TOOL_TIP_TEXT_KEY, toolTipText, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

 

Fields inherited from class java.awt.Container

 

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

 

Fields inherited from interface 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

 

Fields inherited from interface java.awt.image.ImageObserver

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

 

Constructor Summary

JScrollPane()           Creates a new JScrollPane without a view.

JScrollPane(java.awt.Component view)           Creates a new JScrollPane that embeds the specified view component, displaying vertical and horizontal scrollbars as needed.

JScrollPane(java.awt.Component view, int vsbPolicy, int hsbPolicy)           Creates a new JScrollPane that embeds the specified view component; The scrollbar policies are set to vsbPolicy and hsbPolicy.

JScrollPane(int vsbPolicy, int hsbPolicy)           Creates a new JScrollPane without a view; The scrollbar policies are set to vsbPolicy and hsbPolicy.

 

Method Summary
private  void	addNonNull(java.awt.Component c, java.lang.Object constraints)
JScrollBar	createHorizontalScrollBar()
JScrollBar	createVerticalScrollBar()
protected  JViewport	createViewport()
javax.accessibility.AccessibleContext	getAccessibleContext()           Returns the accessible context associated with this JScrollPane.
JViewport	getColumnHeader()
java.awt.Component	getCorner(java.lang.String key)
JScrollBar	getHorizontalScrollBar()
int	getHorizontalScrollBarPolicy()
JViewport	getRowHeader()
javax.swing.plaf.ScrollPaneUI	getUI()           This method returns the scrollpane's UI delegate.
java.lang.String	getUIClassID()           Get the value of the UIClassID property.
JScrollBar	getVerticalScrollBar()
int	getVerticalScrollBarPolicy()
JViewport	getViewport()
javax.swing.border.Border	getViewportBorder()
java.awt.Rectangle	getViewportBorderBounds()
boolean	isValidateRoot()           Return true if this component is a validation root; this will cause calls to Container.invalidate()>Container.invalidate() 55 in this component's children to be "captured" at this component, and not propagate to its parents.
boolean	isWheelScrollingEnabled()
private  void	removeNonNull(java.awt.Component c)
void	setColumnHeader(JViewport h)
void	setColumnHeaderView(java.awt.Component c)
void	setComponentOrientation(java.awt.ComponentOrientation co)           Sets the text layout orientation of this component.
void	setCorner(java.lang.String key, java.awt.Component c)
void	setHorizontalScrollBar(JScrollBar h)
void	setHorizontalScrollBarPolicy(int h)
void	setLayout(java.awt.LayoutManager l)           Sets the layout manager for this container to the specified layout manager.
void	setRowHeader(JViewport v)
void	setRowHeaderView(java.awt.Component c)
void	setUI(javax.swing.plaf.ScrollPaneUI ui)           This method sets the scrollpane's UI delegate.
void	setVerticalScrollBar(JScrollBar v)
void	setVerticalScrollBarPolicy(int v)
void	setViewport(JViewport v)
void	setViewportBorder(javax.swing.border.Border b)
void	setViewportView(java.awt.Component view)
void	setWheelScrollingEnabled(boolean b)
private  void	sync()
void	updateUI()           This method should be overridden in subclasses.

 

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireAncestorEvent, 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, 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, paintImmediately2, paintSimple, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, setUIProperty, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateComponentInputMap

 

Methods inherited from class java.awt.Container

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

 

Methods inherited from class 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, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, 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, 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

 

Methods inherited from class java.lang.Object

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

 

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

---

columnHeader

protected JViewport columnHeader

---

rowHeader

protected JViewport rowHeader

---

lowerLeft

protected java.awt.Component lowerLeft

---

lowerRight

protected java.awt.Component lowerRight

---

upperLeft

protected java.awt.Component upperLeft

---

upperRight

protected java.awt.Component upperRight

---

horizontalScrollBar

protected JScrollBar horizontalScrollBar

---

horizontalScrollBarPolicy

protected int horizontalScrollBarPolicy

---

verticalScrollBar

protected JScrollBar verticalScrollBar

---

verticalScrollBarPolicy

protected int verticalScrollBarPolicy

---

viewport

protected JViewport viewport

---

viewportBorder

javax.swing.border.Border viewportBorder

---

wheelScrollingEnabled

boolean wheelScrollingEnabled

Constructor Detail

JScrollPane

public JScrollPane()

Creates a new JScrollPane without a view. The scrollbar policy is set to ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED 55 and ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED 55 .

---

JScrollPane

public JScrollPane(java.awt.Component view)

Creates a new JScrollPane that embeds the specified view component, displaying vertical and horizontal scrollbars as needed.

---

JScrollPane

public JScrollPane(int vsbPolicy,
                   int hsbPolicy)

Creates a new JScrollPane without a view; The scrollbar policies are set to vsbPolicy and hsbPolicy.

---

JScrollPane

public JScrollPane(java.awt.Component view,
                   int vsbPolicy,
                   int hsbPolicy)

Creates a new JScrollPane that embeds the specified view component; The scrollbar policies are set to vsbPolicy and hsbPolicy.

Method Detail

getColumnHeader

public JViewport getColumnHeader()

---

getCorner

public java.awt.Component getCorner(java.lang.String key)

---

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()

---

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

---

getRowHeader

public JViewport getRowHeader()

---

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()

---

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

---

getViewport

public JViewport getViewport()

---

getViewportBorder

public javax.swing.border.Border getViewportBorder()

---

getViewportBorderBounds

public java.awt.Rectangle getViewportBorderBounds()

---

isWheelScrollingEnabled

public boolean isWheelScrollingEnabled()

---

sync

private void sync()

---

removeNonNull

private void removeNonNull(java.awt.Component c)

---

addNonNull

private void addNonNull(java.awt.Component c,
                        java.lang.Object constraints)

---

setComponentOrientation

public void setComponentOrientation(java.awt.ComponentOrientation co)

Description copied from class: java.awt.Component

Sets the text layout orientation of this component. New components default to UNKNOWN (which behaves like LEFT_TO_RIGHT). This method affects only the current component, while Component.applyComponentOrientation(ComponentOrientation)>Component.applyComponentOrientation(ComponentOrientation) 55 affects the entire hierarchy.

---

setColumnHeader

public void setColumnHeader(JViewport h)

---

setColumnHeaderView

public void setColumnHeaderView(java.awt.Component c)

---

setCorner

public void setCorner(java.lang.String key,
                      java.awt.Component c)

---

setHorizontalScrollBar

public void setHorizontalScrollBar(JScrollBar h)

---

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int h)

---

setLayout

public void setLayout(java.awt.LayoutManager l)

Description copied from class: java.awt.Container

Sets the layout manager for this container to the specified layout manager.

---

setRowHeader

public void setRowHeader(JViewport v)

---

setRowHeaderView

public void setRowHeaderView(java.awt.Component c)

---

setVerticalScrollBar

public void setVerticalScrollBar(JScrollBar v)

---

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int v)

---

setWheelScrollingEnabled

public void setWheelScrollingEnabled(boolean b)

---

setViewport

public void setViewport(JViewport v)

---

setViewportBorder

public void setViewportBorder(javax.swing.border.Border b)

---

setViewportView

public void setViewportView(java.awt.Component view)

---

isValidateRoot

public boolean isValidateRoot()

Description copied from class: JComponent

Return true if this component is a validation root; this will cause calls to Container.invalidate()>Container.invalidate() 55 in this component's children to be "captured" at this component, and not propagate to its parents. For most components this should return false, but some components such as JViewport will want to return true.

Overrides:

isValidateRoot in class JComponent

---

createHorizontalScrollBar

public JScrollBar createHorizontalScrollBar()

---

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()

---

createViewport

protected JViewport createViewport()

---

getUIClassID

public java.lang.String getUIClassID()

Description copied from class: JComponent

Get the value of the UIClassID property. This property should be a key in the UIDefaults table managed by UIManager, the value of which is the name of a class to load for the component's JComponent.ui 55 property.

Overrides:

getUIClassID in class JComponent

---

updateUI

public void updateUI()

Description copied from class: JComponent

This method should be overridden in subclasses. In JComponent, the method does nothing. In subclasses, it should a UI delegate (corresponding to the symbolic name returned from JComponent.getUIClassID() 55 ) from the UIManager, and calls JComponent.setUI(javax.swing.plaf.ComponentUI) 55 with the new delegate.

Overrides:

updateUI in class JComponent

---

getUI

public javax.swing.plaf.ScrollPaneUI getUI()

This method returns the scrollpane's UI delegate.

---

setUI

public void setUI(javax.swing.plaf.ScrollPaneUI ui)

This method sets the scrollpane's UI delegate.

---

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Returns the accessible context associated with this JScrollPane.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class JComponent

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> [ swing overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---