com.goldencode.p2j.ui.client.gui

Class LabelGuiImpl

java.lang.Object

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

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

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

com.goldencode.p2j.ui.client.ClientDrivenLabel<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.LabelGuiImpl

All Implemented Interfaces:

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

public class LabelGuiImpl
extends ClientDrivenLabel<GuiOutputManager>

Implementation for a widget's LABEL, in a GUI client.

Field Summary

Fields

Modifier and Type	Field and Description
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver

Fields inherited from class com.goldencode.p2j.ui.client.ClientDrivenLabel

config, disableEmptyMode, emptyMode, offset, rightAligned, sideWidget, underlined

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
LabelGuiImpl(WidgetId id, ClientDrivenLabel<GuiOutputManager> labelInstance, int frameId) Create a copy of the label.
LabelGuiImpl(WidgetId id, java.lang.String text, int frameId) Constructs label with given text.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(LabelConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
void	draw() Draws text.
double	height() Compute the label's height.
void	initialize(WidgetId id, LabelConfig 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	isDirectManipulable() Check the direct manipulation capability of the widget.
protected int	nativeHeight() Retrieve the widget's height in native units.
protected int	nativeWidth() Retrieve the widget's width in native units.
NativeDimension	physicalDimension() Get widget physical dimension, expressed in units native to UI type.
double	width() Compute the label's width.

Methods inherited from class com.goldencode.p2j.ui.client.ClientDrivenLabel

_setVisible, config, drawCaret, focusTraversable, getLegacyWidget, getSideWidget, isDelimiter, isFocusable, isForcedSize, isRightAligned, isUnderlined, linkTo, name, postprocessConfig, postprocessConfig, setDelimiter, setEmptyModeOff, setEmptyModeOn, setForcedSize, setHeight, setName, setOffset, setRightAligned, setSideWidget, setSize, setUnderlined, setWidth, updateSize

Methods inherited from class com.goldencode.p2j.ui.client.FixedSizeContainer

minimumSize, requestFocus, requestFocus

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, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, 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, setFocus, setFocusInt, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setTabItemList, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged

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

_setHidden, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, 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, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalLocation, 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.Label

label

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, destroy, dimension, displayPhysicalLocation, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, 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, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, 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

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

widgetsAsList

Field Detail

gf

private GuiFontResolver gf

Font resolver

gd

private GuiDriver gd

Screen driver

Constructor Detail

LabelGuiImpl

public LabelGuiImpl(WidgetId id,
                    ClientDrivenLabel<GuiOutputManager> labelInstance,
                    int frameId)

Create a copy of the label.

Parameters:

id - The widget's ID.

labelInstance - Label to copy parameters from.

frameId - The ID of the frame to which the label belongs, or -1 if unknown at the time of the creation.

LabelGuiImpl

public LabelGuiImpl(WidgetId id,
                    java.lang.String text,
                    int frameId)

Constructs label with given text.

Parameters:

id - The widget's ID.

text - Initial text.

frameId - The ID of the frame to which the label belongs, or -1 if unknown at the time of the creation.

Method Detail

nativeWidth

protected int nativeWidth()

Retrieve the widget's width in native units. TODO: this is duplicated in FrameGuiImpl.getLabelWidth(java.lang.String, com.goldencode.p2j.ui.client.LabeledWidget<com.goldencode.p2j.ui.client.gui.driver.GuiOutputManager>), fix this.

Specified by:

nativeWidth in class ClientDrivenLabel<GuiOutputManager>

Returns:

See above.

nativeHeight

protected int nativeHeight()

Retrieve the widget's height in native units. TODO: this is duplicated in FrameGuiImpl.getLabelHeight(java.lang.String, com.goldencode.p2j.ui.client.LabeledWidget<com.goldencode.p2j.ui.client.gui.driver.GuiOutputManager>, boolean), fix this.

Specified by:

nativeHeight in class ClientDrivenLabel<GuiOutputManager>

Returns:

See above.

initialize

public void initialize(WidgetId id,
                       LabelConfig 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<LabelConfig>

Overrides:

initialize in class ClientDrivenLabel<GuiOutputManager>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

width

public double width()

Compute the label's width.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class AbstractContainer<GuiOutputManager>

Returns:

See above.

height

public double height()

Compute the label's height.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class AbstractContainer<GuiOutputManager>

Returns:

See above.

draw

public void draw()

Draws text.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class ClientDrivenLabel<GuiOutputManager>

physicalDimension

public NativeDimension physicalDimension()

Get widget physical dimension, expressed in units native to UI type.

Specified by:

physicalDimension in interface Widget<GuiOutputManager>

Overrides:

physicalDimension in class AbstractWidget<GuiOutputManager>

Returns:

widget dimension.

afterConfigUpdate

public void afterConfigUpdate(LabelConfig 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.

For a side-label (is set, if its X or COLUMN coordinate is set before it gets realized, it must adjust for the COLON-ALIGNED mode.

Specified by:

afterConfigUpdate in interface ConfigOwner<LabelConfig>

Overrides:

afterConfigUpdate in class ClientDrivenLabel<GuiOutputManager>

Parameters:

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

isDirectManipulable

public boolean isDirectManipulable()

Check the direct manipulation capability of the widget. LABEL widget does not allow direct manipulation. Except the case it is selected programmatically.

Specified by:

isDirectManipulable in interface Widget<GuiOutputManager>

Overrides:

isDirectManipulable in class ClientDrivenLabel<GuiOutputManager>

Returns:

TRUE if the widget is able to be directly manipulated, FALSE otherwise.