com.goldencode.p2j.ui.client

Class Text<O extends OutputManager<?>>

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<O,TextConfig>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TextGuiImpl, TextImpl

public abstract class Text<O extends OutputManager<?>>
extends FillIn<O,TextConfig>
implements Label<O>

Implementation of Progress TEXT component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Text.ContentMnemonic<G extends OutputManager<?>> Container class for the TEXT's content mnemonic.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	assigned Track value assignment.
protected MnemonicTrait<O>	contentMnemonic Mnemonic information for the TEXT's content.
protected boolean	forcedAsText true if the widget has TextConfig.explicitViewAs flag or the parent frame has FrameConfig.useText flag.

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
Text(WidgetId id, TextConfig cfg, MnemonicTrait<O> contentMnemonic) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
boolean	canMovetoTop() Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.
void	clear(int selectionStart, int selectionEnd) Overridden to prevent clearing of the content.
protected void	copyState(Widget<?> w) Copy the widget state from the specified source widget to this instance.
void	display() Fills data structures from variable's value and updates the mnemonic.
void	drawCaret() Sets position of terminal's cursor.
protected NativeDimension	editableNativeDimension() Determine the portion of the widget's editable part.
boolean	focusTraversable() This component will not receive an input focus when Tab or Shift-Tab is pressed.
int	getInitialCursorPos() Compute the initial cursor position, depending on the widget's implementation.
protected int	getNativeCursorPos() Get the cursor position, in native units.
boolean	ignoreEnable() Some widgets can ignore an ENABLE statement (like read-only, hidden, TEXT).
void	initialize(WidgetId id, TextConfig 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.
java.lang.String	label() Enable empty mode.
void	setValue(BaseDataType value) Sets the new variable value in the widget, set appropriate flag and update the mnemonic.

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

activate, activate, adjustCursor, adjustEditScroller, afterConfigUpdate, blankScreenValue, clear, clear, clearWidget, createLeftAnchor, createRightAnchor, currentFocus, defaultFocus, draw, draw, fireValueChanged, getBrowse, getCurrentFormat, getCursorOffset, getDataEntryReturn, getDrawText, getEditScroller, getFirstInGroup, getFormat, getInsertMode, getLastInGroup, getLastOffset, getScreenValue, getText, getText, getTriggerWidget, getValidCursorPos, getValue, getVariable, height, initSelection, invalidateSelection, isAtField, isCharacterInGui, isDrawLine, isFormatCheck, isInAutoReturn, isIntegerInGui, isLeftEdgeWidget, isLinkedToBrowse, isPendingNoZap, isRightAligned, isRightAlignedInt, isRightEdgeWidget, isSelected, isSelectionValid, isZapActive, isZapToBeApplied, nativeHeight, nativeWidth, processKeyEvent, refresh, refresh, requestFocus, reset, resetCaret, resetEditScroller, setAttrFormat, setBrowseColumn, setCursorOffset, setCursorOffset, setDataType, setEnabled, setForceLeft, setForceRight, setFormatCheck, setHeaderParm, setInAutoReturn, setInsertMode, setPendingNoZap, setSelection, setSize, setSkipCursorActivation, setTextGroup, setUnderline, setValue, setZapMode, setZapMode, silentActivation, toScreenValue, toString, update, updateCursorOffsetValue, updateSize, updateUIAfterValueSet, updateZapState, validateDisplayValue, width

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, 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, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, showPopupMenu, supportsCustomMousePointer, 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.Label

config, isDelimiter, isUnderlined, linkTo, postprocessConfig, setEmptyModeOff, setEmptyModeOn, setRightAligned, setWidth

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, clearWidget, completeTrigger, defaultMousePtr, destroy, dimension, displayPhysicalLocation, draw, enclosingFrame, enforceDefaultMousePtr, findMouseSource, 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, 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, postprocessConfig, 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, 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.TextSelection

editPaste, isEditCanUndo, removeSelectedText, setSelection

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

getChangedValue

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

assigned

protected boolean assigned

Track value assignment.

contentMnemonic

protected final MnemonicTrait<O extends OutputManager<?>> contentMnemonic

Mnemonic information for the TEXT's content.

forcedAsText

protected boolean forcedAsText

true if the widget has TextConfig.explicitViewAs flag or the parent frame has FrameConfig.useText flag.

Constructor Detail

Text

public Text(WidgetId id,
            TextConfig cfg,
            MnemonicTrait<O> contentMnemonic)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

contentMnemonic - The mnemonic information for the TEXT's content.

Method Detail

initialize

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

Overrides:

initialize in class FillIn<O extends OutputManager<?>,TextConfig>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

drawCaret

public void drawCaret()

Sets position of terminal's cursor. Really does nothing because this widget will never get an input focus.

Specified by:

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

Specified by:

drawCaret in class FillIn<O extends OutputManager<?>,TextConfig>

focusTraversable

public boolean focusTraversable()

This component will not receive an input focus when Tab or Shift-Tab is pressed.

Specified by:

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

Overrides:

focusTraversable in class FillIn<O extends OutputManager<?>,TextConfig>

Returns:

Always false.

setValue

public void setValue(BaseDataType value)

Sets the new variable value in the widget, set appropriate flag and update the mnemonic.

Specified by:

setValue in interface DataContainer

Overrides:

setValue in class FillIn<O extends OutputManager<?>,TextConfig>

Parameters:

value - New value for the screen buffer.

display

public void display()

Fills data structures from variable's value and updates the mnemonic.

Overrides:

display in class FillIn<O extends OutputManager<?>,TextConfig>

clear

public void clear(int selectionStart,
                  int selectionEnd)

Overridden to prevent clearing of the content.

Overrides:

clear in class FillIn<O extends OutputManager<?>,TextConfig>

Parameters:

selectionStart - The start selection index (inclusive).

selectionEnd - The end selection index (exclusive).

getInitialCursorPos

public int getInitialCursorPos()

Compute the initial cursor position, depending on the widget's implementation.

For TEXT widgets, this always returns 0.

Specified by:

getInitialCursorPos in interface EditableField

Returns:

See above.

label

public java.lang.String label()

Enable empty mode.

Specified by:

label in interface Label<O extends OutputManager<?>>

ignoreEnable

public boolean ignoreEnable()

Some widgets can ignore an ENABLE statement (like read-only, hidden, TEXT).

Specified by:

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

Returns:

true if the ENABLE statement must ignore it.

canMovetoTop

public boolean canMovetoTop()

Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.

Specified by:

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

Overrides:

canMovetoTop in class FillIn<O extends OutputManager<?>,TextConfig>

Returns:

Always true.

copyState

protected void copyState(Widget<?> w)

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

Overrides:

copyState in class FillIn<O extends OutputManager<?>,TextConfig>

Parameters:

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

getNativeCursorPos

protected int getNativeCursorPos()

Get the cursor position, in native units.

Specified by:

getNativeCursorPos in class FillIn<O extends OutputManager<?>,TextConfig>

Returns:

Always zero.

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 ChUI widgets, this is the same as the widget's physical dimension.

Specified by:

editableNativeDimension in class FillIn<O extends OutputManager<?>,TextConfig>

Returns:

The editable dimension of this widget, in native units.