com.goldencode.p2j.ui.client

Class LabeledDataContainer<O extends OutputManager<?>,C extends ControlTextConfig>

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.LabeledDataContainer<O,C>

All Implemented Interfaces:

DataContainer, LabeledWidget<O>, MnemonicTrait<O>, Container<O>, Widget<O>, WidgetWithConfig<C>, ConfigOwner<C>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

Editor, FillIn

public abstract class LabeledDataContainer<O extends OutputManager<?>,C extends ControlTextConfig>
extends FixedSizeContainer<O>
implements WidgetWithConfig<C>, LabeledWidget<O>, DataContainer, MnemonicTrait<O>

Common implementation of LabeledWidget interface for FillIn and Editor.

Version:

1.0

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
private MnemonicInfo	columnMnemonic Column mnemonic information
protected C	config Component attribute container
private MnemonicInfo	mnemonic Mnemonic information
private Label<O>	sideLabel Component label.
private boolean	wasVisible Flag indicating the widget was made visible at least once.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
LabeledDataContainer()

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(C beforeUpdate) The method is called after the configuration associated with the implementor changes.
C	config() Provide access to the attributes stored in the widget.
protected void	copyState(Widget<?> w) Copy the widget state from the specified source widget to this instance.
java.util.Optional<MousePtrWrapper>	defaultMousePtr() Get default mouse pointer for this widget
void	destroy() Destroy this widget.
double	getColon() Return current value of COLON attribute.
java.lang.String	getColumnLabelText() Return text of the column label.
MnemonicInfo	getColumnMnemonic() Column MnemonicInfo instance getter.
Label<O>	getLabelInstance() Return reference to the instance of the Label attached to the widget.
java.lang.String	getLabelText() Return text of the label.
MnemonicInfo	getMnemonic() MnemonicInfo instance getter.
double	getTo() Return current value of TO attribute.
boolean	isForceLabel() Get current state of flag which is forces presence of the label regardless from the frame NO-LABELS option.
boolean	isModified() Getting the modification state of the widget.
boolean	isNoLabels() Get current state of NO-LABELS flag.
boolean	isRightAligned() Get widget alignment policy.
void	postprocessConfig() Additional processing required when widget configuration is updated AFTER the frame layout has been performed.
void	setColumnMnemonic(MnemonicInfo mnemonic) Column MnemonicInfo instance setter.
abstract boolean	setCursorOffset(int offset, boolean shouldInvalidateSelection) Sets the cursor offset.
void	setHidden(boolean hidden) Tracks the hidden state of the widget and attached label.
void	setLabelInstance(Label<O> label) Assign new instance of Label to the fill-in widget.
void	setMnemonic(MnemonicInfo mnemonic) MnemonicInfo instance setter.
void	setNoLabels(boolean labels) Force NO-LABELS flag.
void	setVisible(boolean visible) Shows or hides the widget and attached label.
void	setWasVisible() Remember the widget was made visible at least once.
boolean	wasVisible() Checking if the widget was made visible at least once.

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, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, detach, dimension, doLayout, draw, 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, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, 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, isFocusable, 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, 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, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, 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.WidgetWithConfig

initialize

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, dimension, displayPhysicalLocation, draw, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, 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, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, width, 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.DataContainer

getChangedValue, getText, getValue, setValue

Methods inherited from interface com.goldencode.p2j.ui.client.MnemonicTrait

createMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

widgetsAsList

Field Detail

sideLabel

private Label<O extends OutputManager<?>> sideLabel

Component label.

wasVisible

private boolean wasVisible

Flag indicating the widget was made visible at least once.

config

protected C extends ControlTextConfig config

Component attribute container

mnemonic

private MnemonicInfo mnemonic

Mnemonic information

columnMnemonic

private MnemonicInfo columnMnemonic

Column mnemonic information

Constructor Detail

LabeledDataContainer

public LabeledDataContainer()

Method Detail

config

public C 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<C extends ControlTextConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

public void afterConfigUpdate(C 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<C extends ControlTextConfig>

Parameters:

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

getColon

public double getColon()

Return current value of COLON attribute.

Specified by:

getColon in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current value of the attribute.

getColumnLabelText

public java.lang.String getColumnLabelText()

Return text of the column label.

Specified by:

getColumnLabelText in interface LabeledWidget<O extends OutputManager<?>>

Returns:

text of the column label.

getLabelInstance

public Label<O> getLabelInstance()

Return reference to the instance of the Label attached to the widget.

Specified by:

getLabelInstance in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Reference to Label instance.

getLabelText

public java.lang.String getLabelText()

Return text of the label.

Specified by:

getLabelText in interface LabeledWidget<O extends OutputManager<?>>

Returns:

text of the label.

getTo

public double getTo()

Return current value of TO attribute.

Specified by:

getTo in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current value of the attribute.

isForceLabel

public boolean isForceLabel()

Get current state of flag which is forces presence of the label regardless from the frame NO-LABELS option.

Specified by:

isForceLabel in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current state of the flag.

isNoLabels

public boolean isNoLabels()

Get current state of NO-LABELS flag.

Specified by:

isNoLabels in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current state of the flag.

isRightAligned

public boolean isRightAligned()

Get widget alignment policy.

Specified by:

isRightAligned in interface LabeledWidget<O extends OutputManager<?>>

Returns:

true if widget is formatted for right alignment.

setLabelInstance

public void setLabelInstance(Label<O> label)

Assign new instance of Label to the fill-in widget.

Specified by:

setLabelInstance in interface LabeledWidget<O extends OutputManager<?>>

Parameters:

label - Reference to new Label instance.

setNoLabels

public void setNoLabels(boolean labels)

Force NO-LABELS flag.

Specified by:

setNoLabels in interface LabeledWidget<O extends OutputManager<?>>

Parameters:

labels - New value of the flag.

setVisible

public void setVisible(boolean visible)

Shows or hides the widget and attached label.

Specified by:

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

Overrides:

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

Parameters:

visible - true to make the widget visible, false to hide the widget.

setHidden

public void setHidden(boolean hidden)

Tracks the hidden state of the widget and attached label.

Specified by:

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

Overrides:

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

Parameters:

hidden - New hidden state.

isModified

public boolean isModified()

Getting the modification state of the widget.

Specified by:

isModified in interface DataContainer

Returns:

true if the widget value was modified, false otherwise.

wasVisible

public boolean wasVisible()

Checking if the widget was made visible at least once.

Specified by:

wasVisible in interface LabeledWidget<O extends OutputManager<?>>

Returns:

true if the widget was visible, false otherwise.

setWasVisible

public void setWasVisible()

Remember the widget was made visible at least once.

Specified by:

setWasVisible in interface LabeledWidget<O extends OutputManager<?>>

postprocessConfig

public void postprocessConfig()

Additional processing required when widget configuration is updated AFTER the frame layout has been performed.

Specified by:

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

Overrides:

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

destroy

public void destroy()

Destroy this widget.

Specified by:

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

Overrides:

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

defaultMousePtr

public java.util.Optional<MousePtrWrapper> defaultMousePtr()

Get default mouse pointer for this widget

Specified by:

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

Returns:

MousePtr or Optional.empty() if one is inherited from the enclosing frame

getMnemonic

public MnemonicInfo getMnemonic()

MnemonicInfo instance getter.

The implementors should simply return the value of the mnemonic class field. No additional processing logic is advised.

Specified by:

getMnemonic in interface MnemonicTrait<O extends OutputManager<?>>

Returns:

See above.

setMnemonic

public void setMnemonic(MnemonicInfo mnemonic)

MnemonicInfo instance setter.

The implementors should simply assign the parameter value to the mnemonic class field. No additional processing logic is advised.

Specified by:

setMnemonic in interface MnemonicTrait<O extends OutputManager<?>>

Parameters:

mnemonic - Mnemonic info.

getColumnMnemonic

public MnemonicInfo getColumnMnemonic()

Column MnemonicInfo instance getter.

The implementors should simply return the value of the mnemonic class field. No additional processing logic in the implemented method is advised.

The method will return a valid value when the implementing widget supports column label.

Specified by:

getColumnMnemonic in interface MnemonicTrait<O extends OutputManager<?>>

Returns:

See above.

setColumnMnemonic

public void setColumnMnemonic(MnemonicInfo mnemonic)

Column MnemonicInfo instance setter.

The implementors should simply assign the parameter value to the mnemonic class field. No additional processing logic in the implemented method is advised.

Specified by:

setColumnMnemonic in interface MnemonicTrait<O extends OutputManager<?>>

Parameters:

mnemonic - Mnemonic info.

setCursorOffset

public abstract boolean setCursorOffset(int offset,
                                        boolean shouldInvalidateSelection)

Sets the cursor offset.

Parameters:

offset - The new offset value.

shouldInvalidateSelection - The flag that shows if we should invalidate selection.

Returns:

true if the cursor offset is valid and set.

copyState

protected void copyState(Widget<?> w)

Copy the widget state from the specified source widget to this instance.

Overrides:

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

Parameters:

w - The source widget which state needs to be copied.