com.goldencode.p2j.ui.client

Class Button<O extends OutputManager<?>>

java.lang.Object

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

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

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

All Implemented Interfaces:

FocusListener, KeyListener, LabeledWidget<O>, MnemonicTrait<O>, ReleasedKeySensible, Widget<O>, WidgetWithConfig<ButtonConfig>, ConfigOwner<ButtonConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ButtonImpl, GuiButton

public abstract class Button<O extends OutputManager<?>>
extends AbstractButton<O,ButtonConfig>
implements LabeledWidget<O>, MnemonicTrait<O>, ReleasedKeySensible

An implementation of a "push button" with a text label.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	command Command to generate.
private Label<O>	label Label instance associated with widget.
private java.util.ArrayList<ActionListener>	listeners Container for listeners.
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, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addListener(ActionListener listener) Add action listener.
void	afterConfigUpdate(ButtonConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
boolean	checkKey(KeyInput keyEvent) Check if passes key does match underscored character in the text.
ButtonConfig	config() Provide access to the attributes stored in the widget.
void	destroy() Destroy this widget.
double	getColon() Return current value of COLON option.
java.lang.String	getColumnLabelText() Return text of the column label.
java.lang.String	getCommand() Get command associated with button.
Label<O>	getLabelInstance() Return reference to the instance of the Label attached to the widget.
java.lang.String	getLabelText() Return text of the label.
MnemonicInfo	getMnemonic() MnemonicInfo instance getter.
double	getTo() Return TO column.
protected void	handleBasicEvents(KeyInput event) Process basic events - TAB, BACK-TAB and ENTER key event.
private boolean	handleHotkeys(KeyInput ki) Handle space and keys that match the highlighted char in button text.
double	height() Calculate the height of this widget.
protected void	initButtonText(java.lang.String text) Initialize button text.
void	initialize(WidgetId id, ButtonConfig 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	isForceLabel() Get current state of flag which is forces presence of the label regardless from the frame NO-LABELS option.
boolean	isMnemonicSupported() Check whether this button supports mnemonics.
boolean	isNoLabels() Get current state of NO-LABELS flag.
boolean	isRightAligned() Get widget alignment policy.
void	postprocessConfig() Additional processing required when widget configuration is updated AFTER the frame layout has been performed.
void	processEvent(Event event) Process event and dispatch it to specific method.
void	processKeyEvent(KeyInput keyEvent) Processes key events occurring on this object by dispatching them to any registered KeyListener objects.
void	requestFocus() Request focus.
void	setCommand(java.lang.String command) Set command associated with button.
void	setHidden(boolean hidden) Tracks the hidden state of the widget and attached label.
void	setLabelInstance(Label<O> label) Assign new instance of Label to the widget.
void	setMnemonic(MnemonicInfo mnemonic) MnemonicInfo instance setter.
void	setNoLabels(boolean labels) Force NO-LABELS flag.
void	setSupportsMnemonic() Set the mnemonics support for this button.
void	setText(java.lang.String text) Set the new text for the component.
void	setTextLabel(java.lang.String label) Set button label.
void	setVisible(boolean visible) Shows or hides the button and its label.
void	setWasVisible() Remember the widget was made visible at least once.
java.lang.String	textLabel() Get label text.
boolean	wasVisible() Checking if the widget was made visible at least once.
double	width() Calculate the width of this widget.

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

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

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, 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, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, 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, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, 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.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, dimension, displayPhysicalLocation, draw, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, 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, 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, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, 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, 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, getColumnMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, setColumnMnemonic, updateMnemonic

Field Detail

command

private java.lang.String command

Command to generate.

listeners

private java.util.ArrayList<ActionListener> listeners

Container for listeners.

label

private Label<O extends OutputManager<?>> label

Label instance associated with widget.

mnemonic

private MnemonicInfo mnemonic

Mnemonic information

Constructor Detail

Button

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

This constructor creates a button with a given text label.

Parameters:

id - The widget's ID.

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

text - The string to be used as the button text.

Button

public Button(WidgetId id,
              ButtonConfig cfg)

Special constructor used to restore component using given configuration.

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

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

initButtonText

protected void initButtonText(java.lang.String text)

Initialize button text.

Parameters:

text - Button text.

addListener

public void addListener(ActionListener listener)

Add action listener.

Parameters:

listener - Listener to add.

checkKey

public boolean checkKey(KeyInput keyEvent)

Check if passes key does match underscored character in the text.

Parameters:

keyEvent - Event to check.

Returns:

true if match is found.

config

public ButtonConfig 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<ButtonConfig>

Overrides:

config in class AbstractButton<O extends OutputManager<?>,ButtonConfig>

Returns:

Reference to attribute container.

getColon

public double getColon()

Return current value of COLON option.

Specified by:

getColon in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current value of the option column.

getColumnLabelText

public java.lang.String getColumnLabelText()

Return text of the column label.

Specified by:

getColumnLabelText in interface LabeledWidget<O extends OutputManager<?>>

Returns:

text of the column label.

getLabelInstance

public Label<O> getLabelInstance()

Return reference to the instance of the Label attached to the widget.

Specified by:

getLabelInstance in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Reference to Label instance.

getLabelText

public java.lang.String getLabelText()

Return text of the label.

Specified by:

getLabelText in interface LabeledWidget<O extends OutputManager<?>>

Returns:

text of the label.

getTo

public double getTo()

Return TO column.

Specified by:

getTo in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Column assigned via TO option.

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.

isForceLabel

public boolean isForceLabel()

Get current state of flag which is forces presence of the label regardless from the frame NO-LABELS option.

Specified by:

isForceLabel in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current state of the flag.

isNoLabels

public boolean isNoLabels()

Get current state of NO-LABELS flag.

Specified by:

isNoLabels in interface LabeledWidget<O extends OutputManager<?>>

Returns:

Current state of the flag.

isRightAligned

public boolean isRightAligned()

Get widget alignment policy.

Specified by:

isRightAligned in interface LabeledWidget<O extends OutputManager<?>>

Returns:

true if widget is formatted for right alignment.

processEvent

public void processEvent(Event event)

Process event and dispatch it to specific method.

Specified by:

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

Overrides:

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

Parameters:

event - Event to process.

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.

handleHotkeys

private boolean handleHotkeys(KeyInput ki)

Handle space and keys that match the highlighted char in button text.

Parameters:

ki - Input event.

Returns:

true if key is handled.

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

Parameters:

event - Key event to process.

requestFocus

public void requestFocus()

Request focus.

Specified by:

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

getCommand

public java.lang.String getCommand()

Get command associated with button.

Returns:

Command text.

setCommand

public void setCommand(java.lang.String command)

Set command associated with button.

Parameters:

command - Command text.

setLabelInstance

public void setLabelInstance(Label<O> label)

Assign new instance of Label to the widget.

Specified by:

setLabelInstance in interface LabeledWidget<O extends OutputManager<?>>

Parameters:

label - Reference to new Label instance.

setNoLabels

public void setNoLabels(boolean labels)

Force NO-LABELS flag.

Specified by:

setNoLabels in interface LabeledWidget<O extends OutputManager<?>>

Parameters:

labels - New value of the flag.

setText

public void setText(java.lang.String text)

Set the new text for the component.

Specified by:

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

Parameters:

text - New text value.

setTextLabel

public void setTextLabel(java.lang.String label)

Set button label.

Overrides:

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

Parameters:

label - Label text.

textLabel

public java.lang.String textLabel()

Get label text.

Overrides:

textLabel in class AbstractButton<O extends OutputManager<?>,ButtonConfig>

Returns:

label text.

setVisible

public void setVisible(boolean visible)

Shows or hides the button and its label.

Specified by:

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

Overrides:

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

Parameters:

visible - true to make the widget visible, false to hide the widget.

setHidden

public void setHidden(boolean hidden)

Tracks the hidden state of the widget and attached label.

Specified by:

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

Overrides:

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

Parameters:

hidden - New hidden state.

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.

wasVisible

public boolean wasVisible()

Checking if the widget was made visible at least once.

Specified by:

wasVisible in interface LabeledWidget<O extends OutputManager<?>>

Returns:

true if the widget was visible, false otherwise.

setWasVisible

public void setWasVisible()

Remember the widget was made visible at least once.

Specified by:

setWasVisible in interface LabeledWidget<O extends OutputManager<?>>

afterConfigUpdate

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

Overrides:

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

Parameters:

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

postprocessConfig

public void postprocessConfig()

Additional processing required when widget configuration is updated AFTER the frame layout has been performed.

Specified by:

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

Overrides:

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

destroy

public void destroy()

Destroy this widget.

Specified by:

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

Overrides:

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

setSupportsMnemonic

public void setSupportsMnemonic()

Set the mnemonics support for this button.

isMnemonicSupported

public boolean isMnemonicSupported()

Check whether this button supports mnemonics. Intended to be overridden. CHUI: buttons do not support mnemonics except the ones in ALERT-BOX. GUI: all buttons support mnemonics.

Specified by:

isMnemonicSupported in interface MnemonicTrait<O extends OutputManager<?>>

Returns:

true if this button supports mnemonic.

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.