Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class gui.Scroller

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Panel
                    |
                    +--gui.Scroller

public class Scroller

extends java.awt.Panel

implements java.awt.LayoutManager

A `wrapper' panel for containing an awt.Component (of whatever design) which can be scrolled. The Scroller provides a viewport onto the `scrolled' panel and maintains optional scrollbars.

Note that due to limitations in the awt design (and limitations in time to find workarounds) there are two notable problems with this Containter:

• It is rather jumpy, during scrolling (it doesn't seem possible, with the documented interface, to double-buffer the display).
• If you add items to the scrolled panel, you have to invalidate() (and then validate()) the Scroller. Otherwise, it doesn't know about the change and will not recompute the viewport.

See Also:

Serialized Form

Field Summary

static int	ALWAYS Indicator to always show scrollbars.
static int	IFNEEDED Indicator to show scrollbars only when the scrolled component is too large.
static int	NEVER Indicator to never show scrollbars.

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

Scroller(java.awt.Component scrolled)
Create a Scroller panel using scrolled as the inner component to be scrolled, and placing scrollbars only if needed.

Scroller(java.awt.Component scrolled, int xscrolling, int yscrolling)
Create a Scroller panel using scrolled as the inner component to be scrolled, and placing according to the given flags.

Method Summary

void	addLayoutComponent(java.lang.String name, java.awt.Component comp) Implementing Layout manager for use by clipping panel ONLY!
boolean	handleEvent(java.awt.Event e)
java.awt.Insets	insets()
void	layoutContainer(java.awt.Container parent)
java.awt.Dimension	minimumLayoutSize(java.awt.Container parent)
void	paint(java.awt.Graphics g)
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent)
void	removeLayoutComponent(java.awt.Component comp)
void	setXScrolling(int xscrolling) Set the parameter for when the X (horizontal) scrollbar should be shown.
void	setYScrolling(int yscrolling) Set the parameter for when the Y (vertical) scrollbar should be shown.

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponentAt, getComponentAt, getComponent, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, paint, paramString, preferredSize, printComponents, print, processContainerEvent, processEvent, removeAll, remove, remove, 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, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, 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, paintAll, paint, paramString, postEvent, preferredSize, prepareImage, prepareImage, printAll, print, 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, setComponentOrientation, 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, notifyAll, notify, toString, wait, wait, wait

Field Detail

IFNEEDED

public static final int IFNEEDED

Indicator to show scrollbars only when the scrolled component is too large.

ALWAYS

public static final int ALWAYS

Indicator to always show scrollbars.

NEVER

public static final int NEVER

Indicator to never show scrollbars.

Constructor Detail

Scroller

public Scroller(java.awt.Component scrolled)

Create a Scroller panel using scrolled as the inner component to be scrolled, and placing scrollbars only if needed.

Scroller

public Scroller(java.awt.Component scrolled,
                int xscrolling,
                int yscrolling)

Create a Scroller panel using scrolled as the inner component to be scrolled, and placing according to the given flags.

Method Detail

setXScrolling

public void setXScrolling(int xscrolling)

Set the parameter for when the X (horizontal) scrollbar should be shown.

setYScrolling

public void setYScrolling(int yscrolling)

Set the parameter for when the Y (vertical) scrollbar should be shown.

handleEvent

public boolean handleEvent(java.awt.Event e)

Overrides:

handleEvent in class java.awt.Component

insets

public java.awt.Insets insets()

Overrides:

insets in class java.awt.Container

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class java.awt.Container

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                               java.awt.Component comp)

Implementing Layout manager for use by clipping panel ONLY!

Specified by:

addLayoutComponent(java.lang.String, java.awt.Component) in interface java.awt.LayoutManager

layoutContainer

public void layoutContainer(java.awt.Container parent)

Description copied from interface:

Specified by:

layoutContainer(java.awt.Container) in interface java.awt.LayoutManager

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)

Description copied from interface:

Specified by:

minimumLayoutSize(java.awt.Container) in interface java.awt.LayoutManager

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)

Description copied from interface:

Specified by:

preferredLayoutSize(java.awt.Container) in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Description copied from interface:

Specified by:

removeLayoutComponent(java.awt.Component) in interface java.awt.LayoutManager