com.goldencode.p2j.ui.client.gui

Class DriverWidgetHost<C extends BaseConfig>

java.lang.Object

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

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

com.goldencode.p2j.ui.client.gui.DriverWidgetHost<C>

All Implemented Interfaces:

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

Direct Known Subclasses:

HtmlBrowserGuiImpl, SignatureClientGuiImpl, SpreadsheetGuiImpl

public abstract class DriverWidgetHost<C extends BaseConfig>
extends AbstractContainer<GuiOutputManager>
implements WidgetWithConfig<C>

Base driver widget host class.

Field Summary

Fields

Modifier and Type	Field and Description
private C	config Associated config instance
private boolean	destroyed Flag indicating the widget has been destroyed, so consume any other posted events.
private GuiColorResolver	gc Color resolver
protected GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private WidgetId	id Widget id
private NativeRectangle	lastViewport Bounds of the last calculated viewport
private boolean	lastVisible
private boolean	placeWidget Flag indicating the widget needs to be placed (as its location has changed).
private boolean	sensitivityChanged Flag indicating the widget's sensitivity has changed.
private boolean	updateLocationScheduled Indicates location update is scheduled
private WindowSizeMoveListener	windowSizeMoveListener Window size-move listener

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
DriverWidgetHost(WidgetId id, C cfg) Construtor.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(C beforeUpdate) The method is called after the configuration associated with the owner changes.
private NativeRectangle	calcViewport() Calculates the widget's visible area on the window screen.
C	config() Get externalizable widget config which can be used to restore widget state after via network.
Widget<GuiOutputManager>	currentFocus() Gets the widget currently having focus within curent container.
void	destroy() Destroy this widget.
void	draw() Draw the widget.
boolean	focusTraversable() Checks if the current container support focus traversing.
WidgetId	getId() Widget ID.
double	height() Get widget height.
void	initialize(WidgetId id, C 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	isTotallyObscured() Check if widget is totally obscured.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	processKeyEvent(KeyInput event) Process key event.
void	reflectAncestorChange() Called when any of the widget's ancestors gets re-assigned.
void	reflectLocationChanged() Called when the widget's location changes.
private void	scheduleUpdateLocationState() Schedules update of location and visibility state with the GUI driver.
void	triggerEvent(byte eventId, byte[] paramsData) Called by the driver to notify about a triggered high-level widget specific event.
private void	updateLocationState() Updates location and visibility state with the GUI driver.
void	webMessageHandler(java.lang.String url, java.lang.String data) The method is called when a message is sent by the JS side of the driver widget.
void	widgetContentLoaded(java.lang.String url) Called when the driver widget has fully loaded at the JS side.
void	widgetStateChanged() Notification that this widget's state has changed (visibility, sensitivity, z-order).
double	width() Get widget width.

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

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

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, 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, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isVisible, isVisible, location, manageSystemActions, 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, 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, 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, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, 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, 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

id

private WidgetId id

Widget id

config

private C extends BaseConfig config

Associated config instance

gd

protected GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

gc

private GuiColorResolver gc

Color resolver

placeWidget

private boolean placeWidget

Flag indicating the widget needs to be placed (as its location has changed).

sensitivityChanged

private boolean sensitivityChanged

Flag indicating the widget's sensitivity has changed.

destroyed

private boolean destroyed

Flag indicating the widget has been destroyed, so consume any other posted events.

windowSizeMoveListener

private WindowSizeMoveListener windowSizeMoveListener

Window size-move listener

lastViewport

private NativeRectangle lastViewport

Bounds of the last calculated viewport

lastVisible

private boolean lastVisible

updateLocationScheduled

private boolean updateLocationScheduled

Indicates location update is scheduled

Constructor Detail

DriverWidgetHost

public DriverWidgetHost(WidgetId id,
                        C cfg)

Construtor.

Parameters:

id - Widget id.

cfg - Config instance.

Method Detail

initialize

public void initialize(WidgetId id,
                       C 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<C extends BaseConfig>

Parameters:

id - The widget's ID.

cfg - Config instance.

getId

public WidgetId getId()

Widget ID.

Specified by:

getId in interface Widget<GuiOutputManager>

Overrides:

getId in class AbstractWidget<GuiOutputManager>

Returns:

see above.

config

public C config()

Get externalizable widget config which can be used to restore widget state after via network.

Note that only very limited set of widgets actually have config. By default widget has no config.

Specified by:

config in interface Widget<GuiOutputManager>

Specified by:

config in interface ConfigOwner<C extends BaseConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

Reference to widget config.

afterConfigUpdate

public void afterConfigUpdate(C beforeUpdate)

The method is called after the configuration associated with the owner 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 change.

The implemented logic must be idempotent - the method must produce the same results if executed once or multiple times not relying on any particular call sequence or related state. This is necessary so that the method can be repeated or retried as often as necessary without causing unintended effects

Specified by:

afterConfigUpdate in interface ConfigOwner<C extends BaseConfig>

Parameters:

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

width

public double width()

Get widget width.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class AbstractContainer<GuiOutputManager>

Returns:

widget width.

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class AbstractContainer<GuiOutputManager>

Returns:

widget height.

reflectLocationChanged

public void reflectLocationChanged()

Called when the widget's location changes. This allows the subclasses to react on this, for example by notifying the driver.

Overrides:

reflectLocationChanged in class AbstractContainer<GuiOutputManager>

reflectAncestorChange

public void reflectAncestorChange()

Called when any of the widget's ancestors gets re-assigned.

Overrides:

reflectAncestorChange in class AbstractContainer<GuiOutputManager>

widgetStateChanged

public void widgetStateChanged()

Notification that this widget's state has changed (visibility, sensitivity, z-order).

Specified by:

widgetStateChanged in interface Widget<GuiOutputManager>

Overrides:

widgetStateChanged in class AbstractContainer<GuiOutputManager>

isTotallyObscured

public boolean isTotallyObscured()

Check if widget is totally obscured.

Specified by:

isTotallyObscured in interface Widget<GuiOutputManager>

Overrides:

isTotallyObscured in class AbstractWidget<GuiOutputManager>

Returns:

true if widget is totally obscured.

destroy

public void destroy()

Destroy this widget. Notify all of its components that the widget has been destroyed.

Specified by:

destroy in interface Widget<GuiOutputManager>

Overrides:

destroy in class AbstractContainer<GuiOutputManager>

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class AbstractContainer<GuiOutputManager>

Parameters:

event - Key event to process.

draw

public void draw()

Draw the widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class AbstractContainer<GuiOutputManager>

triggerEvent

public void triggerEvent(byte eventId,
                         byte[] paramsData)

Called by the driver to notify about a triggered high-level widget specific event.

Parameters:

eventId - Event id.

paramsData - Parameters data.

webMessageHandler

public void webMessageHandler(java.lang.String url,
                              java.lang.String data)

The method is called when a message is sent by the JS side of the driver widget.

Parameters:

url - The message URL. Specific to the concrete driver widget.

data - The message data. Specific to the concrete driver widget.

widgetContentLoaded

public void widgetContentLoaded(java.lang.String url)

Called when the driver widget has fully loaded at the JS side.

Parameters:

url - The URL of the content of the driver widget.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

currentFocus

public Widget<GuiOutputManager> currentFocus()

Gets the widget currently having focus within curent container.

Specified by:

currentFocus in interface Container<GuiOutputManager>

Overrides:

currentFocus in class AbstractContainer<GuiOutputManager>

Returns:

currently focused widget.

focusTraversable

public boolean focusTraversable()

Checks if the current container support focus traversing.

Specified by:

focusTraversable in interface Widget<GuiOutputManager>

Overrides:

focusTraversable in class AbstractContainer<GuiOutputManager>

Returns:

true if focus traversable in this container.

calcViewport

private NativeRectangle calcViewport()

Calculates the widget's visible area on the window screen. For empty area the method returns null.

Returns:

the calculated bounds.

scheduleUpdateLocationState

private void scheduleUpdateLocationState()

Schedules update of location and visibility state with the GUI driver.

updateLocationState

private void updateLocationState()

Updates location and visibility state with the GUI driver.