Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.JScrollPane

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

public class JScrollPane
extends JComponent
implements ScrollPaneConstants, Accessible
A specialized container that manages a viewport, optional vertical and horizontal scrollbars, and optional row and column heading viewports.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
ScrollBar

Inner Class Summary
 JScrollPane.AccessibleJScrollPane
The class used to obtain the accessible role for this object.
 JScrollPane.ScrollBar
By default JScrollPane creates scrollbars that are instances of this class.
 
Inner classes inherited from class java.awt.swing.JComponent
 JComponent.AccessibleJComponent
 

Field Summary
static String[]  cornerKeywords
 
 
Fields inherited from class java.awt.swing.JComponent
 accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
 BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 

Constructor Summary
 JScrollPane(Component view, int vsbPolicy, int hsbPolicy)
 
 JScrollPane(Component view)
 
 JScrollPane(int vsbPolicy, int hsbPolicy)
 
 JScrollPane()
 
 

Method Summary
JScrollBar  createHorizontalScrollBar()
Used by ScrollPaneUI implementations to create the horizontal scrollbar.
JScrollBar  createVerticalScrollBar()
Used by ScrollPaneUI implementations to create the vertical scrollbar.
JViewport  createViewport()
Returns 'new JViewport()' by default.
AccessibleContext  getAccessibleContext()
Get the AccessibleContext associated with this JComponent
JViewport  getColumnHeader()
 
Component  getCorner(String key)
 
JScrollBar  getHorizontalScrollBar()
 
int  getHorizontalScrollBarPolicy()
 
JViewport  getRowHeader()
 
java.awt.swing.plaf.ScrollPaneUI  getUI()
 
String  getUIClassID()
 
JScrollBar  getVerticalScrollBar()
 
int  getVerticalScrollBarPolicy()
 
JViewport  getViewport()
 
Border  getViewportBorder()
 
boolean  isOpaque()
 
boolean  isValidateRoot()
Calls to revalidate() any descendant of this JScrollPane, e.g.
void  setColumnHeader(JViewport x)
 
void  setColumnHeaderView(Component view)
Creates a ColumnHeader viewport if neccessary and then sets its view.
void  setCorner(String key, Component x)
 
void  setHorizontalScrollBarPolicy(int x)
 
void  setRowHeader(JViewport x)
 
void  setRowHeaderView(Component view)
Creates a RowHeader viewport if neccessary and then sets its view.
void  setUI(java.awt.swing.plaf.ScrollPaneUI ui)
 
void  setVerticalScrollBarPolicy(int x)
 
void  setViewport(JViewport x)
 
void  setViewportBorder(Border viewportBorder)
Add a border around the viewport.
void  setViewportView(Component view)
Creates a viewport if neccessary and then sets its view.
void  updateUI()
 
 
Methods inherited from class java.awt.swing.JComponent
 addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
 add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
 action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cornerKeywords

protected static final String[] cornerKeywords
Constructor Detail

JScrollPane

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

JScrollPane

public JScrollPane(Component view)

JScrollPane

public JScrollPane(int vsbPolicy,
                   int hsbPolicy)

JScrollPane

public JScrollPane()
Method Detail

getUI

public java.awt.swing.plaf.ScrollPaneUI getUI()

setUI

public void setUI(java.awt.swing.plaf.ScrollPaneUI ui)

updateUI

public void updateUI()
Overrides:
updateUI in class JComponent

getUIClassID

public String getUIClassID()
Returns:
"ScrollPaneUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int x)

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int x)

getViewportBorder

public Border getViewportBorder()
Returns:
the value of the viewportBorder property.
See Also:
setViewportBorder

setViewportBorder

public void setViewportBorder(Border viewportBorder)
Add a border around the viewport. Note that the border isn't set on the viewport directly, JViewport doesn't support the JComponent border property. Similarly setting the JScrollPanes viewport doesn't effect the viewportBorder property.

The default value of this property is computed by the look and feel implementation.

This is a JavaBeans bound property.

See Also:
getViewportBorder, setViewport

createHorizontalScrollBar

public JScrollBar createHorizontalScrollBar()
Used by ScrollPaneUI implementations to create the horizontal scrollbar. Returns a JScrollPane.ScrollBar by default. Subclasses may override this method to force ScrollPaneUI implementations to use a JScrollBar subclass.
Returns:
The horizontal JScrollBar
See Also:
ScrollBar

createVerticalScrollBar

public JScrollBar createVerticalScrollBar()
Used by ScrollPaneUI implementations to create the vertical scrollbar. Returns a JScrollPane.ScrollBar by default. Subclasses may override this method to force ScrollPaneUI implementations to use a JScrollBar subclass.
Returns:
The vertical JScrollBar
See Also:
ScrollBar

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()

createViewport

protected JViewport createViewport()
Returns 'new JViewport()' by default. Used to create the viewport (as needed) in setViewportView(), setRowHeaderView(), and setColumnHeaderView(). Subclasses my override this method to return a subclass of JViewport.

getViewport

public JViewport getViewport()

setViewport

public void setViewport(JViewport x)

setViewportView

public void setViewportView(Component view)
Creates a viewport if neccessary and then sets its view.

getRowHeader

public JViewport getRowHeader()

setRowHeader

public void setRowHeader(JViewport x)

setRowHeaderView

public void setRowHeaderView(Component view)
Creates a RowHeader viewport if neccessary and then sets its view.

getColumnHeader

public JViewport getColumnHeader()

setColumnHeader

public void setColumnHeader(JViewport x)

setColumnHeaderView

public void setColumnHeaderView(Component view)
Creates a ColumnHeader viewport if neccessary and then sets its view.

getCorner

public Component getCorner(String key)

setCorner

public void setCorner(String key,
                      Component x)

isOpaque

public boolean isOpaque()
Overrides:
isOpaque in class JComponent

isValidateRoot

public boolean isValidateRoot()
Calls to revalidate() any descendant of this JScrollPane, e.g. the viewports view, will cause a request to be queued that will validate this JScrollPane and all its descendants.
Returns:
true
Overrides:
isValidateRoot in class JComponent
See Also:
revalidate, invalidate, validate

getAccessibleContext

public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Implements:
getAccessibleContext in interface Accessible
Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.