com.goldencode.p2j.ui.client

Class RadioButton<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.RadioButton<O>

All Implemented Interfaces:

DataContainer, 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:

RadioButtonGuiImpl, RadioButtonImpl

public abstract class RadioButton<O extends OutputManager<?>>
extends AbstractContainer<O>
implements DataContainer, WidgetWithConfig<RadioSetConfig>, MnemonicTrait<O>

An implementation of a radio-button - an item that is always in one of two states (SELECTED or DESELECTED) and which displays its state to the user. RadioButtons are used with a ButtonGroup object to create a group of buttons in which only one button at a time can be selected (Create a ButtonGroup object and use its add() method to add the radio buttons to it).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoResize Automatic size change enabling flag.
protected RadioSetConfig	config Reference to config.
protected boolean	focused Pseudo-focus flag.
private int	itemId button id
private MnemonicInfo	mnemonic Mnemonic information
private boolean	selected Selection flag.
private java.lang.String	text Button text.
private BaseDataType	value The value to be returned as the RadioButton value.
protected double	width The width of the button.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
RadioButton(RadioSetConfig config, java.lang.String label, BaseDataType value) Use this constructor when you want to set both the label and the value.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(RadioSetConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
RadioSetConfig	config() Provide access to the attributes stored in the widget.
abstract void	draw() Called by this RadioButton's parent container.
abstract void	drawCaret() Draw cursor at the correct position.
int	getItemId() Get button id.
MnemonicInfo	getMnemonic() MnemonicInfo instance getter.
java.lang.String	getText() Get label text.
BaseDataType	getValue() Returns the BaseDataType instance representing the current value.
boolean	hasFocusable(Widget<O> exclude) Reports if this widget is focusable.
double	height() Return height of the radio button.
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	isEnabled() Check if widget is enabled.
boolean	isFocused() Get current state of pseudo-focus flag.
boolean	isModified() Getting the modification state of the widget.
boolean	isSelected() Get current selection state.
Point	location() Get widget location relative to container.
NativePoint	physicalLocation() Get widget physical location relative to container, expressed in units native to UI type.
void	processEvent(Event evt) Main event processing entry point.
void	replace(RadioButton<O> newButton) Replace this radio-button with the new one.
void	setFocused(boolean focused) Set pseudo-focus flag.
void	setItemId(int id) Set button id.
void	setLocation(double x, double y) Set widget relative location.
void	setMnemonic(MnemonicInfo mnemonic) MnemonicInfo instance setter.
void	setPhysicalLocation(int x, int y) Set widget relative physical location.
void	setSelected(boolean state) Sets the state of the button.
(package private) void	setText(java.lang.String text) Set label text.
void	setValue(BaseDataType value) Sets the BaseDataType instance representing the current value.
void	setWidthChars(double newWidth) Set up the width of the button dynamically.
double	width() Return the width of the radio button.

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

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, destroy, detach, dimension, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, processKeyEvent, reflectAncestorChange, 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

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, 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, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, 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, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, 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, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setSensitiveForUIB, setState, setVisible, 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.MnemonicTrait

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

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

widgetsAsList

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, 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

Field Detail

value

private BaseDataType value

The value to be returned as the RadioButton value.

width

protected double width

The width of the button.

autoResize

protected boolean autoResize

Automatic size change enabling flag.

text

private java.lang.String text

Button text.

selected

private boolean selected

Selection flag.

focused

protected boolean focused

Pseudo-focus flag.

itemId

private int itemId

button id

config

protected RadioSetConfig config

Reference to config.

mnemonic

private MnemonicInfo mnemonic

Mnemonic information

Constructor Detail

RadioButton

public RadioButton(RadioSetConfig config,
                   java.lang.String label,
                   BaseDataType value)

Use this constructor when you want to set both the label and the value.

Parameters:

config - Reference to config.

label - The button's label which can clarify the button purpose.

value - The data which is the button's value.

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.

config

public RadioSetConfig config()

Provide access to the attributes stored in the widget.

Specified by:

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

Specified by:

config in interface ConfigOwner<RadioSetConfig>

Overrides:

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

Returns:

Reference to attribute container.

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>

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.

setText

void setText(java.lang.String text)

Set label text.

Parameters:

text - Label text.

getValue

public BaseDataType getValue()

Returns the BaseDataType instance 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:

always returns false and is never called.

setValue

public void setValue(BaseDataType value)

Sets the BaseDataType instance representing the current value.

Specified by:

setValue in interface DataContainer

Parameters:

value - The value representing the current widget value.

replace

public void replace(RadioButton<O> newButton)

Replace this radio-button with the new one.

Parameters:

newButton - The new radio button to be used instead of the current one.

location

public Point location()

Get widget location relative to container.

Specified by:

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

Overrides:

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

Returns:

relative widget location.

physicalLocation

public NativePoint physicalLocation()

Get widget physical location relative to container, expressed in units native to UI type.

Specified by:

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

Overrides:

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

Returns:

relative widget location.

setLocation

public void setLocation(double x,
                        double y)

Set widget relative location. The x value corresponds to COLUMN while y value corresponds to ROW 4GL attribute. Note however that the values are expected to be 0-based.

Specified by:

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

Overrides:

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

Parameters:

x - Widget X.

y - Widget Y.

setPhysicalLocation

public void setPhysicalLocation(int x,
                                int y)

Set widget relative physical location.

Specified by:

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

Overrides:

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

Parameters:

x - Widget physical X.

y - Widget physical Y.

width

public double width()

Return the width of the radio button.

Specified by:

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

Overrides:

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

Returns:

The value of the button width including the label text.

height

public double height()

Return height of the radio button.

Specified by:

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

Overrides:

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

Returns:

The value of the button height.

setWidthChars

public void setWidthChars(double newWidth)

Set up the width of the button dynamically.

Parameters:

newWidth - The new button width in the character units.

draw

public abstract void draw()

Called by this RadioButton's parent container.

Specified by:

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

Overrides:

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

drawCaret

public abstract void drawCaret()

Draw cursor at the correct position.

Specified by:

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

Overrides:

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

See Also:

Widget.drawCaret()

isFocused

public boolean isFocused()

Get current state of pseudo-focus flag.

Returns:

Current state of the flag.

setFocused

public void setFocused(boolean focused)

Set pseudo-focus flag.

Parameters:

focused - New state of the flag.

hasFocusable

public boolean hasFocusable(Widget<O> exclude)

Reports if this widget is focusable.

Specified by:

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

Overrides:

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

Parameters:

exclude - A widget to ignore or null if any focusable widget will do.

Returns:

true if this widget is not the excluded widget.

setSelected

public void setSelected(boolean state)

Sets the state of the button.

Parameters:

state - New state of the button.

isSelected

public boolean isSelected()

Get current selection state.

Returns:

true if button is selected.

processEvent

public void processEvent(Event evt)

Main event processing entry point.

Specified by:

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

Overrides:

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

Parameters:

evt - Event to handle.

isEnabled

public boolean isEnabled()

Check if widget is enabled.

Specified by:

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

Overrides:

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

Returns:

true if widget is enabled.

getItemId

public int getItemId()

Get button id.

Returns:

button id.

setItemId

public void setItemId(int id)

Set button id.

Parameters:

id - New button id.

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.