Package org.apache.pivot.wtk

Class ScrollPane

java.lang.Object

org.apache.pivot.wtk.Component

org.apache.pivot.wtk.Container

org.apache.pivot.wtk.Viewport

org.apache.pivot.wtk.ScrollPane

All Implemented Interfaces:

java.lang.Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class ScrollPane
extends Viewport

Container that provides a scrollable view of a component, with optional fixed row and column headers.

The single component to be scrolled will typically be a Container and should be specified by the setView() method (the "view" property). So, even then though this class is a Container, you should not add components to it via the add() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScrollPane.Corner	Component class representing the components that will get placed in the corners of a ScrollPane.
static class	ScrollPane.ScrollBarPolicy	Enumeration defining when to show a scroll bar, and if not showing, whether to constrain the pane's content to the size of the ScrollPane, or to let the content be shown at its unconstrained size.

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Viewport

Viewport.Skin

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container

Container.EDTChecker

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component

Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Constructors

Constructor	Description
ScrollPane()
ScrollPane(ScrollPane.ScrollBarPolicy horizontalScrollBarPolicy, ScrollPane.ScrollBarPolicy verticalScrollBarPolicy)

Method Summary

Modifier and Type	Method	Description
Component	getColumnHeader()
Component	getCorner()
ScrollPane.ScrollBarPolicy	getHorizontalScrollBarPolicy()
Component	getRowHeader()
ListenerList<ScrollPaneListener>	getScrollPaneListeners()
ScrollPane.ScrollBarPolicy	getVerticalScrollBarPolicy()
Sequence<Component>	remove(int index, int count)	This method should not be called to remove child components from the Viewport because the viewable child(ren) are set by the Viewport.setView(org.apache.pivot.wtk.Component) method instead.
void	setColumnHeader(Component columnHeader)
void	setCorner(Component corner)
void	setHorizontalScrollBarPolicy(ScrollPane.ScrollBarPolicy horizontalScrollBarPolicy)
void	setRowHeader(Component rowHeader)
void	setVerticalScrollBarPolicy(ScrollPane.ScrollBarPolicy verticalScrollBarPolicy)

Methods inherited from class org.apache.pivot.wtk.Viewport

getScrollLeft, getScrollTop, getView, getViewportBounds, getViewportListeners, isConsumeRepaint, isRepaintAllViewport, repaint, setConsumeRepaint, setRepaintAllViewport, setScrollLeft, setScrollTop, setSkin, setView

Methods inherited from class org.apache.pivot.wtk.Container

add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, transferFocus, update

Methods inherited from class org.apache.pivot.wtk.Component

checkSkin, clearFocus, contains, copyStyle, copyStyle, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getScreenBounds, getSize, getSkin, getStyle, getStyle, getStyleBoolean, getStyleBoolean, getStyleColor, getStyleColor, getStyleFont, getStyleFont, getStyleInt, getStyleInt, getStyles, getTextInputMethodListener, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, offsetToScreen, putStyle, putStyle, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.pivot.collections.Sequence

addAll, addAll

Constructor Detail

ScrollPane

public ScrollPane()

ScrollPane

public ScrollPane(ScrollPane.ScrollBarPolicy horizontalScrollBarPolicy,
                  ScrollPane.ScrollBarPolicy verticalScrollBarPolicy)

Method Detail

getHorizontalScrollBarPolicy

public ScrollPane.ScrollBarPolicy getHorizontalScrollBarPolicy()

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(ScrollPane.ScrollBarPolicy horizontalScrollBarPolicy)

getVerticalScrollBarPolicy

public ScrollPane.ScrollBarPolicy getVerticalScrollBarPolicy()

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(ScrollPane.ScrollBarPolicy verticalScrollBarPolicy)

getRowHeader

public Component getRowHeader()

setRowHeader

public void setRowHeader(Component rowHeader)

getColumnHeader

public Component getColumnHeader()

setColumnHeader

public void setColumnHeader(Component columnHeader)

getCorner

public Component getCorner()

setCorner

public void setCorner(Component corner)

remove

public Sequence<Component> remove(int index,
                                  int count)

Description copied from class: Viewport

This method should not be called to remove child components from the Viewport because the viewable child(ren) are set by the Viewport.setView(org.apache.pivot.wtk.Component) method instead. Any attempt to remove the "view" component with this method will result in an exception.

Specified by:

remove in interface Sequence<Component>

Overrides:

remove in class Viewport

Parameters:

index - The starting index to remove.

count - The number of items to remove, beginning with index.

Returns:

A sequence containing the items that were removed.

getScrollPaneListeners

public ListenerList<ScrollPaneListener> getScrollPaneListeners()