| java.lang.Object
 java.awt.Component
java.awt.Container
java.awt.ScrollPane
| ScrollPane | | public class ScrollPane extends Container (Code) | | A container class which implements automatic horizontal and/or
vertical scrolling for a single child component. The display
policy for the scrollbars can be set to:
- as needed: scrollbars created and shown only when needed by scrollpane
- always: scrollbars created and always shown by the scrollpane
- never: scrollbars never created or shown by the scrollpane
The state of the horizontal and vertical scrollbars is represented
by two objects (one for each dimension) which implement the
Adjustable interface. The API provides methods to access those
objects such that the attributes on the Adjustable object (such as unitIncrement,
value, etc.) can be manipulated.
Certain adjustable properties (minimum, maximum, blockIncrement,
and visibleAmount) are set internally by the scrollpane in accordance
with the geometry of the scrollpane and its child and these should
not be set by programs using the scrollpane.
If the scrollbar display policy is defined as "never", then the
scrollpane can still be programmatically scrolled using the
setScrollPosition() method and the scrollpane will move and clip
the child's contents appropriately. This policy is useful if the
program needs to create and manage its own adjustable controls.
The placement of the scrollbars is controlled by platform-specific
properties set by the user outside of the program.
The initial size of this container is set to 100x100, but can
be reset using setSize().
Insets are used to define any space used by scrollbars and any
borders created by the scroll pane. getInsets() can be used
to get the current value for the insets. If the value of
scrollbarsAlwaysVisible is false, then the value of the insets
will change dynamically depending on whether the scrollbars are
currently visible or not.
version:
1.71 08/19/02
author:
Tom Ball
author:
Amy Fowler
author:
Tim Prinzing |
| Field Summary | |
| final public static int | SCROLLBARS_ALWAYS
Specifies that horizontal/vertical scrollbars should always be
shown regardless of the respective sizes of the scrollpane and child. | | final public static int | SCROLLBARS_AS_NEEDED
Specifies that horizontal/vertical scrollbar should be shown
only when the size of the child exceeds the size of the scrollpane
in the horizontal/vertical dimension. | | final public static int | SCROLLBARS_NEVER
Specifies that horizontal/vertical scrollbars should never be shown
regardless of the respective sizes of the scrollpane and child. |
| Constructor Summary | |
| public | ScrollPane()
Create a new scrollpane container with a scrollbar display policy of
"as needed". | | public | ScrollPane(int scrollbarDisplayPolicy)
Create a new scrollpane container. |
| SCROLLBARS_ALWAYS | | final public static int SCROLLBARS_ALWAYS(Code) | | Specifies that horizontal/vertical scrollbars should always be
shown regardless of the respective sizes of the scrollpane and child.
|
| SCROLLBARS_AS_NEEDED | | final public static int SCROLLBARS_AS_NEEDED(Code) | | Specifies that horizontal/vertical scrollbar should be shown
only when the size of the child exceeds the size of the scrollpane
in the horizontal/vertical dimension.
|
| SCROLLBARS_NEVER | | final public static int SCROLLBARS_NEVER(Code) | | Specifies that horizontal/vertical scrollbars should never be shown
regardless of the respective sizes of the scrollpane and child.
|
| ScrollPane | | public ScrollPane()(Code) | | Create a new scrollpane container with a scrollbar display policy of
"as needed".
|
| ScrollPane | | public ScrollPane(int scrollbarDisplayPolicy)(Code) | | Create a new scrollpane container.
Parameters:
scrollbarDisplayPolicy - policy for when scrollbars should be shown |
| addImpl | | final protected void addImpl(Component comp, Object constraints, int index)(Code) | | Adds the specified component to this scroll pane container.
If the scroll pane has an existing child component, that
component is removed and the new one is added.
Parameters:
comp - the component to be added
Parameters:
constraints - not applicable
Parameters:
index - position of child component (must be <= 0) |
| addNotify | | public void addNotify()(Code) | | Creates the scroll pane's peer.
|
| calculateChildSize | | Dimension calculateChildSize(Component child)(Code) | | Determine the size to allocate the child component.
If the viewport area is bigger than the childs
preferred size then the child is allocated enough
to fill the viewport, otherwise the child is given
it's preferred size.
|
| constructComponentName | | String constructComponentName()(Code) | | Construct a name for this component. Called by getName() when the
name is null.
|
| doLayout | | public void doLayout()(Code) | | Lays out this container by resizing its child to its preferred size.
If the new preferred size of the child causes the current scroll
position to be invalid, the scroll position is set to the closest
valid position.
See Also: Component.validate |
| getHAdjustable | | public Adjustable getHAdjustable()(Code) | | Returns the Adjustable object which represents the state of
the horizontal scrollbar.
|
| getHScrollbarHeight | | public int getHScrollbarHeight()(Code) | | Returns the height that would be occupied by a horizontal
scrollbar, which is independent of whether it is currently
displayed by the scroll pane or not.
the height of a horizontal scrollbar in pixels |
| getScrollPosition | | public Point getScrollPosition()(Code) | | Returns the current x,y position within the child which is displayed
at the 0,0 location of the scrolled panel's view port.
This is a convenience method which interfaces with the adjustable
objects which represent the state of the scrollbars.
the coordinate position for the current scroll position |
| getScrollbarDisplayPolicy | | public int getScrollbarDisplayPolicy()(Code) | | Returns the display policy for the scrollbars.
the display policy for the scrollbars |
| getVAdjustable | | public Adjustable getVAdjustable()(Code) | | Returns the Adjustable object which represents the state of
the vertical scrollbar.
|
| getVScrollbarWidth | | public int getVScrollbarWidth()(Code) | | Returns the width that would be occupied by a vertical
scrollbar, which is independent of whether it is currently
displayed by the scroll pane or not.
the width of a vertical scrollbar in pixels |
| getViewportSize | | public Dimension getViewportSize()(Code) | | Returns the current size of the scroll pane's view port.
the size of the view port in pixels |
| isWheelScrollingEnabled | | public boolean isWheelScrollingEnabled()(Code) | | Indicates whether or not scrolling will take place in response to
the mouse wheel. Wheel scrolling is enabled by default.
See Also: ScrollPane.setWheelScrollingEnabled(boolean)
since:
1.4 |
| layout | | public void layout()(Code) | | |
| processMouseWheelEvent | | protected void processMouseWheelEvent(MouseWheelEvent e)(Code) | | Process mouse wheel events that are delivered to this
ScrollPane by scrolling an appropriate amount.
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters:
e - the mouse wheel event
since:
1.4 |
| setLayout | | final public void setLayout(LayoutManager mgr)(Code) | | Sets the layout manager for this container. This method is
overridden to prevent the layout mgr from being set.
Parameters:
mgr - the specified layout manager |
| setScrollPosition | | public void setScrollPosition(int x, int y)(Code) | | Scrolls to the specified position within the child component.
A call to this method is only valid if the scroll pane contains
a child. Specifying a position outside of the legal scrolling bounds
of the child will scroll to the closest legal position.
Legal bounds are defined to be the rectangle:
x = 0, y = 0, width = (child width - view port width),
height = (child height - view port height).
This is a convenience method which interfaces with the Adjustable
objects which represent the state of the scrollbars.
Parameters:
x - the x position to scroll to
Parameters:
y - the y position to scroll to |
| setScrollPosition | | public void setScrollPosition(Point p)(Code) | | Scrolls to the specified position within the child component.
A call to this method is only valid if the scroll pane contains
a child and the specified position is within legal scrolling bounds
of the child. Specifying a position outside of the legal scrolling
bounds of the child will scroll to the closest legal position.
Legal bounds are defined to be the rectangle:
x = 0, y = 0, width = (child width - view port width),
height = (child height - view port height).
This is a convenience method which interfaces with the Adjustable
objects which represent the state of the scrollbars.
Parameters:
p - the Point representing the position to scroll to |
| Methods inherited from java.awt.Container | public Component add(Component comp)(Code)(Java Doc)
public Component add(String name, Component comp)(Code)(Java Doc)
public Component add(Component comp, int index)(Code)(Java Doc)
public void add(Component comp, Object constraints)(Code)(Java Doc)
public void add(Component comp, Object constraints, int index)(Code)(Java Doc)
public synchronized void addContainerListener(ContainerListener l)(Code)(Java Doc)
protected void addImpl(Component comp, Object constraints, int index)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public int countComponents()(Code)(Java Doc)
public void deliverEvent(Event e)(Code)(Java Doc)
public void doLayout()(Code)(Java Doc)
boolean eventEnabled(AWTEvent e)(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public Component getComponent(int n)(Code)(Java Doc)
public Component getComponentAt(int x, int y)(Code)(Java Doc)
public Component getComponentAt(Point p)(Code)(Java Doc)
public int getComponentCount()(Code)(Java Doc)
public Component[] getComponents()(Code)(Java Doc)
public Insets getInsets()(Code)(Java Doc)
public LayoutManager getLayout()(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
Window getWindow()(Code)(Java Doc)
public Insets insets()(Code)(Java Doc)
public void invalidate()(Code)(Java Doc)
public boolean isAncestorOf(Component c)(Code)(Java Doc)
public void layout()(Code)(Java Doc)
void lightweightPrint(Graphics g)(Code)(Java Doc)
public void list(PrintStream out, int indent)(Code)(Java Doc)
public void list(PrintWriter out, int indent)(Code)(Java Doc)
public Component locate(int x, int y)(Code)(Java Doc)
public Dimension minimumSize()(Code)(Java Doc)
void nextFocus(Component base)(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
public void paintComponents(Graphics g)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public Dimension preferredSize()(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printComponents(Graphics g)(Code)(Java Doc)
protected void processContainerEvent(ContainerEvent e)(Code)(Java Doc)
protected void processEvent(AWTEvent e)(Code)(Java Doc)
public void remove(int index)(Code)(Java Doc)
public void remove(Component comp)(Code)(Java Doc)
public void removeAll()(Code)(Java Doc)
public synchronized void removeContainerListener(ContainerListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public void setLayout(LayoutManager mgr)(Code)(Java Doc)
void transferFocus(Component base)(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void validate()(Code)(Java Doc)
protected void validateTree()(Code)(Java Doc)
|
| Methods inherited from java.awt.Component | public boolean action(Event evt, Object what)(Code)(Java Doc)
public synchronized void add(PopupMenu popup)(Code)(Java Doc)
public synchronized void addComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void addFocusListener(FocusListener l)(Code)(Java Doc)
public synchronized void addKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void addMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void addMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
boolean areInputMethodsEnabled()(Code)(Java Doc)
public Rectangle bounds()(Code)(Java Doc)
final void checkEnableNewEventsOnly(Object listener)(Code)(Java Doc)
public int checkImage(Image image, ImageObserver observer)(Code)(Java Doc)
public int checkImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)(Code)(Java Doc)
String constructComponentName()(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public boolean contains(Point p)(Code)(Java Doc)
public Image createImage(ImageProducer producer)(Code)(Java Doc)
public Image createImage(int width, int height)(Code)(Java Doc)
ComponentXWindow createXWindow()(Code)(Java Doc)
public void deliverEvent(Event e)(Code)(Java Doc)
public void disable()(Code)(Java Doc)
final protected void disableEvents(long eventsToDisable)(Code)(Java Doc)
final public void dispatchEvent(AWTEvent e)(Code)(Java Doc)
void dispatchEventImpl(AWTEvent e)(Code)(Java Doc)
public void doLayout()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void enable(boolean b)(Code)(Java Doc)
final protected synchronized void enableEvents(long eventsToEnable)(Code)(Java Doc)
boolean eventEnabled(AWTEvent e)(Code)(Java Doc)
Component findFocusDelegate(Container container)(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public Rectangle getBounds()(Code)(Java Doc)
public ColorModel getColorModel()(Code)(Java Doc)
public Component getComponentAt(int x, int y)(Code)(Java Doc)
public Component getComponentAt(Point p)(Code)(Java Doc)
public Cursor getCursor()(Code)(Java Doc)
Component getFocusDelegate()(Code)(Java Doc)
public Font getFont()(Code)(Java Doc)
Component getFontAndColorDelegate()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
InputContext getInputContext()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Point getLocation()(Code)(Java Doc)
public Point getLocationOnScreen()(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
Container getNativeContainer()(Code)(Java Doc)
public Container getParent()(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public Dimension getSize()(Code)(Java Doc)
public Toolkit getToolkit()(Code)(Java Doc)
final public Object getTreeLock()(Code)(Java Doc)
public boolean gotFocus(Event evt, Object what)(Code)(Java Doc)
public boolean handleEvent(Event evt)(Code)(Java Doc)
public void hide()(Code)(Java Doc)
public boolean imageUpdate(Image img, int flags, int x, int y, int w, int h)(Code)(Java Doc)
public boolean inside(int x, int y)(Code)(Java Doc)
public void invalidate()(Code)(Java Doc)
static void invokeAndWait(Runnable runnable)(Code)(Java Doc)
public boolean isDisplayable()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isFocusTraversable()(Code)(Java Doc)
public boolean isLightweight()(Code)(Java Doc)
boolean isLightweightWhenDisplayable()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isShowing()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
public boolean keyDown(Event evt, int key)(Code)(Java Doc)
public boolean keyUp(Event evt, int key)(Code)(Java Doc)
public void layout()(Code)(Java Doc)
void lightweightPrint(Graphics g)(Code)(Java Doc)
public void list()(Code)(Java Doc)
public void list(PrintStream out)(Code)(Java Doc)
public void list(PrintStream out, int indent)(Code)(Java Doc)
public void list(PrintWriter out)(Code)(Java Doc)
public void list(PrintWriter out, int indent)(Code)(Java Doc)
public Component locate(int x, int y)(Code)(Java Doc)
public Point location()(Code)(Java Doc)
public boolean lostFocus(Event evt, Object what)(Code)(Java Doc)
public Dimension minimumSize()(Code)(Java Doc)
public boolean mouseDown(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseDrag(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseEnter(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseExit(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseMove(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseUp(Event evt, int x, int y)(Code)(Java Doc)
public void move(int x, int y)(Code)(Java Doc)
public void nextFocus()(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
public void paintAll(Graphics g)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public boolean postEvent(Event e)(Code)(Java Doc)
public Dimension preferredSize()(Code)(Java Doc)
public boolean prepareImage(Image image, ImageObserver observer)(Code)(Java Doc)
public boolean prepareImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
protected void processComponentEvent(ComponentEvent e)(Code)(Java Doc)
protected void processEvent(AWTEvent e)(Code)(Java Doc)
protected void processFocusEvent(FocusEvent e)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
public synchronized void remove(MenuComponent popup)(Code)(Java Doc)
public synchronized void removeComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void removeFocusListener(FocusListener l)(Code)(Java Doc)
public synchronized void removeKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void removeMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void removeMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public void repaint()(Code)(Java Doc)
public void repaint(long tm)(Code)(Java Doc)
public void repaint(int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
public void reshape(int x, int y, int width, int height)(Code)(Java Doc)
public void resize(int width, int height)(Code)(Java Doc)
public void resize(Dimension d)(Code)(Java Doc)
public void setBackground(Color c)(Code)(Java Doc)
public void setBounds(int x, int y, int width, int height)(Code)(Java Doc)
public void setBounds(Rectangle r)(Code)(Java Doc)
public synchronized void setCursor(Cursor cursor)(Code)(Java Doc)
public void setEnabled(boolean b)(Code)(Java Doc)
public void setFont(Font f)(Code)(Java Doc)
public void setForeground(Color c)(Code)(Java Doc)
public void setLocale(Locale l)(Code)(Java Doc)
public void setLocation(int x, int y)(Code)(Java Doc)
public void setLocation(Point p)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setSize(int width, int height)(Code)(Java Doc)
public void setSize(Dimension d)(Code)(Java Doc)
public void setVisible(boolean b)(Code)(Java Doc)
public void show()(Code)(Java Doc)
public void show(boolean b)(Code)(Java Doc)
public Dimension size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void transferFocus()(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void validate()(Code)(Java Doc)
|
|
|