com.goldencode.p2j.ui.client.gui

Class ToggleBoxGuiImpl

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

com.goldencode.p2j.ui.client.gui.ToggleBoxGuiImpl

All Implemented Interfaces:

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

public class ToggleBoxGuiImpl
extends ToggleBox<GuiOutputManager>
implements AutoResizable<ToggleBoxConfig>

Specific GUI implementation of TOGGLE-BOX widget.

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowseColumn<GuiOutputManager>	browseColumn Parent browse column widget (if this toggle-box is associated to a browse).
private static ColorRgb	CURRENT_ROW_XOR_COLOR Color which is XORed with background to draw current row highlighting (dotted rectangle).
private GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private boolean	pressed Pressed button state flag.

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
ToggleBoxGuiImpl(WidgetId id, Container<GuiOutputManager> owner, java.lang.String text) Constructor.
ToggleBoxGuiImpl(WidgetId id, WidgetConfig 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.
MnemonicInfo	createMnemonic() Creates new MnemonicInfoGuiImpl instance.
void	draw() Draw the toggle-box implementation.
protected Browse<GuiOutputManager>	getBrowse() Get associated browse widget, if any.
protected int	getLabelNativeWidth(Window<?> window) Return the width of the actual label in native pixels.
Widget<?>	getTriggerWidget(int evtCode, boolean isKey) This method returns the widget that should serve as the source of the triggered event.
double	height() Calculate the height of this widget.
void	initialize(WidgetId id, ToggleBoxConfig wcfg) 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	isAutoResize() Get the AUTO-RESIZE status
boolean	isDroppable() Checks if the given widget is able to be the target of the drop operation.
boolean	isLinkedToBrowse() Determines whether this ToggleBoxGuiImpl has an associated Browse widget.
protected boolean	isToggleKey(int key) Return true if specified key can change toggle-box value.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mouseClicked(java.awt.event.MouseEvent e) Notification of a mouse clicked event occurred for this widget.
void	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event occurred for this widget.
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 released event occurred for this widget.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
void	processKeyEvent(KeyInput keyEvent) Processes key events occurring on this object by dispatching them to any registered KeyListener objects.
boolean	processMnemonic(int key) Process the given key, if this widget's mnemonic matches the key.
protected void	refresh() In GUI mode, the drawing needs to be delayed.
void	setBrowseColumn(BrowseColumn<GuiOutputManager> browseColumn) Link this toggle-box with the BrowseColumn widget.
void	setColorResolver(GuiColorResolver resolver) Sets the color resolver.
void	setText(java.lang.String text) Set the new text for the component.
void	setWidthInt() Recalculates WIDTH attribute using actual label.
boolean	supportsCustomMousePointer() Check if the widget supports LOAD-MOUSE-POINTER() method
void	updateSize(ToggleBoxConfig beforeUpdate) Update widget's size after config update
double	width() Calculate the width of this widget.

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

canMovetoTop, check, getMnemonic, getText, getValue, handleBasicEvents, isModified, setMnemonic, setTextLabel, setValue

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

config, dimension, forceCursorOnFocus, getDefaultEvent, handleCursorKeys, ignoreAction, manageSystemActions, minimumSize, onFocusGained, onFocusLost, onKeyPressed, onKeyTyped, processKeyEventCommon, 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, mouseEntered, mouseExited, mouseMoved, 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, 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, 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

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, hasFocus, ignoreEnable, isCurrent, isDirectManipulable, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, maySwitchFocus, parent, refreshWidget, requestFocus, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

Field Detail

CURRENT_ROW_XOR_COLOR

private static final ColorRgb CURRENT_ROW_XOR_COLOR

Color which is XORed with background to draw current row highlighting (dotted rectangle).

gc

private GuiColorResolver gc

Color resolver

gd

private GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

pressed

private boolean pressed

Pressed button state flag.

browseColumn

protected BrowseColumn<GuiOutputManager> browseColumn

Parent browse column widget (if this toggle-box is associated to a browse).

Constructor Detail

ToggleBoxGuiImpl

public ToggleBoxGuiImpl(WidgetId id,
                        Container<GuiOutputManager> owner,
                        java.lang.String text)

Constructor.

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.

ToggleBoxGuiImpl

public ToggleBoxGuiImpl(WidgetId id,
                        WidgetConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

initialize

public void initialize(WidgetId id,
                       ToggleBoxConfig wcfg)

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>

Overrides:

initialize in class ToggleBox<GuiOutputManager>

Parameters:

id - The widget's ID.

wcfg - The config used to initialize this widget.

width

public double width()

Calculate the width of this widget.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class ToggleBox<GuiOutputManager>

Returns:

The width in characters.

height

public double height()

Calculate the height of this widget.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class ToggleBox<GuiOutputManager>

Returns:

The height in rows.

setText

public void setText(java.lang.String text)

Set the new text for the component.

Overrides:

setText in class ToggleBox<GuiOutputManager>

Parameters:

text - New text value.

draw

public void draw()

Draw the toggle-box implementation.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractButton<GuiOutputManager,ToggleBoxConfig>

setColorResolver

public void setColorResolver(GuiColorResolver resolver)

Sets the color resolver.

Parameters:

resolver - The color revolver

setWidthInt

public void setWidthInt()

Recalculates WIDTH attribute using actual label.

mouseClicked

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

Notification of a mouse clicked event occurred for this widget. Simulate ENTER key typing.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseDragged

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

Notification of a mouse dragged event occurred for this widget. No-op by default.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mousePressed

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

Notification of a mouse pressed event occurred for this widget.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse released event occurred for this widget. No-op by default.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Notification of a mouse wheel moved event occurred for this widget.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

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 ToggleBox<GuiOutputManager>

Parameters:

beforeUpdate - Previous configuration values.

supportsCustomMousePointer

public boolean supportsCustomMousePointer()

Check if the widget supports LOAD-MOUSE-POINTER() method

Specified by:

supportsCustomMousePointer in interface Widget<GuiOutputManager>

Overrides:

supportsCustomMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

true if the widget supports LOAD-MOUSE-POINTER() method

isAutoResize

public boolean isAutoResize()

Get the AUTO-RESIZE status

Specified by:

isAutoResize in interface AutoResizable<ToggleBoxConfig>

Returns:

true is AUTO-RESIZE is enabled

updateSize

public void updateSize(ToggleBoxConfig beforeUpdate)

Update widget's size after config update

Specified by:

updateSize in interface AutoResizable<ToggleBoxConfig>

Parameters:

beforeUpdate - previous value of the widget's config

processMnemonic

public boolean processMnemonic(int key)

Process the given key, if this widget's mnemonic matches the key.

Specified by:

processMnemonic in interface Widget<GuiOutputManager>

Overrides:

processMnemonic in class AbstractWidget<GuiOutputManager>

Parameters:

key - The pressed mnemonic key code.

Returns:

true if this widget accepted this mnemonic key. Not enabled or not visible widget will not accept it.

createMnemonic

public MnemonicInfo createMnemonic()

Creates new MnemonicInfoGuiImpl instance.

Specified by:

createMnemonic in interface MnemonicTrait<GuiOutputManager>

Returns:

MnemonicInfoGuiImpl instance.

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

Overrides:

processKeyEvent in class ToggleBox<GuiOutputManager>

Parameters:

keyEvent - The event to be handled.

setBrowseColumn

public void setBrowseColumn(BrowseColumn<GuiOutputManager> browseColumn)

Link this toggle-box with the BrowseColumn widget.

Parameters:

browseColumn - Parent browse column widget.

isLinkedToBrowse

public boolean isLinkedToBrowse()

Determines whether this ToggleBoxGuiImpl has an associated Browse widget.

Returns:

true if this ToggleBoxGuiImpl has an associated Browse widget.

getTriggerWidget

public Widget<?> getTriggerWidget(int evtCode,
                                  boolean isKey)

This method returns the widget that should serve as the source of the triggered event. This widget must always be a non-virtual widget. The method may also return null which prevents triggering of the legacy event.

If this toggle-box is inside a browse column, that browse column widget is returned.

Specified by:

getTriggerWidget in interface Widget<GuiOutputManager>

Parameters:

evtCode - The event being triggered.

isKey - Whether the event being triggered is a real key.

Returns:

see above.

getBrowse

protected Browse<GuiOutputManager> getBrowse()

Get associated browse widget, if any.

Returns:

associated browse widget or null if there is no associated browse widget.

isDroppable

public boolean isDroppable()

Checks if the given widget is able to be the target of the drop operation.

Specified by:

isDroppable in interface Widget<GuiOutputManager>

Returns:

TRUE if this widget can be droppable at this time, FALSE otherwise.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

refresh

protected void refresh()

In GUI mode, the drawing needs to be delayed.

Overrides:

refresh in class AbstractButton<GuiOutputManager,ToggleBoxConfig>

isToggleKey

protected boolean isToggleKey(int key)

Return true if specified key can change toggle-box value. TODO: Toggle key (SPACE) PRESSED/RELEASE events work as corresponding MOUSE events: we must draw check box background as inactive when the key is pressed and until it will be released. So we need to add support of RELEASE event for keys and implement that drawing.

Overrides:

isToggleKey in class ToggleBox<GuiOutputManager>

Parameters:

key - Key code being processed.

Returns:

true if specified key is a toggle key.

See Also:

SwingKeyboardReader.keyReleased(java.awt.event.KeyEvent)

getLabelNativeWidth

protected int getLabelNativeWidth(Window<?> window)

Return the width of the actual label in native pixels.