com.goldencode.p2j.ui.client

Class ToggleBox<O extends OutputManager<?>>

java.lang.Object

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

com.goldencode.p2j.ui.client.AbstractButton<O,ToggleBoxConfig>

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

All Implemented Interfaces:

DataContainer, FocusListener, KeyListener, MnemonicTrait<O>, Widget<O>, WidgetWithConfig<ToggleBoxConfig>, ConfigOwner<ToggleBoxConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ToggleBoxGuiImpl, ToggleBoxImpl

public abstract class ToggleBox<O extends OutputManager<?>>
extends AbstractButton<O,ToggleBoxConfig>
implements DataContainer, MnemonicTrait<O>

An implementation of a "toggle box" with a text label.

Field Summary

Fields

Modifier and Type	Field and Description
private MnemonicInfo	mnemonic Mnemonic information

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

config, widgetFocused

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

insets, listeners, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
ToggleBox(WidgetId id, Container<O> owner, java.lang.String text) This constructor creates a toggle-box with a given text label.
ToggleBox(WidgetId id, ToggleBoxConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(ToggleBoxConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
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.
protected void	check(java.awt.event.MouseEvent e) Inverse checked state and post VALUE-CHANGED event.
MnemonicInfo	getMnemonic() MnemonicInfo instance getter.
java.lang.String	getText() Get label text.
BaseDataType	getValue() Getting the BaseDataType object representing the current value.
protected void	handleBasicEvents(KeyInput event) Process basic events - TAB, BACK-TAB and ENTER key event.
double	height() Calculate the height of this widget.
void	initialize(WidgetId id, ToggleBoxConfig 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	isModified() Getting the modification state of the widget.
protected boolean	isToggleKey(int key) Return true if specified key can change toggle-box value.
void	processKeyEvent(KeyInput keyEvent) Processes key events occurring on this object by dispatching them to any registered KeyListener objects.
void	setMnemonic(MnemonicInfo mnemonic) MnemonicInfo instance setter.
void	setText(java.lang.String text) Set the new text for the component.
void	setTextLabel(java.lang.String label) Set button label.
void	setValue(BaseDataType value) Sets the value of the toggle-box (the checked state) based on a BaseDataType value.
double	width() Calculate the width of this widget.

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

config, dimension, draw, forceCursorOnFocus, getDefaultEvent, handleCursorKeys, ignoreAction, manageSystemActions, minimumSize, onFocusGained, onFocusLost, onKeyPressed, onKeyTyped, processKeyEventCommon, refresh, setActionCode, textLabel

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, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, destroy, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, findMouseSource, focusTraversable, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, initialHeight, initialWidth, insets, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, 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, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectAncestorChange, reflectLocationChanged, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unrealize, unregisterWidgetListener, updateSizeWorker, updateSystemParent, widgetRealized, widgetStateChanged, 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.DataContainer

getChangedValue

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

createMnemonic, getColumnMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, setColumnMnemonic, updateMnemonic

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

acceptsEscAsAnyKey, acceptTrigger, completeTrigger, defaultMousePtr, enforceDefaultMousePtr, getIdForTrigger, getLegacyWidget, getTriggerWidget, getTriggerWidget, hasFocus, ignoreEnable, isCurrent, isDirectManipulable, isDroppable, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, maySwitchFocus, parent, refreshWidget, requestFocus, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

Field Detail

mnemonic

private MnemonicInfo mnemonic

Mnemonic information

Constructor Detail

ToggleBox

public ToggleBox(WidgetId id,
                 Container<O> owner,
                 java.lang.String text)

This constructor creates a toggle-box with a given text label.

Parameters:

id - The widget's ID.

owner - The parent container, frame or dialog which will include this toggle-box.

text - The string to be used as the toggle-box text.

ToggleBox

public ToggleBox(WidgetId id,
                 ToggleBoxConfig cfg)

Special constructor used to restore component using given configuration.

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

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

afterConfigUpdate

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

Overrides:

afterConfigUpdate in class AbstractButton<O extends OutputManager<?>,ToggleBoxConfig>

Parameters:

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

getText

public java.lang.String getText()

Get label text.

Specified by:

getText in interface DataContainer

Returns:

label text.

getValue

public BaseDataType getValue()

Getting the BaseDataType object representing the current value.

Specified by:

getValue in interface DataContainer

Returns:

The value representing the current widget value.

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.

setValue

public void setValue(BaseDataType value)

Sets the value of the toggle-box (the checked state) based on a BaseDataType value.

Specified by:

setValue in interface DataContainer

Parameters:

value - The BaseDataType value of the logical value for toggle-box.

width

public double width()

Calculate the width of this widget.

Specified by:

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

Specified by:

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

Returns:

The width in characters.

height

public double height()

Calculate the height of this widget.

Specified by:

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

Specified by:

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

Returns:

The height in rows.

processKeyEvent

public void processKeyEvent(KeyInput keyEvent)

Processes key events occurring on this object by dispatching them to any registered KeyListener objects.

Specified by:

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

Overrides:

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

Parameters:

keyEvent - The event to be handled.

setText

public void setText(java.lang.String text)

Set the new text for the component.

Specified by:

setText in class AbstractButton<O extends OutputManager<?>,ToggleBoxConfig>

Parameters:

text - New text value.

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.

setTextLabel

public void setTextLabel(java.lang.String label)

Set button label.

Overrides:

setTextLabel in class AbstractButton<O extends OutputManager<?>,ToggleBoxConfig>

Parameters:

label - Label text.

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<?>>

Returns:

Always true.

handleBasicEvents

protected void handleBasicEvents(KeyInput event)

Process basic events - TAB, BACK-TAB and ENTER key event.

Specified by:

handleBasicEvents in class AbstractButton<O extends OutputManager<?>,ToggleBoxConfig>

Parameters:

event - Key event to process.

check

protected void check(java.awt.event.MouseEvent e)

Inverse checked state and post VALUE-CHANGED event.

Parameters:

e - Mouse event or null, that means, that the source event is a key press.

isToggleKey

protected boolean isToggleKey(int key)

Return true if specified key can change toggle-box value.

Parameters:

key - Key code being processed.

Returns:

true if specified key is a toggle key.