com.codename1.ui

Class Button

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.Label

com.codename1.ui.Button

All Implemented Interfaces:

Animation, Editable, ActionSource, StyleListener, IconHolder, ReleasableComponent, SelectableIconHolder, TextHolder

Direct Known Subclasses:

CheckBox, FloatingActionButton, LikeButton, Picker, RadioButton, ScaleImageButton, ShareButton

public class Button
extends Label
implements ReleasableComponent, ActionSource, SelectableIconHolder

Button is the base class for several UI widgets allowing clickability. It has 3 states: rollover, pressed and the default state. Button can also have an ActionListener that react when the Button is clicked or handle actions via a Command.
Button has the "Button" UIID by default.

Here is trivial usage of the Button API:

This code shows a common use case of making a button look like a hyperlink

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_DEFAULT Indicates the default state of a button which is neither pressed nor focused
static int	STATE_PRESSED Indicates the pressed state of a button
static int	STATE_ROLLOVER Indicates the rollover state of a button which is equivalent to focused for most uses

Fields inherited from class com.codename1.ui.Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR

Constructor Summary

Constructors

Constructor and Description
Button() Constructs a button with an empty string for its text.
Button(char icon) Constructs a button with the specified material image icon.
Button(char icon, float iconSize, String id) Constructor a button with material image icon and UIID
Button(char icon, String id) Constructor a button with material image icon and UIID
Button(Command cmd) Allows binding a command to a button for ease of use
Button(Image icon) Constructs a button with the specified image.
Button(Image icon, String id) Constructor a button with image and UIID
Button(String text) Constructs a button with the specified text.
Button(String text, char icon, float iconSize, String id) Constructor a button with text, material image and uiid
Button(String text, char icon, String id) Constructor a button with text, material image and uiid
Button(String text, Image icon) Constructor a button with text and image
Button(String text, Image icon, String id) Constructor a button with text, image and uiid
Button(String text, String id) Constructor a button with text and UIID

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Adds a listener to the button which will cause an event to dispatch on click
void	addStateChangeListener(ActionListener l) Adds a listener to be notified when the button state changes.
boolean	animate() Allows the animation to reduce "repaint" calls when it returns false.
void	bindStateTo(Button button) Bind the state of this button to another button's state.
protected Dimension	calcPreferredSize() Calculates the preferred size based on component content.
protected void	dragInitiated() Invoked on the focus component to let it know that drag has started on the parent container for the case of a component that doesn't support scrolling
protected void	fireActionEvent(int x, int y) Allows subclasses to override action event behavior
protected void	fireClicked() When working in 3 softbutton mode "fire" key (center softbutton) is sent to this method in order to allow 3 button devices to work properly.
Vector	getActionListeners() Deprecated. use getListeners instead
protected Border	getBorder() Normally returns getStyle().getBorder() but some subclasses might use this to programmatically replace the border in runtime e.g.
Command	getCommand() This method return the Button Command if exists
Image	getDisabledIcon() Indicates the icon that is displayed on the button when the button is in the disabled state
Image	getIconFromState() Returns the icon for the button based on its current state
Collection	getListeners() Returns a collection containing the action listeners for this button
Image	getPressedIcon() Indicates the icon that is displayed on the button when the button is in pressed state
int	getReleaseRadius() Indicates a radius in which a pointer release will still have effect.
Image	getRolloverIcon() Indicates the icon that is displayed on the button when the button is in rolled over state
Image	getRolloverPressedIcon() Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
int	getState() Returns the button state
boolean	isAutoRelease() Returns if this is an auto released Button.
static boolean	isButtonRippleEffectDefault() Default value for the button ripple effect, this can be set with the theme constant buttonRippleBool
boolean	isCapsText() Indicates whether text on the button should be drawn capitalized by default to match the Android design.
static boolean	isCapsTextDefault() Indicates whether text on the button should be drawn capitalized by default to match the Android design.
boolean	isOppositeSide() Places the check box or radio button on the opposite side at the far end
protected boolean	isSelectableInteraction() This method allows a component to indicate that it is interested in an "implicit" select command to appear in the "fire" button when 3 softbuttons are defined in a device.
boolean	isSelected() Returns true if the button is selected for toggle buttons,
boolean	isToggle() Toggle button mode is only relevant for checkboxes/radio buttons.
void	keyPressed(int keyCode) If this Component is focused, the key pressed event will call this method
void	keyReleased(int keyCode) If this Component is focused, the key released event will call this method
void	keyRepeated(int keyCode) If this Component is focused, the key repeat event will call this method.
void	paint(Graphics g) This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.
void	pointerHover(int[] x, int[] y) Invoked for devices where the pointer can hover without actually clicking the display.
void	pointerHoverReleased(int[] x, int[] y) Invoked for devices where the pointer can hover without actually clicking the display.
void	pointerPressed(int x, int y) If this Component is focused, the pointer pressed event will call this method
void	pointerReleased(int x, int y) If this Component is focused, the pointer released event will call this method
void	pressed() Invoked to change the state of the button to the pressed state
void	released() Invoked to change the state of the button to the released state
void	released(int x, int y) Invoked to change the state of the button to the released state
void	removeActionListener(ActionListener l) Removes the given action listener from the button
void	removeStateChangeListener(ActionListener l) Removes state change listener.
protected void	resetFocusable() Restores the state of the focusable flag to its default state
void	setAlignment(int align) Deprecated. use the Style alignment instead
void	setAutoRelease(boolean autoRelease) Sets the auto released mode of this button, by default it's not an auto released Button
static void	setButtonRippleEffectDefault(boolean aButtonRippleEffectDefault) Default value for the button ripple effect, this can be set with the theme constant buttonRippleBool
void	setCapsText(boolean capsText) Indicates whether text on the button should be drawn capitalized by default to match the Android design.
static void	setCapsTextDefault(boolean aCapsTextDefault) Indicates whether text on the button should be drawn capitalized by default to match the Android design This value can be set by the capsButtonTextBool theme constant
void	setCommand(Command cmd) Applies the given command to this button
void	setDisabledIcon(Image disabledIcon) Indicates the icon that is displayed on the button when the button is in the disabled state
void	setPressedIcon(Image pressedIcon) Indicates the icon that is displayed on the button when the button is in pressed state
void	setReleased() Set the button in released and unfocused state
void	setReleaseRadius(int releaseRadius) Indicates a radius in which a pointer release will still have effect.
void	setRolloverIcon(Image rolloverIcon) Indicates the icon that is displayed on the button when the button is in rolled over state
void	setRolloverPressedIcon(Image rolloverPressedIcon) Indicates the icon that is displayed on the button when the button is in pressed state and is selected.
void	setText(String t) Overriden to implement the caps mode setCapsText(boolean) Sets the Label text
void	setToggle(boolean toggle) Toggle button mode is only relevant for checkboxes/radio buttons.
void	setUIID(String id) Overriden to workaround issue with caps text and different UIID's This method sets the Component the Unique identifier.
void	unbindStateFrom(Button button) Unbinds the state of this button from another button.

Methods inherited from class com.codename1.ui.Label

bindProperty, getAlignment, getBadgeStyleComponent, getBadgeText, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBoundPropertyValue, getDefaultGap, getFontIcon, getFontIconSize, getGap, getIcon, getIconFont, getIconStyleComponent, getIconUIID, getMask, getMaskedIcon, getMaskName, getMaterialIcon, getMaterialIconSize, getMaxAutoSize, getMinAutoSize, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getShiftMillimeters, getShiftMillimetersF, getShiftText, getStringWidth, getText, getTextPosition, getTextSelectionSupport, getVerticalAlignment, initLaf, initUnselectedStyle, isAutoSizeMode, isDefaultTickerEnabled, isEndsWith3Points, isLegacyRenderer, isShouldLocalize, isShowEvenIfBlank, isTextSelectionEnabled, isTickerEnabled, isTickerRunning, laidOut, paramString, refreshTheme, setAutoSizeMode, setBadgeText, setBadgeUIID, setBoundPropertyValue, setDefaultGap, setDefaultTickerEnabled, setEndsWith3Points, setFontIcon, setFontIcon, setFontIcon, setGap, setIcon, setIconUIID, setLegacyRenderer, setMask, setMaskName, setMaterialIcon, setMaterialIcon, setMaxAutoSize, setMinAutoSize, setPropertyValue, setShiftMillimeters, setShiftMillimeters, setShiftText, setShouldLocalize, setShowEvenIfBlank, setTextPosition, setTextSelectionEnabled, setTickerEnabled, setVerticalAlignment, shouldTickerStart, startTicker, startTicker, stopTicker, styleChanged, unbindProperty

Methods inherited from class com.codename1.ui.Component

addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, blocksSideSwipe, calcScrollSize, cancelRepaints, clearClientProperties, contains, containsOrOwns, createStyleAnimation, deinitialize, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, drop, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBottomGap, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDefaultDragTransparency, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getDragTransparency, getEditingDelegate, getGridPosX, getGridPosY, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getSideGap, getStyle, getTabIndex, getTensileLength, getTooltip, getUIID, getUIManager, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initComponent, initCustomStyle, initDisabledStyle, initPressedStyle, initSelectedStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isEnabled, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isPinchBlocksDragAndDrop, isRippleEffect, isRTL, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, paintShadows, parsePreferredSize, pinch, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHoverPressed, pointerPressed, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, repaint, repaint, requestFocus, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setCellRenderer, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDefaultDragTransparency, setDirtyRegion, setDisabledStyle, setDraggable, setDragTransparency, setDropTarget, setEditingDelegate, setEnabled, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPinchBlocksDragAndDrop, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldBlockSideSwipeLeft, shouldBlockSideSwipeRight, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, toImage, toString, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.codename1.ui.IconHolder

getGap, getIcon, getIconStyleComponent, getIconUIID, getTextPosition, setFontIcon, setGap, setIcon, setIconUIID, setMaterialIcon, setTextPosition

Field Detail

STATE_ROLLOVER

public static final int STATE_ROLLOVER

Indicates the rollover state of a button which is equivalent to focused for most uses

See Also:

Constant Field Values

STATE_PRESSED

public static final int STATE_PRESSED

Indicates the pressed state of a button

See Also:

Constant Field Values

STATE_DEFAULT

public static final int STATE_DEFAULT

Indicates the default state of a button which is neither pressed nor focused

See Also:

Constant Field Values

Constructor Detail

Button

public Button()

Constructs a button with an empty string for its text.

Button

public Button(String text)

Constructs a button with the specified text.

Parameters:

text - label appearing on the button

Button

public Button(Command cmd)

Allows binding a command to a button for ease of use

Parameters:

cmd - command whose text would be used for the button and would recive action events from the button

Button

public Button(Image icon)

Constructs a button with the specified image.

Parameters:

icon - appearing on the button

Button

public Button(char icon)

Constructs a button with the specified material image icon.

Parameters:

icon - appearing on the button

Button

public Button(String text,
              char icon,
              String id)

Constructor a button with text, material image and uiid

Parameters:

text - label appearing on the button

icon - image appearing on the button

id - UIID unique identifier for button

Button

public Button(String text,
              char icon,
              float iconSize,
              String id)

Constructor a button with text, material image and uiid

Parameters:

text - label appearing on the button

icon - image appearing on the button

iconSize - image size in millimeters

id - UIID unique identifier for button

Button

public Button(String text,
              Image icon,
              String id)

Constructor a button with text, image and uiid

Parameters:

text - label appearing on the button

icon - image appearing on the button

id - UIID unique identifier for button

Button

public Button(String text,
              Image icon)

Constructor a button with text and image

Parameters:

text - label appearing on the button

icon - image appearing on the button

Button

public Button(Image icon,
              String id)

Constructor a button with image and UIID

Parameters:

icon - image appearing on the button

id - UIID unique identifier for button

Button

public Button(char icon,
              String id)

Constructor a button with material image icon and UIID

Parameters:

icon - image appearing on the button

id - UIID unique identifier for button

Button

public Button(char icon,
              float iconSize,
              String id)

Constructor a button with material image icon and UIID

Parameters:

icon - image appearing on the button

iconSize - the size of the icon in millimeters

id - UIID unique identifier for button

Button

public Button(String text,
              String id)

Constructor a button with text and UIID

Parameters:

text - label appearing on the button

id - UIID unique identifier for button

Method Detail

isCapsTextDefault

public static boolean isCapsTextDefault()

Indicates whether text on the button should be drawn capitalized by default to match the Android design. This value can be set by the capsButtonTextBool theme constant

Returns:

the capsTextDefault

setCapsTextDefault

public static void setCapsTextDefault(boolean aCapsTextDefault)

Indicates whether text on the button should be drawn capitalized by default to match the Android design This value can be set by the capsButtonTextBool theme constant

Parameters:

aCapsTextDefault - the capsTextDefault to set

isButtonRippleEffectDefault

public static boolean isButtonRippleEffectDefault()

Default value for the button ripple effect, this can be set with the theme constant buttonRippleBool

Returns:

the buttonRippleEffectDefault

setButtonRippleEffectDefault

public static void setButtonRippleEffectDefault(boolean aButtonRippleEffectDefault)

Default value for the button ripple effect, this can be set with the theme constant buttonRippleBool

Parameters:

aButtonRippleEffectDefault - the buttonRippleEffectDefault to set

setCommand

public void setCommand(Command cmd)

Applies the given command to this button

Parameters:

cmd - the command on the button

bindStateTo

public void bindStateTo(Button button)

Bind the state of this button to another button's state. Once bound, when the other button's state changes, this button will change its state to match.

Parameters:

button - The button whose state to bind to.

Since:

7.0

See Also:

unbindStateFrom(com.codename1.ui.Button)

unbindStateFrom

public void unbindStateFrom(Button button)

Unbinds the state of this button from another button.

Parameters:

button - The button to unbind state from.

Since:

7.0

See Also:

bindStateTo(com.codename1.ui.Button)

resetFocusable

protected void resetFocusable()

Restores the state of the focusable flag to its default state

Overrides:

resetFocusable in class Component

getState

public int getState()

Returns the button state

Returns:

One of STATE_ROLLOVER, STATE_DEAFULT, STATE_PRESSED

setReleased

public void setReleased()

Set the button in released and unfocused state

Specified by:

setReleased in interface ReleasableComponent

getPressedIcon

public Image getPressedIcon()

Indicates the icon that is displayed on the button when the button is in pressed state

Specified by:

getPressedIcon in interface SelectableIconHolder

Returns:

icon used

See Also:

STATE_PRESSED

getRolloverPressedIcon

public Image getRolloverPressedIcon()

Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons

Specified by:

getRolloverPressedIcon in interface SelectableIconHolder

Returns:

icon used

setRolloverPressedIcon

public void setRolloverPressedIcon(Image rolloverPressedIcon)

Indicates the icon that is displayed on the button when the button is in pressed state and is selected. This is ONLY applicable to toggle buttons

Specified by:

setRolloverPressedIcon in interface SelectableIconHolder

Parameters:

rolloverPressedIcon - icon used

getDisabledIcon

public Image getDisabledIcon()

Indicates the icon that is displayed on the button when the button is in the disabled state

Specified by:

getDisabledIcon in interface SelectableIconHolder

Returns:

icon used

getRolloverIcon

public Image getRolloverIcon()

Indicates the icon that is displayed on the button when the button is in rolled over state

Specified by:

getRolloverIcon in interface SelectableIconHolder

Returns:

icon used

See Also:

STATE_ROLLOVER

setRolloverIcon

public void setRolloverIcon(Image rolloverIcon)

Indicates the icon that is displayed on the button when the button is in rolled over state

Specified by:

setRolloverIcon in interface SelectableIconHolder

Parameters:

rolloverIcon - icon to use

See Also:

STATE_ROLLOVER

setPressedIcon

public void setPressedIcon(Image pressedIcon)

Indicates the icon that is displayed on the button when the button is in pressed state

Specified by:

setPressedIcon in interface SelectableIconHolder

Parameters:

pressedIcon - icon used

See Also:

STATE_PRESSED

setDisabledIcon

public void setDisabledIcon(Image disabledIcon)

Indicates the icon that is displayed on the button when the button is in the disabled state

Specified by:

setDisabledIcon in interface SelectableIconHolder

Parameters:

disabledIcon - icon used

addStateChangeListener

public void addStateChangeListener(ActionListener l)

Adds a listener to be notified when the button state changes.

Overrides:

addStateChangeListener in class Component

Parameters:

l - Listener to be notified when state changes

Since:

7.0

See Also:

getState(), setState(int), removeStateChangeListener(com.codename1.ui.events.ActionListener)

removeStateChangeListener

public void removeStateChangeListener(ActionListener l)

Removes state change listener.

Overrides:

removeStateChangeListener in class Component

Parameters:

l - State change listener to remove.

Since:

7.0

See Also:

addStateChangeListener(com.codename1.ui.events.ActionListener), getState(), setState(int)

addActionListener

public void addActionListener(ActionListener l)

Adds a listener to the button which will cause an event to dispatch on click

Specified by:

addActionListener in interface ActionSource

Parameters:

l - implementation of the action listener interface

removeActionListener

public void removeActionListener(ActionListener l)

Removes the given action listener from the button

Specified by:

removeActionListener in interface ActionSource

Parameters:

l - implementation of the action listener interface

getActionListeners

public Vector getActionListeners()

Deprecated. use getListeners instead

Returns a vector containing the action listeners for this button

Returns:

the action listeners

getListeners

public Collection getListeners()

Returns a collection containing the action listeners for this button

Returns:

the action listeners

getIconFromState

public Image getIconFromState()

Returns the icon for the button based on its current state

Specified by:

getIconFromState in interface SelectableIconHolder

Returns:

the button icon based on its current state

fireActionEvent

protected void fireActionEvent(int x,
                               int y)

Allows subclasses to override action event behavior

Parameters:

x - the x position of the click if applicable (can be 0 or -1 otherwise)

y - the y position of the click if applicable (can be 0 or -1 otherwise)

pressed

public void pressed()

Invoked to change the state of the button to the pressed state

released

public void released()

Invoked to change the state of the button to the released state

released

public void released(int x,
                     int y)

Invoked to change the state of the button to the released state

Parameters:

x - the x position if a touch event triggered this, -1 if this isn't relevant

y - the y position if a touch event triggered this, -1 if this isn't relevant

keyPressed

public void keyPressed(int keyCode)

If this Component is focused, the key pressed event will call this method

Overrides:

keyPressed in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

keyReleased

public void keyReleased(int keyCode)

If this Component is focused, the key released event will call this method

Overrides:

keyReleased in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

keyRepeated

public void keyRepeated(int keyCode)

If this Component is focused, the key repeat event will call this method.

Overrides:

keyRepeated in class Component

Parameters:

keyCode - the key code value to indicate a physical key.

fireClicked

protected void fireClicked()

When working in 3 softbutton mode "fire" key (center softbutton) is sent to this method in order to allow 3 button devices to work properly. When overriding this method you should also override isSelectableInteraction to indicate that a command is placed appropriately on top of the fire key for 3 soft button phones.

Overrides:

fireClicked in class Component

isSelectableInteraction

protected boolean isSelectableInteraction()

This method allows a component to indicate that it is interested in an "implicit" select command to appear in the "fire" button when 3 softbuttons are defined in a device.

Overrides:

isSelectableInteraction in class Component

Returns:

true if this is a selectable interaction

pointerHover

public void pointerHover(int[] x,
                         int[] y)

Invoked for devices where the pointer can hover without actually clicking the display. This is true for PC mouse pointer as well as some devices such as the BB storm.

Overrides:

pointerHover in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerHoverReleased

public void pointerHoverReleased(int[] x,
                                 int[] y)

Invoked for devices where the pointer can hover without actually clicking the display. This is true for PC mouse pointer as well as some devices such as the BB storm.

Overrides:

pointerHoverReleased in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerPressed

public void pointerPressed(int x,
                           int y)

If this Component is focused, the pointer pressed event will call this method

Overrides:

pointerPressed in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

pointerReleased

public void pointerReleased(int x,
                            int y)

If this Component is focused, the pointer released event will call this method

Overrides:

pointerReleased in class Component

Parameters:

x - the pointer x coordinate

y - the pointer y coordinate

dragInitiated

protected void dragInitiated()

Invoked on the focus component to let it know that drag has started on the parent container for the case of a component that doesn't support scrolling

Overrides:

dragInitiated in class Component

calcPreferredSize

protected Dimension calcPreferredSize()

Calculates the preferred size based on component content. This method is invoked lazily by getPreferred size.

Overrides:

calcPreferredSize in class Label

Returns:

the calculated preferred size based on component content

getBorder

protected Border getBorder()

Normally returns getStyle().getBorder() but some subclasses might use this to programmatically replace the border in runtime e.g. for a pressed border effect

Overrides:

getBorder in class Component

Returns:

the border that is drawn according to the current component state

getCommand

public Command getCommand()

This method return the Button Command if exists

Returns:

Command Object or null if a Command not exists

isSelected

public boolean isSelected()

Returns true if the button is selected for toggle buttons,

Returns:

true if the button is selected

setAlignment

public void setAlignment(int align)

Deprecated. use the Style alignment instead

Sets the Alignment of the Label to one of: CENTER, LEFT, RIGHT

Overrides:

setAlignment in class Label

Parameters:

align - alignment value

See Also:

Component.CENTER, Component.LEFT, Component.RIGHT

isToggle

public boolean isToggle()

Toggle button mode is only relevant for checkboxes/radio buttons. When pressed a toggle button stays pressed and when pressed again it moves to releleased state.

Returns:

the toggle

setToggle

public void setToggle(boolean toggle)

Toggle button mode is only relevant for checkboxes/radio buttons. When pressed a toggle button stays pressed and when pressed again it moves to releleased state. Setting toggle implicitly changes the UIID to "ToggleButton"

Parameters:

toggle - the toggle to set

setUIID

public void setUIID(String id)

Overriden to workaround issue with caps text and different UIID's This method sets the Component the Unique identifier. This method should be used before a component has been initialized

Overrides:

setUIID in class Label

Parameters:

id - UIID unique identifier for component type

animate

public boolean animate()

Allows the animation to reduce "repaint" calls when it returns false. It is called once for every frame. Frames are defined by the Display class.

Specified by:

animate in interface Animation

Overrides:

animate in class Label

Returns:

true if a repaint is desired or false if no repaint is necessary

isOppositeSide

public boolean isOppositeSide()

Places the check box or radio button on the opposite side at the far end

Returns:

the oppositeSide

getReleaseRadius

public int getReleaseRadius()

Indicates a radius in which a pointer release will still have effect. Notice that this only applies to pointer release events and not to pointer press events

Specified by:

getReleaseRadius in interface ReleasableComponent

Returns:

the releaseRadius

setReleaseRadius

public void setReleaseRadius(int releaseRadius)

Indicates a radius in which a pointer release will still have effect. Notice that this only applies to pointer release events and not to pointer press events

Specified by:

setReleaseRadius in interface ReleasableComponent

Parameters:

releaseRadius - the releaseRadius to set

isAutoRelease

public boolean isAutoRelease()

Returns if this is an auto released Button. Auto released Buttons will are been disarmed when a drag is happening within the Button.

Specified by:

isAutoRelease in interface ReleasableComponent

Returns:

true if it's an auto released Button.

setAutoRelease

public void setAutoRelease(boolean autoRelease)

Sets the auto released mode of this button, by default it's not an auto released Button

Specified by:

setAutoRelease in interface ReleasableComponent

paint

public void paint(Graphics g)

Description copied from class: Label

This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.

Specified by:

paint in interface Animation

Overrides:

paint in class Label

Parameters:

g - the component graphics

isCapsText

public final boolean isCapsText()

Indicates whether text on the button should be drawn capitalized by default to match the Android design. By default only Button and RaisedButton will be capped to keep compatibility. You can add additional UIID's to the mix by using the theme constant capsButtonUiids which can include a separated list of the UIID's to capitalize

Returns:

the capsText

setCapsText

public void setCapsText(boolean capsText)

Indicates whether text on the button should be drawn capitalized by default to match the Android design. By default only Button and RaisedButton will be capped to keep compatibility. You can add additional UIID's to the mix by using the theme constant capsButtonUiids which can include a separated list of the UIID's to capitalize

Parameters:

capsText - the capsText to set

setText

public void setText(String t)

Overriden to implement the caps mode setCapsText(boolean) Sets the Label text

Specified by:

setText in interface TextHolder

Overrides:

setText in class Label

Parameters:

t - the string that the label presents.