net.rim.device.api.ui.toolbar
Class ShowKeyboardToolbarButtonField

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by net.rim.device.api.ui.toolbar.ToolbarButtonField
          extended by net.rim.device.api.ui.toolbar.ShowKeyboardToolbarButtonField
All Implemented Interfaces:
Runnable

public class ShowKeyboardToolbarButtonField
extends ToolbarButtonField

A toolbar button that displays the VirtualKeyboard.

When a user clicks on this button in the toolbar, the VirtualKeyboard is displayed and the toolbar is minimized.

Since:
BlackBerry API 6.0.0

Field Summary
 
Fields inherited from class net.rim.device.api.ui.Field
ACTION_INVOKE, AXIS_HORIZONTAL, AXIS_SEQUENTIAL, AXIS_VERTICAL, EDITABLE, EDITABLE_MASK, FIELD_BOTTOM, FIELD_HALIGN_MASK, FIELD_HCENTER, FIELD_LEADING, FIELD_LEFT, FIELD_RIGHT, FIELD_TOP, FIELD_TRAILING, FIELD_VALIGN_MASK, FIELD_VCENTER, FOCUSABLE, FOCUSABLE_MASK, HIGHLIGHT_FOCUS, HIGHLIGHT_SELECT, NON_FOCUSABLE, NON_SPELLCHECKABLE, READONLY, SPELLCHECKABLE, SPELLCHECKABLE_MASK, STATUS_MOVE_FOCUS_HORIZONTALLY, STATUS_MOVE_FOCUS_VERTICALLY, USE_ALL_HEIGHT, USE_ALL_WIDTH, VISUAL_STATE_ACTIVE, VISUAL_STATE_DISABLED, VISUAL_STATE_DISABLED_FOCUS, VISUAL_STATE_FOCUS, VISUAL_STATE_NORMAL
 
Constructor Summary
ShowKeyboardToolbarButtonField()
          Creates an instance of the ShowKeyboardToolbarButtonField.
ShowKeyboardToolbarButtonField(int ordinal)
          Creates an instance of the ShowKeyboardToolbarButtonField.
 
Method Summary
 void invoke()
          Displays the VirtualKeyboard.
 void setEnabled(boolean enabled)
          Enables or disables this button.
 
Methods inherited from class net.rim.device.api.ui.toolbar.ToolbarButtonField
getCommand, getImage, getOrdinal, getPreferredHeight, getPreferredWidth, getText, getTooltip, isEnabled, layout, onDisplay, onExposed, onObscured, paint, run, setCommand, setCommandContext, setImage, setText, setTooltip, touchEvent
 
Methods inherited from class net.rim.device.api.ui.Field
drawFocus, drawHighlightRegion, fieldChangeNotify, focusAdd, focusRemove, getAccessibleContext, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getCommandItemProvider, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFocusRect, getFont, getHeight, getIndex, getLeafFieldWithFocus, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getScreen, getStyle, getTop, getVisualState, getWidth, invalidate, invalidate, invalidateAll, invokeAction, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isPasteable, isScrollCopyable, isSelectable, isSelecting, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, keyChar, keyControl, keyDown, keyRepeat, keyStatus, keyUp, makeContextMenu, moveFocus, moveFocus, navigationClick, navigationMovement, navigationUnclick, onFocus, onMenuDismissed, onMenuDismissed, onUndisplay, onUnfocus, onVisibilityChange, paste, select, selectionCopy, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCommandItemProvider, setCookie, setDirty, setEditable, setExtent, setFocus, setFocusListener, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPadding, setPadding, setPosition, setVisualState, trackwheelClick, trackwheelUnclick, updateLayout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

ShowKeyboardToolbarButtonField

public ShowKeyboardToolbarButtonField()
Creates an instance of the ShowKeyboardToolbarButtonField.

Since:
BlackBerry API 6.0.0

ShowKeyboardToolbarButtonField

public ShowKeyboardToolbarButtonField(int ordinal)
Creates an instance of the ShowKeyboardToolbarButtonField.

Parameters:
ordinal - Ordinal for this ToolbarButtonField.
Since:
BlackBerry API 6.0.0


Method Detail

invoke

public void invoke()
Displays the VirtualKeyboard.

Overrides:
invoke in class ToolbarButtonField
Since:
BlackBerry API 6.0.0

setEnabled

public void setEnabled(boolean enabled)
Enables or disables this button. If the device does not allow the display of the virtual keyboard, this button is always disabled. If the virtual keyboard is allowed, then the value of enabled is used to determine this button's enabled/disabled status.

Overrides:
setEnabled in class ToolbarButtonField
Parameters:
enabled - If true, this button is enabled; false otherwise.
Since:
BlackBerry API 6.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.