com.goldencode.p2j.ui.client.gui

Class EntryFieldGuiImpl

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>

com.goldencode.p2j.ui.client.FillIn<GuiOutputManager,FillInConfig>

com.goldencode.p2j.ui.client.gui.FillInGuiImpl

com.goldencode.p2j.ui.client.gui.EntryFieldGuiImpl

All Implemented Interfaces:

AutoResizable<FillInConfig>, DataContainer, EditableField, LightweightTextWidget, LabeledWidget<GuiOutputManager>, MnemonicTrait<GuiOutputManager>, TextSelection, Container<GuiOutputManager>, StreamableWidget, Widget<GuiOutputManager>, WidgetWithConfig<FillInConfig>, ConfigOwner<FillInConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class EntryFieldGuiImpl
extends FillInGuiImpl

Implementation of Progress entry field inside for GUI combo-box.

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.ui.client.gui.driver.LightweightTextWidget

LightweightTextWidget.TextLineSelection

Field Summary

Fields

Modifier and Type	Field and Description
private DisplayFormat	cbxFormat Local format used as alternative for comboboxes of other subtype tan DROP-DOWN-LIST.
private ComboBoxGuiImpl	comboBoxRef Reference to the possible combo-box object.
private boolean	focusTraversable Local focus traversable flag.
private GuiDriver	gd Screen driver
private static CentralLogger	LOG Logger

Fields inherited from class com.goldencode.p2j.ui.client.gui.FillInGuiImpl

disabledFore, disabledForeFixedColor

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

browseColumn, drawLine, editScroller, justActivated, leftAnchor, rightAnchor, selected, skipCursorActivation, useUnderline

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

config

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
EntryFieldGuiImpl(FillInConfig cfg, ComboBoxGuiImpl cbbRef) Special constructor used to restore component using given configuration.
EntryFieldGuiImpl(WidgetId id, FillInConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
void	display() Fills data structures from variable's value.
protected void	drawBorder(GuiColorResolver gcd, int x, int y, NativeDimension dim, boolean threeDBorder) Draws the border box around the fill-in.
void	drawCaret() Draws the caret.
protected NativeDimension	editableNativeDimension() Determine the portion of the widget's editable part.
boolean	enforceDefaultMousePtr() Check if the default mouse pointer should be used regardless of the parent settings
boolean	focusTraversable() Check if widget is focus traversable.
protected boolean	getDataEntryReturn() Convenience method to get access to SESSION:DATA-ENTRY-RETURN attribute.
Widget	getLegacyWidget() Get the legacy widget for this entry-field, its comboBoxRef.
protected Theme.TextLookAndFeel	getTextLookAndFeel(GuiColorResolver gcd, GuiColorResolver gce) Returns text look and feel for EntryFieldGuiImpl.
Widget	getTriggerWidget() For some virtual widgets, the widget where triggers are checked is different (i.e.
double	height() Get widget height.
void	initialize(WidgetId id, FillInConfig 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.
protected boolean	isTextSelectionDisplayed() Tests if the text selection is displayed.
boolean	isThreeD() The combo editor is never 3D.
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 clicked event occurred for this widget.
void	processKeyEvent(KeyInput ke) Process GUI specific keys for combo-box entry field: SE_VALUE_CHANGED - inform combo-box the value changed.
double	width() Get widget width.

Methods inherited from class com.goldencode.p2j.ui.client.gui.FillInGuiImpl

activate, adjustEditScroller, afterConfigUpdate, blankScreenValue, convertToStreamable, createLeftAnchor, createMnemonic, createRightAnchor, draw, drawCaretInt, drawCursor, focusAndSelect, getCursorColumnOffset, getCursorRowOffset, getFontCache, getInitialCursorPos, getInsertMode, getLastOffset, getNativeCursorPos, getScreenText, getScreenText, getScrollColumnOffset, getScrollRowOffset, getSelectedText, getTextSelection, getValidCursorPos, initSelection, invalidateSelection, isAutoResize, isCharacterInGui, isDroppable, isIntegerInGui, isRMBEntrySupported, isZapToBeApplied, mouseActions, mouseClicked, mouseDragged, mouseWheelMoved, moveCursorToLast, nativeHeight, nativeWidth, nativeWidth, processMnemonic, refresh, removeSelectedText, resetCaret, resetEditScroller, selectAll, setCursorOffset, setSelection, setSelection, showPopupMenu, supportsCustomMousePointer, updateCursorOffsetValue, updateSize

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

activate, adjustCursor, canMovetoTop, clear, clear, clear, clearWidget, copyState, currentFocus, defaultFocus, draw, fireValueChanged, getBrowse, getCurrentFormat, getCursorOffset, getDrawText, getEditScroller, getFirstInGroup, getFormat, getScreenValue, getText, getText, getTriggerWidget, getValue, getVariable, isAtField, isDrawLine, isFormatCheck, isInAutoReturn, isLeftEdgeWidget, isLinkedToBrowse, isPendingNoZap, isRightAligned, isRightAlignedInt, isRightEdgeWidget, isSelected, isSelectionValid, isZapActive, refresh, requestFocus, reset, setAttrFormat, setBrowseColumn, setCursorOffset, setDataType, setEnabled, setForceLeft, setForceRight, setFormatCheck, setHeaderParm, setInAutoReturn, setInsertMode, setPendingNoZap, setSize, setSkipCursorActivation, setTextGroup, setUnderline, setValue, setValue, setZapMode, setZapMode, silentActivation, toScreenValue, toString, update, updateSize, updateUIAfterValueSet, updateZapState, validateDisplayValue

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

config, defaultMousePtr, destroy, getColon, getColumnLabelText, getColumnMnemonic, getLabelInstance, getLabelText, getMnemonic, getTo, isForceLabel, isModified, isNoLabels, postprocessConfig, setColumnMnemonic, setHidden, setLabelInstance, setMnemonic, setNoLabels, setVisible, setWasVisible, wasVisible

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

minimumSize, requestFocus

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

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, currentFocus, cycleFocus, deregisterSelectedWidget, 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, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged

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

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, 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, 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, isScreenLocationCached, isTabStop, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseEntered, mouseExited, mouseMoved, 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, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, sync, topLevelWindow, 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.StreamableWidget

convertToStreamable

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

editPaste, isEditCanUndo

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, completeTrigger, dimension, displayPhysicalLocation, enclosingFrame, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getState, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isTabStop, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, widgetStateChanged, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseExited

Methods inherited from interface java.awt.event.MouseMotionListener

mouseMoved

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

getChangedValue

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

getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

widgetsAsList

Field Detail

LOG

private static final CentralLogger LOG

Logger

gd

private GuiDriver gd

Screen driver

comboBoxRef

private ComboBoxGuiImpl comboBoxRef

Reference to the possible combo-box object.

focusTraversable

private boolean focusTraversable

Local focus traversable flag.

cbxFormat

private DisplayFormat cbxFormat

Local format used as alternative for comboboxes of other subtype tan DROP-DOWN-LIST.

Constructor Detail

EntryFieldGuiImpl

public EntryFieldGuiImpl(WidgetId id,
                         FillInConfig cfg)

Special constructor used to restore component using given configuration.

Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.FillInConfig) to finish the widget initialization.

Parameters:

id - The widget's ID.

cfg - Configuration data.

EntryFieldGuiImpl

public EntryFieldGuiImpl(FillInConfig cfg,
                         ComboBoxGuiImpl cbbRef)

Special constructor used to restore component using given configuration.

Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.FillInConfig) to finish the widget initialization.

Parameters:

cfg - Configuration data.

cbbRef - Combo-box reference.

Method Detail

getTriggerWidget

public Widget getTriggerWidget()

For some virtual widgets, the widget where triggers are checked is different (i.e. entry field for a combo-box must route the trigger check to the combo-box, and not the associated fill-in).

Returns:

The widget which must process the triggers.

getLegacyWidget

public Widget getLegacyWidget()

Get the legacy widget for this entry-field, its comboBoxRef.

Returns:

See above.

initialize

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

Overrides:

initialize in class FillInGuiImpl

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

processKeyEvent

public void processKeyEvent(KeyInput ke)

Process GUI specific keys for combo-box entry field:

• SE_VALUE_CHANGED - inform combo-box the value changed.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class FillInGuiImpl

Parameters:

ke - Key event structure.

getDataEntryReturn

protected boolean getDataEntryReturn()

Convenience method to get access to SESSION:DATA-ENTRY-RETURN attribute.

Overrides:

getDataEntryReturn in class FillIn<GuiOutputManager,FillInConfig>

Returns:

Value of the SESSION:DATA-ENTRY-RETURN attribute.

focusTraversable

public boolean focusTraversable()

Check if widget is focus traversable.

Specified by:

focusTraversable in interface Widget<GuiOutputManager>

Overrides:

focusTraversable in class FillIn<GuiOutputManager,FillInConfig>

Returns:

true if widget is focus traversable.

width

public double width()

Get widget width.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class FillIn<GuiOutputManager,FillInConfig>

Returns:

Widget width.

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class FillIn<GuiOutputManager,FillInConfig>

Returns:

Widget height.

drawCaret

public void drawCaret()

Draws the caret.

Specified by:

drawCaret in interface Widget<GuiOutputManager>

Overrides:

drawCaret in class FillInGuiImpl

mousePressed

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

Notification of a mouse pressed event occurred for this widget.

If the widget is not already focused, it forces the focus to it. After the focus was received, it computes the caret location, based on the mouse position over the widget's content.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class FillInGuiImpl

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse clicked event occurred for this widget.

If the widget is not already focused, it forces the focus to it. After the focus was received, it computes the caret location, based on the mouse position over the widget's content.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class FillInGuiImpl

Parameters:

e - The mouse event.

enforceDefaultMousePtr

public boolean enforceDefaultMousePtr()

Check if the default mouse pointer should be used regardless of the parent settings

Returns:

true if the default mouse pointer should always be used

editableNativeDimension

protected NativeDimension editableNativeDimension()

Determine the portion of the widget's editable part. This may be different than the widget's width, as determined by the WIDTH-CHARS or WIDTH-PIXELS attribute.

For GUI widgets, this is the physical dimension without the insets.

Overrides:

editableNativeDimension in class FillInGuiImpl

Returns:

The editable dimension of this widget, in native units.

getTextLookAndFeel

protected Theme.TextLookAndFeel getTextLookAndFeel(GuiColorResolver gcd,
                                                   GuiColorResolver gce)

Returns text look and feel for EntryFieldGuiImpl.

Overrides:

getTextLookAndFeel in class FillInGuiImpl

Parameters:

gcd - The gui color resolver used for normal text.

gce - The gui color resolver used for selected text.

Returns:

The Fillin text look and feel.

isTextSelectionDisplayed

protected boolean isTextSelectionDisplayed()

Tests if the text selection is displayed.

Overrides:

isTextSelectionDisplayed in class FillInGuiImpl

Returns:

True if the current text selection is displayed, otherwise false.

drawBorder

protected void drawBorder(GuiColorResolver gcd,
                          int x,
                          int y,
                          NativeDimension dim,
                          boolean threeDBorder)

Draws the border box around the fill-in.

Overrides:

drawBorder in class FillInGuiImpl

Parameters:

threeDBorder - Indicates whether 3d or flat border should be drawn.

gcd - graphic context

x - the X coordinate

y - the Y coordinate

dim - the dimention

isThreeD

public boolean isThreeD()

The combo editor is never 3D.

Specified by:

isThreeD in interface Widget<GuiOutputManager>

Overrides:

isThreeD in class AbstractWidget<GuiOutputManager>

Returns:

Always false

display

public void display()

Fills data structures from variable's value.

Overrides:

display in class FillInGuiImpl