SHOW Colour

net.rim.device.api.ui.component
Class ButtonField

java.lang.Object
  |
  +--net.rim.device.api.ui.Field
        |
        +--net.rim.device.api.ui.component.ButtonField

All Implemented Interfaces:

DrawStyle, IComponent, InputMethodListener

public class ButtonField

extends Field

implements DrawStyle

Contains a button control.

Use a FieldChangeListener to get notifications when the user presses the button in this field.

Behaviour
Displays a button.

Field Summary

static int

BARE Don't draw button outline.

Fields inherited from class net.rim.device.api.ui.Field

EDITABLE, EDITABLE_MASK, FIELD_BOTTOM, FIELD_HALIGN_MASK, FIELD_HCENTER, FIELD_LEFT, FIELD_RIGHT, FIELD_TOP, FIELD_VALIGN_MASK, FIELD_VCENTER, FOCUSABLE, FOCUSABLE_MASK, HIGHLIGHT_FOCUS, HIGHLIGHT_SELECT, NON_FOCUSABLE, READONLY, USE_ALL_HEIGHT, USE_ALL_WIDTH

Fields inherited from interface net.rim.device.api.ui.DrawStyle

BASELINE, BOTTOM, ELLIPSIS, HALIGN_MASK, HCENTER, HDEFAULT, HFULL, LEADING, LEFT, RIGHT, TOP, TRAILING, TRUNCATE_BEGINNING, VALIGN_MASK, VCENTER, VDEFAULT, VFULL

Constructor Summary

	ButtonField() Constructs a new ButtonField instance.
	ButtonField(long style) Constructs a new ButtonField instance with provided style.
	ButtonField(String label) Constructs a new ButtonField instance with provided label.
	ButtonField(String label, long style) Constructs a new ButtonField instance with provided label and style.

Method Summary

	protected void	drawFocus(Graphics graphics, boolean on) Draws the focus indicator for this field.
	String	getLabel() Retrieves this field's label.
	int	getPreferredHeight() Retrieves this field's preferred height.
	int	getPreferredWidth() Retrieves this field's preferred width.
	protected boolean	keyChar(char key, int status, int time) Traps ENTER key generation events.
	protected void	layout(int width, int height) Lays out this field's contents.
	protected void	paint(Graphics graphics) Redraws this field.
	void	setLabel(String label) Sets label string for this field.
	protected boolean	trackwheelClick(int status, int time) Indicates a trackwheel click event.

Methods inherited from class net.rim.device.api.ui.Field

drawHighlightRegion, fieldChangeNotify, focusAdd, focusRemove, getChangeListener, getContextMenu, getCookie, getExtent, getFieldStyle, getFocusListener, getFocusRect, getFont, getHeight, getIndex, getLeafFieldWithFocus, getLeft, getManager, getOriginal, getScreen, getStyle, getTop, getWidth, invalidate, invalidate, isDirty, isEditable, isFocusable, isMuddy, isPasteable, isSelectable, isSelecting, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isVisible, keyControl, keyDown, keyRepeat, keyStatus, keyUp, makeContextMenu, moveFocus, moveFocus, onFocus, onUnfocus, onVisibilityChange, paste, select, selectionCopy, selectionCut, selectionDelete, setChangeListener, setCookie, setDirty, setEditable, setExtent, setFocus, setFocusListener, setFont, setMuddy, setPosition, trackwheelUnclick, updateLayout

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BARE

public static final int BARE

Don't draw button outline.

Bare buttons show only the button label. Non-bare buttons show a rounded rectangular border around the button label.

Constructor Detail

ButtonField

public ButtonField()

Constructs a new ButtonField instance.

ButtonField

public ButtonField(long style)

Constructs a new ButtonField instance with provided style.

Parameters:

style - Field style for the button: can be a combation of any generic field style, BARE, DrawStyle.ELLIPSIS, Field.FOCUSABLE and Field.NON_FOCUSABLE.

ButtonField

public ButtonField(String label)

Constructs a new ButtonField instance with provided label.

Provided a label string to show, this method builds a button field in the default style.

Parameters:

label - Label string for the button.

ButtonField

public ButtonField(String label,
                   long style)

Constructs a new ButtonField instance with provided label and style.

Provided a label string to show, and a style, this method builds a button field using your style.

Parameters:

label - Label string for the button.

style - Field style for the button: can be a combation of any generic field style, BARE, DrawStyle.ELLIPSIS, Field.FOCUSABLE and Field.NON_FOCUSABLE.

Method Detail

drawFocus

protected void drawFocus(Graphics graphics,
                         boolean on)

Draws the focus indicator for this field.

This field's manager invokes this method after painting this field. The manager initializes the graphics object passed in for drawing with field-local coordinates.

This msethod inverts the focus rect obtained from Field.getFocusRect(net.rim.device.api.ui.XYRect).

Overrides:

drawFocus in class Field

Parameters:

graphics - Graphics context used for drawing the focus.

on - True if the focus should be set; otherwise, false.

Since:

JDE 3.7.0

getLabel

public String getLabel()

Retrieves this field's label.

Returns:

Label string for this field.

getPreferredWidth

public int getPreferredWidth()

Retrieves this field's preferred width.

This field's manager invokes this method to assist in its layout.

Overrides:

getPreferredWidth in class Field

Returns:

Preferred width (in pixels) of this field.

getPreferredHeight

public int getPreferredHeight()

Retrieves this field's preferred height.

This field's manager invokes this method to assist in its layout.

Overrides:

getPreferredHeight in class Field

Returns:

Preferred height (in pixels) of this field.

keyChar

protected boolean keyChar(char key,
                          int status,
                          int time)

Traps ENTER key generation events.

This method handles and consumes a key generation event, if it's the ENTER key that's generated; otherwise, this method does nothing and does not consume the event.

Overrides:

keyChar in class Field

Parameters:

key - Character generated by the event.

status - Modifier key status (this parameter is ignored).

time - Ticks since device reset (this parameter is ignored).

Returns:

True if the ENTER key was pressed, and this method handled the event; otherwise, false.

Since:

JDE 3.7.0

layout

protected void layout(int width,
                      int height)

Lays out this field's contents.

This field's manager invokes this method during the layout process to instruct this field to arrange its contents, given an amount of available space.

Overrides:

layout in class Field

Parameters:

width - Amount of available horizontal space.

height - Amount of available vertical space.

Since:

JDE 3.7.0

paint

protected void paint(Graphics graphics)

Redraws this field.

This field's manager invokes this method during the repainting process to instruct this field to repaint itself.

Overrides:

paint in class Field

Parameters:

graphics - Graphics context for repainting this field.

Since:

JDE 3.7.0

setLabel

public void setLabel(String label)

Sets label string for this field.

Parameters:

label - Label string for this field.

Since:

JDE 3.7.0

trackwheelClick

protected boolean trackwheelClick(int status,
                                  int time)

Indicates a trackwheel click event.

The system invokes this method when passing on a trackwheel click event. This method is transparent, and the event is not consumed.

Overrides:

trackwheelClick in class Field

Parameters:

status - State of the modifier keys.

time - Ticks since device reset.

Returns:

False (event not consumed).

Since:

JDE 3.7.0