com.goldencode.p2j.ui.client

Class AbstractButton<O extends OutputManager<?>,C extends ControlConfig>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Button, ToggleBox

public abstract class AbstractButton<O extends OutputManager<?>,C extends ControlConfig>
extends AbstractWidget<O>
implements WidgetWithConfig<C>, KeyListener, FocusListener

An implementation of a "abstract button" with a text label. This is the place to handle features common for all button like objects, e.g. buttons, toggle-boxes. This is one line height button like widget.

Field Summary

Fields

Modifier and Type	Field and Description
protected C	config The config instance.
private boolean	curvis Previous cursor visibility flag to restore on focus lost.
private java.lang.String	textLabel Button label.
protected boolean	widgetFocused Widget in focus flag.

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

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

Constructor Summary

Constructors

Constructor and Description
AbstractButton() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(C beforeUpdate) The method is called after the configuration associated with the implementor changes.
C	config() Provide access to the attributes stored in the widget.
Dimension	dimension() Get widget dimension.
abstract void	draw() Draw the button implementation.
boolean	forceCursorOnFocus() Check if widget needs in cursor to be on when having the input focus.
int	getDefaultEvent(KeyInput key, boolean inEditingBlock) Get the default event associated for this widget and the given key.
protected abstract void	handleBasicEvents(KeyInput event) Process basic events - TAB, BACK-TAB and ENTER key event.
protected boolean	handleCursorKeys(int key, Frame<O> frame) Handle cursor movement keys.
boolean	ignoreAction(int action) Check if the given event needs to be ignored, as it can't be treated by 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.
Dimension	minimumSize() Get widget minimum size.
private boolean	moveAboveWidget(Frame<O> frame) Move focus to widget above in specified frame.
private boolean	moveBelowWidget(Frame<O> frame) Move focus to widget below in specified frame.
private boolean	nextFocus() Move focus to next widget in Tab order.
private boolean	nextTabStop() Move focus to next widget in Tab order if initiated by NAB.
void	onFocusGained(FocusEvent event) This is called when the toggle-box takes the input focus.
void	onFocusLost(FocusEvent focusEvent) This is called when the button looses the input focus.
void	onKeyPressed(KeyInput event) This method is invoked when key is pressed.
void	onKeyTyped(KeyInput event) This method is invoked when key is typed.
private boolean	prevFocus() Move focus to previous widget in Tab order.
private boolean	prevTabStop() Move focus to previous widget in Tab order if initiated by BACK-TAB.
protected void	processKeyEventCommon(KeyInput keyEvent) Processes key events occurring on this object by dispatching them to any registered KeyListener objects.
protected void	refresh() Refresh widget at the screen.
protected void	setActionCode(KeyInput ki) Prepare event for processing.
abstract void	setText(java.lang.String text) Set the new text for the component.
void	setTextLabel(java.lang.String label) Set button label.
java.lang.String	textLabel() Get label text.

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, height, 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, processKeyEvent, 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, width, 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.WidgetWithConfig

initialize

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

acceptsEscAsAnyKey, acceptTrigger, canMovetoTop, 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

config

protected C extends ControlConfig config

The config instance.

textLabel

private java.lang.String textLabel

Button label.

widgetFocused

protected boolean widgetFocused

Widget in focus flag.

curvis

private boolean curvis

Previous cursor visibility flag to restore on focus lost.

Constructor Detail

AbstractButton

public AbstractButton()

Default constructor.

Method Detail

config

public C 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<C extends ControlConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

public void afterConfigUpdate(C 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<C extends ControlConfig>

Parameters:

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

ignoreAction

public boolean ignoreAction(int action)

Check if the given event needs to be ignored, as it can't be treated by the widget.

Overrides:

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

Parameters:

action - The event code.

Returns:

See above.

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.

getDefaultEvent

public int getDefaultEvent(KeyInput key,
                           boolean inEditingBlock)

Get the default event associated for this widget and the given key.

Overrides:

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

Parameters:

key - The current key.

inEditingBlock - true if EDITING mode is active.

Returns:

The action code for the widget's default event, Keyboard.SE_CHOOSE.

dimension

public Dimension dimension()

Get widget dimension.

Specified by:

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

Specified by:

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

Returns:

widget dimension.

draw

public abstract void draw()

Draw the button implementation. Called by this AbstarctButton's parent container.

Specified by:

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

Specified by:

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

forceCursorOnFocus

public boolean forceCursorOnFocus()

Check if widget needs in cursor to be on when having the input focus. For toggle-box widget this method should always return false because toggle-box never needs cursor visibility, even when it is required to force the cursor to be on.

Specified by:

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

Overrides:

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

Returns:

false unconditionally.

minimumSize

public Dimension minimumSize()

Get widget minimum size.

Specified by:

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

Specified by:

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

Returns:

widget minimum size.

textLabel

public java.lang.String textLabel()

Get label text.

Returns:

label text.

setText

public abstract void setText(java.lang.String text)

Set the new text for the component.

Parameters:

text - New text value.

setTextLabel

public void setTextLabel(java.lang.String label)

Set button label.

Parameters:

label - Label text.

onKeyPressed

public void onKeyPressed(KeyInput event)

This method is invoked when key is pressed.

Specified by:

onKeyPressed in interface KeyListener

Parameters:

event - Event which triggered this call.

onKeyTyped

public void onKeyTyped(KeyInput event)

This method is invoked when key is typed.

Specified by:

onKeyTyped in interface KeyListener

Parameters:

event - Event which triggered this call.

onFocusGained

public void onFocusGained(FocusEvent event)

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

Specified by:

onFocusGained in interface FocusListener

Parameters:

event - The focus event to be processed.

onFocusLost

public void onFocusLost(FocusEvent focusEvent)

This is called when the button looses the input focus.

Specified by:

onFocusLost in interface FocusListener

Parameters:

focusEvent - The focus event to be processed.

processKeyEventCommon

protected void processKeyEventCommon(KeyInput keyEvent)

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

Parameters:

keyEvent - The event to be handled.

handleBasicEvents

protected abstract void handleBasicEvents(KeyInput event)

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

Parameters:

event - Key event to process.

refresh

protected void refresh()

Refresh widget at the screen.

handleCursorKeys

protected boolean handleCursorKeys(int key,
                                   Frame<O> frame)

Handle cursor movement keys.

Parameters:

key - Key code.

frame - Parent frame.

Returns:

true if any cursor key was found.

setActionCode

protected void setActionCode(KeyInput ki)

Prepare event for processing.

Parameters:

ki - Input event.

moveBelowWidget

private boolean moveBelowWidget(Frame<O> frame)

Move focus to widget below in specified frame.

Parameters:

frame - Parent frame.

Returns:

true

moveAboveWidget

private boolean moveAboveWidget(Frame<O> frame)

Move focus to widget above in specified frame.

Parameters:

frame - Parent frame.

Returns:

true

prevFocus

private boolean prevFocus()

Move focus to previous widget in Tab order.

Returns:

true

nextFocus

private boolean nextFocus()

Move focus to next widget in Tab order.

Returns:

true

prevTabStop

private boolean prevTabStop()

Move focus to previous widget in Tab order if initiated by BACK-TAB.

Returns:

true

nextTabStop

private boolean nextTabStop()

Move focus to next widget in Tab order if initiated by NAB.

Returns:

true