com.goldencode.p2j.ui.client

Class ScrollPane<O extends OutputManager<?>>

java.lang.Object

com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

com.goldencode.p2j.ui.client.widget.AbstractContainer<O>

com.goldencode.p2j.ui.client.ScrollPane<O>

All Implemented Interfaces:

ScrollListener, Container<O>, Widget<O>, WidgetWithConfig<BaseConfig>, ConfigOwner<BaseConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ScrollPaneGuiImpl, ScrollPaneImpl

public abstract class ScrollPane<O extends OutputManager<?>>
extends AbstractContainer<O>
implements WidgetWithConfig<BaseConfig>, ScrollListener

This is the top-level component for the widget scrolling feature. The class holds and manages several sub-components that together provide the scrolling support. These are a so-called viewport - Viewport - scroll bars and ScrollableWidget. Scroll bars provide a visual feedback of the scroll state, viewport marks the visible portion of ScrollableWidget, the widget being scrolled. The class also functions as the scroll event hub, it makes sure the events are dispatched by the right sub-components.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseConfig	config Attribute container.
private java.lang.String	label New label to be used with this container.
protected BorderedPanel<O>	rootPanel The root panel, holds border, contains scroll bars and viewport.
private Viewport<O>	viewport View port for the visible part of the pane.

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
ScrollPane(ScrollableWidget<O> widget) Create a ScrollPane that displays the contents of the specified widget.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(BaseConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
protected double	calcHscroll(Dimension childSize, Dimension extentSize, Point viewPosition) Calculate horizontal thumbnail position.
Dimension	calcInitialViewportSize() Calculates and returns initial viewport size.
protected double	calcVscroll(Dimension childSize, Dimension extentSize, Point viewPosition) Calculate vertical thumbnail position.
BaseConfig	config() Provide access to the attributes stored in the widget.
void	doLayout() Lay out container.
abstract void	draw() The main renderer for this container.
abstract void	draw(Widget<O>[] list) The secondary renderer for this container.
Border<O>	getBorder() Get the effective border implementation.
Widget<O>	getChild() Getting the wrapped component from the scroll pane.
BorderedPanel<O>	getRootPanel() Get the root panel.
void	handleScrollEvent(ScrollEvent event) This method is invoked when scroll pane is scrolled.
void	initialize(WidgetId id, BaseConfig cfg) Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
boolean	isFocusable() Checks whether this attribute container can receive focus generally.
Dimension	minimumSize() Get widget minimum size.
void	setBorder(Border<O> border) Set a border implementation.
void	setLocation(Point point) Setting the location of this component.
void	setScrollBars(ScrollBar.Bars bars) Set container scroll bars.
void	setSize(double width, double height) Set container size.
Viewport<O>	viewport() Get pane viewport.

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, destroy, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, processKeyEvent, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseActions, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

widgetsAsList

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

rootPanel

protected BorderedPanel<O extends OutputManager<?>> rootPanel

The root panel, holds border, contains scroll bars and viewport.

viewport

private Viewport<O extends OutputManager<?>> viewport

View port for the visible part of the pane.

label

private java.lang.String label

New label to be used with this container.

config

protected BaseConfig config

Attribute container.

Constructor Detail

ScrollPane

public ScrollPane(ScrollableWidget<O> widget)

Create a ScrollPane that displays the contents of the specified widget.

Parameters:

widget - The widget to be displayed. This widget must implement the ScrollPublisher interface.

Method Detail

getRootPanel

public BorderedPanel<O> getRootPanel()

Get the root panel.

Returns:

the rootPanel.

initialize

public void initialize(WidgetId id,
                       BaseConfig cfg)

Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.

This API is called after the widget is created and added to the registry.

Specified by:

initialize in interface WidgetWithConfig<BaseConfig>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public BaseConfig config()

Provide access to the attributes stored in the widget.

Specified by:

config in interface Widget<O extends OutputManager<?>>

Specified by:

config in interface ConfigOwner<BaseConfig>

Overrides:

config in class AbstractWidget<O extends OutputManager<?>>

Returns:

Reference to attribute container.

afterConfigUpdate

public void afterConfigUpdate(BaseConfig beforeUpdate)

The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.

Specified by:

afterConfigUpdate in interface ConfigOwner<BaseConfig>

Parameters:

beforeUpdate - Config reference capturing the config state before the owner's config was modified.

draw

public abstract void draw()

The main renderer for this container. Draws the child container and vertical/horizontal scroll-bars as necessary.

Specified by:

draw in interface Widget<O extends OutputManager<?>>

Overrides:

draw in class AbstractContainer<O extends OutputManager<?>>

draw

public abstract void draw(Widget<O>[] list)

The secondary renderer for this container. Draws the child container and vertical/horizontal scroll-bars as necessary. Note that this routine assumes that it is invoked from Frame class.

Parameters:

list - Array of components to draw.

getChild

public Widget<O> getChild()

Getting the wrapped component from the scroll pane. Used for the selection list widget to request the widget handle.

Returns:

The handle of the component wrapped by the scroll pane.

isFocusable

public boolean isFocusable()

Checks whether this attribute container can receive focus generally.

Specified by:

isFocusable in interface Widget<O extends OutputManager<?>>

Overrides:

isFocusable in class AbstractWidget<O extends OutputManager<?>>

Returns:

true if this container can be focused under certain conditions. false if, and only if, this attribute container can never receive focus.

minimumSize

public Dimension minimumSize()

Get widget minimum size.

Specified by:

minimumSize in interface Widget<O extends OutputManager<?>>

Overrides:

minimumSize in class AbstractContainer<O extends OutputManager<?>>

Returns:

widget minimum size.

handleScrollEvent

public void handleScrollEvent(ScrollEvent event)

This method is invoked when scroll pane is scrolled.

Specified by:

handleScrollEvent in interface ScrollListener

Parameters:

event - Event which triggered this call.

setLocation

public void setLocation(Point point)

Setting the location of this component.

Specified by:

setLocation in interface Widget<O extends OutputManager<?>>

Overrides:

setLocation in class AbstractWidget<O extends OutputManager<?>>

Parameters:

point - The Point object to be used as the new location of the container.

setSize

public void setSize(double width,
                    double height)

Set container size.

Specified by:

setSize in interface Container<O extends OutputManager<?>>

Overrides:

setSize in class AbstractContainer<O extends OutputManager<?>>

Parameters:

width - New width.

height - New height.

viewport

public Viewport<O> viewport()

Get pane viewport.

Returns:

pane viewport.

getBorder

public Border<O> getBorder()

Get the effective border implementation.

Returns:

A Border reference, never null.

setBorder

public void setBorder(Border<O> border)

Set a border implementation.

Parameters:

border - A Border reference or null to clear the border.

doLayout

public void doLayout()

Lay out container.

Specified by:

doLayout in interface Container<O extends OutputManager<?>>

Overrides:

doLayout in class AbstractContainer<O extends OutputManager<?>>

calcInitialViewportSize

public Dimension calcInitialViewportSize()

Calculates and returns initial viewport size. The method doesn't consider scroll bars and always returns the full viewport size.

Returns:

Initial viewport dimension.

calcHscroll

protected double calcHscroll(Dimension childSize,
                             Dimension extentSize,
                             Point viewPosition)

Calculate horizontal thumbnail position.

Parameters:

childSize - The size of the child pane.

extentSize - The size of the viewport.

viewPosition - The current view position.

Returns:

The horizontal thumbnail position.

calcVscroll

protected double calcVscroll(Dimension childSize,
                             Dimension extentSize,
                             Point viewPosition)

Calculate vertical thumbnail position.

Parameters:

childSize - The size of the child pane.

extentSize - The size of the viewport.

viewPosition - The current view position.

Returns:

The vertical thumbnail position.

setScrollBars

public void setScrollBars(ScrollBar.Bars bars)

Set container scroll bars.

Parameters:

bars - Scroll bars.