com.goldencode.p2j.ui.client.widget

Class AbstractScrollBar

java.lang.Object

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

com.goldencode.p2j.ui.client.widget.LightweightWidget

com.goldencode.p2j.ui.client.widget.GenericWidget

com.goldencode.p2j.ui.client.widget.AbstractScrollBar

All Implemented Interfaces:

ModelChangeListener, Widget<GuiOutputManager>, WidgetWithConfig<BaseConfig>, ConfigOwner<BaseConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

HScrollBar, VScrollBar

abstract class AbstractScrollBar
extends GenericWidget
implements ModelChangeListener

Common ancestor for horizontal and vertical scroll bars.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractScrollBar.Part Enumerate all possible mouse positions in the widget area.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractScrollBar.Part	autoScrollPart The part the mouse was last time autoscroll started.
private boolean	autoScrollSuspend Flag used to temporary suspend auto repeat scrolling feature.
protected NativeRectangle	highLightedRect If not null, the bounding rectangle of currently highlighted part, this rectangle must be invalidated when highlighted part or thumb position changes.
protected AbstractScrollBar.Part	lastHoverPart The part the mouse was last time hovered over.
protected int	lastModelPos Last pressed mouse model position.
protected int	lastMousePos Last pressed mouse position along the scrolling direction.
protected AbstractScrollBar.Part	lastPressedPart The part the mouse was last time pressed in.
protected ScrollModel	model The scroll model
private static int[]	MOUSE_ACTIONS Mouse actions this widget is interested
private boolean	pressed Mouse pressed indicator.
private ScrollbarExecutor	scrollbarExecutor Executor for handling mouse input.
private int	targetWndId The window ID to send auto scroll mouse messages.
private ThinClient	tcInst The client instance to use for sending auto scroll mouse messages.
private TopLevelWindow<?>	tlwOwner The top level owner window.

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

config

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

insets, listeners, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
AbstractScrollBar(ScrollModel model) The (only) constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy this widget.
protected abstract void	doDraw(GuiDriver<?,?> gd, GuiColorResolver gc) Draw widget using the prepared driver and color resolver.
void	draw() Draw widget.
Widget<GuiOutputManager>	findMouseSource(NativePoint p) Find the widget positioned just below the specified mouse position (in physical units).
protected void	handleMouseDragExt(java.awt.event.MouseEvent e) Checks if the mouse left or get back to the scrollbar during grag.
protected static int	minLength() Get the scrollbar minimum length along the scrolling direction.
protected static int	minWidth() Get the scrollbar minimum height.
void	modelChanged(Model m) This method is called by the model after it was changed.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mouseEntered(java.awt.event.MouseEvent e) Notification of a mouse entered event occurred for this widget.
void	mouseExited(java.awt.event.MouseEvent e) Notification of a mouse exited event occurred for this widget.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved event occurred for this widget.
void	mousePressed(java.awt.event.MouseEvent e) Notification of a mouse pressed event occurred for this widget.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event occurred for this widget.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
private void	stopAutoScroll() Stops possibly running autoscroll feture in some conditions.
protected abstract void	updateMouseHitInfo(int x, int y) Update the lastHoverPart and highLightedRect field values when the mouse position changes.
private void	updatePart(java.awt.event.MouseEvent e) Repaint parts according to their highlight and pressed status when mouse position changes.

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

afterConfigUpdate, config, height, initialize, setSize, width

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

dimension, minimumSize

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, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, focusTraversable, 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, insets, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseClicked, mouseDragged, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectAncestorChange, reflectLocationChanged, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unrealize, unregisterWidgetListener, updateSizeWorker, updateSystemParent, widgetRealized, widgetStateChanged, 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.Widget

acceptsEscAsAnyKey, acceptTrigger, canMovetoTop, completeTrigger, defaultMousePtr, enforceDefaultMousePtr, getIdForTrigger, getLegacyWidget, getTriggerWidget, getTriggerWidget, hasFocus, ignoreEnable, isCurrent, isDirectManipulable, isDroppable, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, maySwitchFocus, parent, refreshWidget, requestFocus, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

Field Detail

highLightedRect

protected NativeRectangle highLightedRect

If not null, the bounding rectangle of currently highlighted part, this rectangle must be invalidated when highlighted part or thumb position changes.

lastHoverPart

protected AbstractScrollBar.Part lastHoverPart

The part the mouse was last time hovered over.

lastModelPos

protected int lastModelPos

Last pressed mouse model position. Used to calculate drag amount.

lastMousePos

protected int lastMousePos

Last pressed mouse position along the scrolling direction. Used to calculate the drag amount.

lastPressedPart

protected AbstractScrollBar.Part lastPressedPart

The part the mouse was last time pressed in.

model

protected ScrollModel model

The scroll model

MOUSE_ACTIONS

private static final int[] MOUSE_ACTIONS

Mouse actions this widget is interested

scrollbarExecutor

private ScrollbarExecutor scrollbarExecutor

Executor for handling mouse input.

pressed

private volatile boolean pressed

Mouse pressed indicator.

autoScrollSuspend

private volatile boolean autoScrollSuspend

Flag used to temporary suspend auto repeat scrolling feature.

tlwOwner

private TopLevelWindow<?> tlwOwner

The top level owner window.

targetWndId

private int targetWndId

The window ID to send auto scroll mouse messages.

tcInst

private ThinClient tcInst

The client instance to use for sending auto scroll mouse messages.

autoScrollPart

protected AbstractScrollBar.Part autoScrollPart

The part the mouse was last time autoscroll started.

Constructor Detail

AbstractScrollBar

public AbstractScrollBar(ScrollModel model)

The (only) constructor.

Method Detail

minLength

protected static final int minLength()

Get the scrollbar minimum length along the scrolling direction.

Returns:

see above

minWidth

protected static final int minWidth()

Get the scrollbar minimum height.

Returns:

see above

destroy

public void destroy()

Destroy this widget. Notify all listeners about the widget being destroyed.

Specified by:

destroy in interface Widget<GuiOutputManager>

Overrides:

destroy in class AbstractWidget<GuiOutputManager>

draw

public void draw()

Draw widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractWidget<GuiOutputManager>

findMouseSource

public Widget<GuiOutputManager> findMouseSource(NativePoint p)

Find the widget positioned just below the specified mouse position (in physical units). Since this is the only widget, always return this.

Specified by:

findMouseSource in interface Widget<GuiOutputManager>

Overrides:

findMouseSource in class AbstractWidget<GuiOutputManager>

Parameters:

p - The mouse physical location.

Returns:

A widget over which the mouse is positioned or null if none found.

modelChanged

public void modelChanged(Model m)

This method is called by the model after it was changed.

Specified by:

modelChanged in interface ModelChangeListener

Parameters:

m - the model that was changed

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Notification of a mouse entered event occurred for this widget.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Notification of a mouse exited event occurred for this widget.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Notification of a mouse moved event occurred for this widget.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Notification of a mouse pressed event occurred for this widget. No-op by default.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Notification of a mouse released event occurred for this widget.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Notification of a mouse wheel moved event occurred for this widget. No-op by default.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

doDraw

protected abstract void doDraw(GuiDriver<?,?> gd,
                               GuiColorResolver gc)

Draw widget using the prepared driver and color resolver.

Parameters:

gd - the driver

gc - the color resolver.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

updateMouseHitInfo

protected abstract void updateMouseHitInfo(int x,
                                           int y)

Update the lastHoverPart and highLightedRect field values when the mouse position changes.

Parameters:

x - the X coordinate

y - the Y coordinate

handleMouseDragExt

protected void handleMouseDragExt(java.awt.event.MouseEvent e)

Checks if the mouse left or get back to the scrollbar during grag. The auto repeat for scrolling should work only if the mouse is over scroll bar.

Parameters:

e - The mouse event.

stopAutoScroll

private void stopAutoScroll()

Stops possibly running autoscroll feture in some conditions.

updatePart

private void updatePart(java.awt.event.MouseEvent e)

Repaint parts according to their highlight and pressed status when mouse position changes.

Parameters:

e - the mouse event with the mouse position.