com.goldencode.p2j.ui.client

Class RadioSet<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.LabeledPanel<O,RadioSetConfig>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RadioSetGuiImpl

public class RadioSet<O extends OutputManager<?>>
extends LabeledPanel<O,RadioSetConfig>
implements FocusListener, DataContainer, ControlSetComponent

RadioSet is a implementation of radio-set widget, a mutually exclusive set of RadioButton objects.

This is the ChUI specific implementation of the widget.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<RadioButton<O>>	buttons Button collection.
protected int	current current button

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

config

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
RadioSet(WidgetId id, WidgetConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
protected void	adjustCurrentButton() No-op in ChUI.
void	afterConfigUpdate(RadioSetConfig 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.
Widget<O>	currentFocus() Return reference to this, since REDIO-SET is always retains focus on itself.
Widget<O>	defaultFocus() Get default focusable widget.
void	draw() Draw RadioSet widget.
boolean	focusTraversable() Indicates whether this component can be traversed using TAB or BACK-TAB events.
protected double	getButtonsExpandWidth(ControlSetItem[] items) Gets button width for expand mode.
protected double	getButtonsExtraDistance() Gets extra distance between radio-buttons.
double	getCharWidth() Getting the width of the button.
int	getIndex(RadioButton<O> rb) Request index of some button.
protected double	getListHeightChars() Gets the list height in character units for radio-set.
protected double	getListWidthChars() Gets the list width in character units for radio-set.
RadioButton<O>	getSelected() Get selected button.
int[]	getSelection() Request indexes of selected items.
java.lang.String	getText() Get text representation of the currently selected value.
BaseDataType	getValue() Must return the value of the radio-set as a BaseDataType.
Rectangle	getVisiblePart() Gets the sub-rectangle which should be visible.
void	initialize(WidgetId id, RadioSetConfig 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.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
void	onFocusGained(FocusEvent focusEvent) This is called when the radio-set takes the input focus.
void	onFocusLost(FocusEvent focusEvent) This is called when the radio-set looses the input focus.
void	processKeyEvent(KeyInput keyEvent) This overriding is used to move the focus from this widget to the next/previous one, rather than moving between radio buttons inside the current radio-set.
void	reflectAncestorChange() Called when any of the widget's ancestors gets re-assigned.
void	refreshItems() Refresh widget look using new set of buttons.
protected void	refreshItemsImpl(int selectedId, boolean selectedDisabled) Refresh widget look using new set of buttons, after the concrete implementation has done any other needed calculations.
void	reset() Resets the value of the radio-set (the selected button) to the first button of the set.
protected void	selectButton(RadioButton<O> button) Select specified button and remove current selection.
void	setInitial() Track index of currently selected button.
void	setValue(BaseDataType value) Sets the value of the radio-set (the selected button) based on a BaseDataType value.
void	setWidthChars(double newWidth) Set up the width of the button dynamically.

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

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

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

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, cycleFocus, deregisterSelectedWidget, detach, dimension, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, 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, 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, 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.DataContainer

getChangedValue

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, clearWidget, completeTrigger, defaultMousePtr, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, 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, 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.MnemonicTrait

createMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

widgetsAsList

Field Detail

current

protected int current

current button

buttons

protected java.util.ArrayList<RadioButton<O extends OutputManager<?>>> buttons

Button collection.

Constructor Detail

RadioSet

public RadioSet(WidgetId id,
                WidgetConfig cfg)

Special constructor used to restore component using given configuration.

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

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

processKeyEvent

public void processKeyEvent(KeyInput keyEvent)

This overriding is used to move the focus from this widget to the next/previous one, rather than moving between radio buttons inside the current radio-set.

Specified by:

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

Overrides:

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

Parameters:

keyEvent - The key event to be processed.

getValue

public BaseDataType getValue()

Must return the value of the radio-set as a BaseDataType.

Specified by:

getValue in interface DataContainer

Returns:

The BaseDataType value of the selected button inside the button group.

getText

public java.lang.String getText()

Get text representation of the currently selected value.

Specified by:

getText in interface DataContainer

Returns:

The screen representation of the value.

setValue

public void setValue(BaseDataType value)

Sets the value of the radio-set (the selected button) based on a BaseDataType value. The comparison should be insensitive in terms of data types. All of the below should match: the button label is true (logical) and the value is "yes" (character) the button label is 500 (integer) and the value is "500" (character) the button label is date(1, 1, 1999) (date) and the value is "01/01/99" (character)

Specified by:

setValue in interface DataContainer

Parameters:

value - The BaseDataType value of the button to be selected inside the button group.

reset

public void reset()

Resets the value of the radio-set (the selected button) to the first button of the set.

focusTraversable

public boolean focusTraversable()

Indicates whether this component can be traversed using TAB or BACK-TAB events.

Specified by:

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

Overrides:

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

Returns:

true if widget can be traversed.

defaultFocus

public Widget<O> defaultFocus()

Get default focusable widget.

If at least one button is focusable, then return this radio-set (not individual button).

Specified by:

defaultFocus in interface Container<O extends OutputManager<?>>

Overrides:

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

Returns:

default focusable widget.

currentFocus

public Widget<O> currentFocus()

Return reference to this, since REDIO-SET is always retains focus on itself.

Specified by:

currentFocus in interface Container<O extends OutputManager<?>>

Overrides:

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

Returns:

this

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.

setWidthChars

public void setWidthChars(double newWidth)

Set up the width of the button dynamically.

Parameters:

newWidth - The new width of the radio-button.

getCharWidth

public double getCharWidth()

Getting the width of the button. The final width includes the button's label size.

Returns:

The integer number of the width of the radio-buttons.

draw

public void draw()

Draw RadioSet widget.

Specified by:

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

Overrides:

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

onFocusGained

public void onFocusGained(FocusEvent focusEvent)

This is called when the radio-set takes the input focus. When the help string is defined for the radio-set it should be displayed at the window status line.

Specified by:

onFocusGained in interface FocusListener

Parameters:

focusEvent - The focus event to be processed.

onFocusLost

public void onFocusLost(FocusEvent focusEvent)

This is called when the radio-set looses the input focus.

Specified by:

onFocusLost in interface FocusListener

Parameters:

focusEvent - The focus event to be processed.

refreshItems

public void refreshItems()

Refresh widget look using new set of buttons.

Specified by:

refreshItems in interface ControlSetComponent

getSelection

public int[] getSelection()

Request indexes of selected items.

Specified by:

getSelection in interface ControlSetComponent

Returns:

array of 0-based indexes of selected items.

getIndex

public int getIndex(RadioButton<O> rb)

Request index of some button.

Parameters:

rb - Radio button.

Returns:

0-based index of the button or -1 if not in the set.

setInitial

public void setInitial()

Track index of currently selected button.

getSelected

public RadioButton<O> getSelected()

Get selected button.

Returns:

Selected button.

getVisiblePart

public Rectangle getVisiblePart()

Gets the sub-rectangle which should be visible.

Specified by:

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

Overrides:

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

Returns:

The sub-rectangle which should be visible

manageSystemActions

public boolean manageSystemActions()

Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.

Overrides:

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

Returns:

true as the widget has its own event management.

afterConfigUpdate

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

Overrides:

afterConfigUpdate in class LabeledPanel<O extends OutputManager<?>,RadioSetConfig>

Parameters:

beforeUpdate - Original configuration state.

reflectAncestorChange

public void reflectAncestorChange()

Called when any of the widget's ancestors gets re-assigned. It will clear all cached values (AbstractWidget.ancestorCache and AbstractWidget.window) for itself and the entire widget tree starting from this container.

Overrides:

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

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.

refreshItemsImpl

protected void refreshItemsImpl(int selectedId,
                                boolean selectedDisabled)

Refresh widget look using new set of buttons, after the concrete implementation has done any other needed calculations.

Parameters:

selectedId - The selected button ID; -1 if none selected.

selectedDisabled - Flag indicating if the selected button is disabled.

selectButton

protected void selectButton(RadioButton<O> button)

Select specified button and remove current selection.

Parameters:

button - Button to select.

getButtonsExpandWidth

protected double getButtonsExpandWidth(ControlSetItem[] items)

Gets button width for expand mode.

Parameters:

items - Radio-button set to check.

Returns:

The UI dependent button width for expand mode.

getButtonsExtraDistance

protected double getButtonsExtraDistance()

Gets extra distance between radio-buttons.

Returns:

The UI dependent distance between buttons.

getListWidthChars

protected double getListWidthChars()

Gets the list width in character units for radio-set.

Returns:

The UI dependent width for item list.

getListHeightChars

protected double getListHeightChars()

Gets the list height in character units for radio-set.

Returns:

The UI dependent height for item list.

adjustCurrentButton

protected void adjustCurrentButton()

No-op in ChUI.