com.goldencode.p2j.ui.client.gui

Class GuiButton

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

com.goldencode.p2j.ui.client.gui.GuiButton

All Implemented Interfaces:

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

Direct Known Subclasses:

ButtonGuiImpl, CaptionButton, ScrollBarGuiButton

public abstract class GuiButton
extends Button<GuiOutputManager>

This abstract class add mouse sensitiveness to Button objects. Instances of this class are notified when mouse hovers over them, and when they are pressed down using the mouse. The implementation will track mouse events on this button and provide the current state using getters. It also supports the any combination of pressed and hover, if pressed and mouse cursor is dragged outside the bounds, the state is kept as pressed, so in an eventual re-enter event the state is correct. It's up to called to caller renderer to draw the state of the button and the listener to act on the state provided by this class.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	mouseDragging The mouse is dragging
private boolean	mouseOver Whether the mouse is over this button.
private java.awt.Point	pressedLoc 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, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	isMouseOver() Checks if the mouse hovers over this widget.
boolean	isPressed() Checks pressed mouse state on this widget.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event occurred for this widget.
void	mouseEntered(java.awt.event.MouseEvent e) Process the notification of a mouse enter event occurred for this widget.
void	mouseExited(java.awt.event.MouseEvent e) Process the notification of a mouse leave event occurred for this widget.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved 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.

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

addListener, afterConfigUpdate, checkKey, config, destroy, getColon, getColumnLabelText, getCommand, getLabelInstance, getLabelText, getMnemonic, getTo, handleBasicEvents, height, initButtonText, initialize, isForceLabel, isMnemonicSupported, isNoLabels, isRightAligned, postprocessConfig, processEvent, processKeyEvent, requestFocus, setCommand, setHidden, setLabelInstance, setMnemonic, setNoLabels, setSupportsMnemonic, setText, setTextLabel, setVisible, setWasVisible, textLabel, wasVisible, width

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, mouseClicked, 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

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

mouseOver

private boolean mouseOver

Whether the mouse is over this button. Some themes paints this differently.

pressedLoc

private java.awt.Point pressedLoc

Pressed button state flag.

mouseDragging

private boolean mouseDragging

The mouse is dragging

Constructor Detail

GuiButton

public GuiButton(WidgetId id,
                 Container<GuiOutputManager> 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.

GuiButton

public GuiButton(WidgetId id,
                 ButtonConfig cfg)

Special constructor used to restore component using given configuration.

Call Button.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

isMouseOver

public boolean isMouseOver()

Checks if the mouse hovers over this widget.

Returns:

true if the mouse pointer is inside the visible bounds of this widget

mouseEntered

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

Process the notification of a mouse enter event occurred for this widget. Store the new state and call repaint to update the button's visual.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseExited

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

Process the notification of a mouse leave event occurred for this widget. Store the new state and call repaint to update the button's visual.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

isPressed

public boolean isPressed()

Checks pressed mouse state on this widget.

Returns:

true if user pressed the left mouse button on this widget and has not released it yet.

mousePressed

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

Notification of a mouse pressed event occurred for this widget. Redraw button in pressed state and request focus if focusable.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moved event occurred for this widget.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved 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.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged 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. Redraw button in released state.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.