net.rim.device.api.input
Class InputHelper

java.lang.Object
  net.rim.device.api.ui.Field
      net.rim.device.api.ui.component.TextFieldBase
          net.rim.device.api.input.InputHelperBase
              net.rim.device.api.input.InputHelper

All Implemented Interfaces:

ITextInputStyle

Direct Known Subclasses:

AutoTextInputHelper, EmailAddressInputHelper, PasswordInputHelper, PhoneNumberInputHelper

public class InputHelper
extends InputHelperBase

Adds lookup popup look-and-feel properties feature and lookup variants access functionality to the base input helper.

Since:

BlackBerry API 6.0.0

Field Summary

Fields inherited from class net.rim.device.api.input.InputHelperBase

CONSUME_INPUT, NO_NEWLINE

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

InputHelper()
Constructs an InputHelper instance.

InputHelper(long inputStyle)
Constructs an InputHelper instance.

InputHelper(Screen scr)
Constructs an InputHelper instance.

InputHelper(Screen scr, long inputStyle)
Constructs an InputHelper instance with specified input style.

Method Summary
LookupProperties	getLookupProperties() Gets current lookup properties been set for the InputHelper object.
LookupVariantIterator	getVariantIterator() Lookup variant iterator is created only once by a variant listener, e.g. by InputHelper, and then is re-initialized repeatedly by an input method with variants.
void	notifyLookupPropertiesChanged() This method is to be called by the owning 3rd party application if it changed the InputHelper's lookup properties and wants them to be applied while having the InputHelper as the current input component continuously (having no focus switch).

Methods inherited from class net.rim.device.api.input.InputHelperBase

backspace, backspace, backspace, charAt, clear, displayFieldFullMessage, fieldChangeNotify, getAccessibleContext, getAnchorPosition, getAssociatedScreen, getCaretPosition, getCharVariants, getCursorPosition, getFilter, getLabel, getLabelLength, getMaxSize, getText, getText, getText, getTextAbstractString, getTextInputConnector, getTextLength, insert, insert, isFocusable, isPasteable, isScreenInput, isSelectable, isSelecting, isSelectionCopyable, isSelectionDeleteable, isSymbolScreenAllowed, keyChar, keyControl, makeContextMenu, paste, select, selectionCopy, selectionDelete, setCursorPosition, setCursorPosition, setFilter, setFont, setInputStyle, setLabel, setLookupPosition, setMIDPDisplayable, setMaxSize, setScreenInput, setSelection, setText, setText, setTextInputConnector, update, update, wipe

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

cursorClick, cursorUnclick, drawFocus, drawHighlightRegion, focusAdd, focusRemove, 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, getPreferredHeight, getPreferredWidth, getScreen, getStyle, getTextFillColor, getTextStrokeColor, getTop, getVisualState, getWidth, invalidate, invalidate, invalidateAll, invokeAction, isDataValid, isDirty, isEditable, isEnabled, isFocus, isLeftToRight, isMuddy, isScrollCopyable, isSelectionCutable, isSpellCheckable, isStyle, isVisible, keyDown, keyRepeat, keyStatus, keyUp, layout, moveFocus, moveFocus, navigationClick, navigationMovement, navigationUnclick, onDisplay, onExposed, onFocus, onMenuDismissed, onMenuDismissed, onObscured, onUndisplay, onUnfocus, onVisibilityChange, paint, selectionCut, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCommandItemProvider, setCookie, setDirty, setEditable, setEnabled, setExtent, setFocus, setFocusListener, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPadding, setPadding, setPosition, setVisualState, touchEvent, trackwheelClick, trackwheelUnclick, updateLayout

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.rim.device.api.im.ITextInputStyle

getPreferredInputLocale, getTextInputStyle, isEditable, isUnicodeInputAllowed, updateInputStyle

Constructor Detail

InputHelper

public InputHelper()

Constructs an InputHelper instance.

Since:

BlackBerry API 6.0.0

InputHelper

public InputHelper(long inputStyle)

Constructs an InputHelper instance.

Parameters:

inputStyle - Combination of field style bits to specify display and filter attributes, e.g. BasicEditField.FILTER_NUMERIC, Field.EDITABLE, Field.FOCUSABLE.

Since:

BlackBerry API 6.0.0

InputHelper

public InputHelper(Screen scr)

Constructs an InputHelper instance.

Parameters:

scr - Screen instance associated with this helper.

Since:

BlackBerry API 6.0.0

InputHelper

public InputHelper(Screen scr,
                   long inputStyle)

Constructs an InputHelper instance with specified input style.

Parameters:

scr - Associated with this helper Screen instance

inputStyle - Combination of field style bits to specify display and filter attributes, e.g. BasicEditField.FILTER_NUMERIC, Field.EDITABLE, Field.FOCUSABLE.

Since:

BlackBerry API 6.0.0

Method Detail

getLookupProperties

public LookupProperties getLookupProperties()

Gets current lookup properties been set for the InputHelper object.

Returns:

Current lookup properties.

Since:

BlackBerry API 6.0.0

notifyLookupPropertiesChanged

public void notifyLookupPropertiesChanged()

This method is to be called by the owning 3rd party application if it changed the InputHelper's lookup properties and wants them to be applied while having the InputHelper as the current input component continuously (having no focus switch).

Since:

BlackBerry API 6.0.0

getVariantIterator

public LookupVariantIterator getVariantIterator()

Lookup variant iterator is created only once by a variant listener, e.g. by InputHelper, and then is re-initialized repeatedly by an input method with variants.

Returns:

Lookup variant iterator.

Since:

BlackBerry API 6.0.0