com.sun.lwuit
Class Button

java.lang.Object
  com.sun.lwuit.Component
      com.sun.dtv.ui.MatteEnabledComponent
          com.sun.dtv.ui.ViewOnlyComponent
              com.sun.lwuit.Label
                  com.sun.lwuit.Button

All Implemented Interfaces:

Animated, MatteEnabled, StyleListener

Direct Known Subclasses:

CheckBox, RadioButton

public class Button

extends Label

Button is the base class for several UI widgets allowing clickability. It has 3 states: rollover, pressed and the default state it can also have ActionListeners that react when the Button is clicked.

Field Summary

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.sun.dtv.ui.ViewOnlyComponent

HORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, SCALE_ASPECT_PROOF, SCALE_NO, SCALE_NO_ASPECT_PROOF, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_CENTER, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_TOP

Fields inherited from class com.sun.lwuit.Component

BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, LEFT, RIGHT, TOP

Fields inherited from interface com.sun.dtv.ui.Animated

ALTERNATING, LOOP, REPEATING

Constructor Summary

Button()
Constructs a button with an empty string for its text.

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(String text)
Constructs a button with the specified text.

Button(String text, Image icon)
Constructor a button with text and image.

Method Summary

void	addActionListener(ActionListener l) Adds a listener to the button which will cause an event to dispatch on click.
protected Dimension	calcPreferredSize() Calculates the preferred size based on component content.
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.
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
Image	getPressedIcon() Indicates the icon that is displayed on the button when the button is in pressed state.
Image	getRolloverIcon() Indicates the icon that is displayed on the button when the button is in rolled over state.
int	getState() Returns the button state.
protected String	getUIID() Unique identifier for a component, must be overriden for a component so a style can be applied to the component.
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.
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	paint(Graphics g) Method to paint the component.
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	removeActionListener(ActionListener l) Removes the given action listener from the button.
void	setPressedIcon(Image pressedIcon) Indicates the icon that is displayed on the button when the button is in pressed state.
void	setRolloverIcon(Image rolloverIcon) Indicates the icon that is displayed on the button when the button is in rolled over state.

Methods inherited from class com.sun.lwuit.Label

animate, getAlignment, getBaselineResizeBehavior, getGap, getIcon, getShiftText, getText, getTextPosition, getVerticalAlignment, isEndsWith3Points, isTickerEnabled, isTickerRunning, paramString, setAlignment, setEndsWith3Points, setGap, setIcon, setShiftText, setText, setTextPosition, setTickerEnabled, setVerticalAlignment, startTicker, stopTicker

Methods inherited from class com.sun.dtv.ui.ViewOnlyComponent

getAnimateContent, getGraphicContent, getHorizontalAlignment, getInteractionState, getScalingMode, getTextContent, getTextLayoutManager, isOpaque, setAnimateContent, setGraphicContent, setHorizontalAlignment, setInteractionState, setScalingMode, setTextContent, setTextLayoutManager

Methods inherited from class com.sun.dtv.ui.MatteEnabledComponent

getMatte, isDoubleBuffered, processEvent, setMatte

Methods inherited from class com.sun.lwuit.Component

addFocusListener, contains, deinitialize, getAbsoluteX, getAbsoluteY, getAnimationMode, getBaseline, getBottomGap, getBounds, getClientProperty, getComponentForm, getDelay, getHeight, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getParent, getPosition, getPreferredSize, getRepetitionMode, getScrollAnimationSpeed, getScrollX, getScrollY, getSideGap, getStyle, getWidth, getX, getY, handlesInput, hasFocus, initComponent, isEnabled, isFocusable, isFocusPainted, isInitialized, isRunning, isScrollable, isScrollableX, isScrollableY, isScrollVisible, isSmoothScrolling, isVisible, jumpTo, keyRepeated, longKeyPress, paintBackground, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintScrollbars, paintScrollbarX, paintScrollbarY, pointerDragged, putClientProperty, refreshTheme, refreshTheme, removeFocusListener, repaint, repaint, requestFocus, scrollRectToVisible, setAnimationMode, setCellRenderer, setDelay, setEnabled, setFocus, setFocusable, setFocusPainted, setHandlesInput, setHeight, setInitialized, setIsScrollVisible, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredSize, setRepetitionMode, setScrollAnimationSpeed, setScrollX, setScrollY, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setStyle, setVisible, setWidth, setX, setY, start, stop, styleChanged, toString

Methods inherited from class java.lang.Object

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

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 receive 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(String text,
              Image icon)

Constructor a button with text and image.

Parameters:

text - label appearing on the button

icon - image appearing on the button

Method Detail

getUIID

protected String getUIID()

Description copied from class: Component

Unique identifier for a component, must be overriden for a component so a style can be applied to the component.

Overrides:

getUIID in class Label

getState

public int getState()

Returns the button state.

Returns:

One of STATE_ROLLOVER, STATE_DEAFULT, STATE_PRESSED

getPressedIcon

public Image getPressedIcon()

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

Returns:

icon used

See Also:

setPressedIcon(com.sun.lwuit.Image), STATE_PRESSED

getRolloverIcon

public Image getRolloverIcon()

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

Returns:

icon used

See Also:

setRolloverIcon(com.sun.lwuit.Image), 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.

Parameters:

rolloverIcon - icon to use

See Also:

getRolloverIcon(), STATE_ROLLOVER

setPressedIcon

public void setPressedIcon(Image pressedIcon)

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

Parameters:

pressedIcon - icon used

See Also:

getPressedIcon(), STATE_PRESSED

addActionListener

public void addActionListener(ActionListener l)

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

Parameters:

l - implementation of the action listener interface

See Also:

removeActionListener(com.sun.lwuit.events.ActionListener)

removeActionListener

public void removeActionListener(ActionListener l)

Removes the given action listener from the button.

Parameters:

l - implementation of the action listener interface

See Also:

addActionListener(com.sun.lwuit.events.ActionListener)

keyPressed

public void keyPressed(int keyCode)

Description copied from class: Component

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)

Description copied from class: Component

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.

fireClicked

protected void fireClicked()

Description copied from class: Component

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()

Description copied from class: Component

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

pointerPressed

public void pointerPressed(int x,
                           int y)

Description copied from class: Component

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)

Description copied from class: Component

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

paint

public void paint(Graphics g)

Description copied from class: ViewOnlyComponent

Method to paint the component.

Specified by:

paint in interface Animated

Overrides:

paint in class Label

calcPreferredSize

protected Dimension calcPreferredSize()

Description copied from class: Component

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

Overrides:

calcPreferredSize in class Label

getBorder

protected Border getBorder()

Description copied from class: Component

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