com.sybase.uep.bobclient.controls
Class RichTextInput

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by net.rim.device.api.ui.component.TextField
          extended by net.rim.device.api.ui.component.RichTextField
              extended by com.sybase.uep.bobclient.controls.RichTextInput
All Implemented Interfaces:
Control, net.rim.device.internal.ui.Formatter.TextRenderer

public class RichTextInput
extends net.rim.device.api.ui.component.RichTextField
implements Control

This is the rich text input control

Author:
tdang

Field Summary
 
Fields inherited from class net.rim.device.api.ui.component.RichTextField
TEXT_ALIGN_HCENTER, TEXT_ALIGN_LEFT, TEXT_ALIGN_RIGHT, USE_TEXT_WIDTH
 
Fields inherited from class net.rim.device.api.ui.component.TextField
CONSUME_INPUT, DEFAULT_MAXCHARS, JUMP_FOCUS_AT_END, NO_COMPLEX_INPUT, NO_EDIT_MODE_INPUT, NO_LEARNING, NO_NEWLINE, NO_SWITCHING_INPUT
 
Fields inherited from class net.rim.device.api.ui.Field
ACTION_INVOKE, 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
RichTextInput(java.lang.String defaultValue, long style)
          Constructor to create the text input
 
Method Summary
protected  void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
          (non-Javadoc)
 int getColSpan()
          (non-Javadoc)
 java.lang.String getDisplayName()
          Retrieve the display name
 int getFieldIndex()
          Retrieve the edit index for this checkbox
 FontStyle getFontStyle()
          Retrieve this control's font style
 long getHorizontalAlignment()
          (non-Javadoc)
 java.lang.String getName()
          (non-Javadoc)
 int getPreferredHeight()
          (non-Javadoc)
 int getPreferredWidth()
          (non-Javadoc)
 int getRowSpan()
          (non-Javadoc)
 java.lang.String getText()
          Retrieve the current text value in this input
 java.lang.String getType()
          Retrieve the type for this checkbox
 ValidationObject getValidationObj()
          Retrieve the validation object set on this checkbox
 java.lang.Object getValue()
          (non-Javadoc)
 long getVerticalAlignment()
          (non-Javadoc)
 java.lang.String getWid()
          Retrieve wid for this text input
 boolean hasValidation()
          Check if there is a validation object assigned to this control
 boolean isRequired()
          Check if this checkbox is required
protected  void onFocus(int direction)
          (non-Javadoc)
protected  void onUnfocus()
           
protected  void paint(net.rim.device.api.ui.Graphics g)
          (non-Javadoc)
 void refresh()
          (non-Javadoc)
 void setBackgroundColor(int bgcolor)
          (non-Javadoc)
 void setColSpan(int colspan)
          (non-Javadoc)
 void setFontStyle(FontStyle fontStyle)
          Set the font style for this control
 void setLayoutHeight(int height)
          (non-Javadoc)
 void setLayoutWidth(int width)
          (non-Javadoc)
 void setName(java.lang.String name)
          Set a key name for this control
 void setRequired(boolean required)
          Set if this checkbox is required
 void setRowSpan(int rowspan)
          (non-Javadoc)
 void setText(java.lang.String text)
          Set the text value in this input
 void setValue(java.lang.String value)
          Set the value for this input
 void setVariableInput(ControlVariable variable)
          Set the control variable object for the input value
 
Methods inherited from class net.rim.device.api.ui.component.RichTextField
charAt, getAttributes, getBackgroundColors, getCursorPosition, getFonts, getFonts, getForegroundColors, getOffsets, getRegion, getRegionCookie, getRegionCookie, getRegionFont, getRegionFont, getRegionText, getRegionText, getText, getTextLength, isSelectable, keyChar, layout, moveFocus, setCursorPosition, setFont, setFont, setText, setText, setText
 
Methods inherited from class net.rim.device.api.ui.component.TextField
backspace, backspace, backspace, clear, displayFieldFullMessage, drawText, fieldChangeNotify, getAccessibleContext, getComposedTextEnd, getComposedTextStart, getDisplayLineCount, getFilter, getFocusRect, getLabel, getLabelLength, getMaxSize, getText, getText, getTextAbstractString, insert, insert, insert, insert, insert, insert, insert, isPasteable, isSelecting, isSelectionCopyable, isSelectionDeleteable, isSymbolScreenAllowed, keyControl, makeContextMenu, moveFocus, navigationClick, navigationUnclick, onUndisplay, paste, select, selectionCopy, selectionDelete, setCursorPosition, setFilter, setLabel, setMaxSize, setPreLayoutInternal, setSelection, setText, toString, update, wipe
 
Methods inherited from class net.rim.device.api.ui.Field
drawHighlightRegion, focusAdd, focusChangeNotify, focusRemove, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFont, getHeight, getIndex, getLeafFieldWithFocus, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getScreen, getState, getStyle, getTop, getVisualState, getWidth, invalidate, invalidate, invalidateAll, invokeAction, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isSelectionCutable, isSpellCheckable, isStyle, isVisible, keyDown, keyRepeat, keyStatus, keyUp, makeContextMenu, navigationMovement, onDisplay, onExposed, onMenuDismissed, onMenuDismissed, onObscured, onVisibilityChange, paintBackground, selectionCut, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCookie, setDirty, setEditable, 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, wait, wait, wait
 
Methods inherited from interface net.rim.device.internal.ui.Formatter.TextRenderer
getFont
 

Constructor Detail

RichTextInput

public RichTextInput(java.lang.String defaultValue,
                     long style)
Constructor to create the text input

Parameters:
defaultValue - String value for the default value
style - long for the style
Method Detail

setBackgroundColor

public void setBackgroundColor(int bgcolor)
(non-Javadoc)

Specified by:
setBackgroundColor in interface Control
Parameters:
bgcolor - int value of the color in HEX. For example: 0x00000000, 0x00FF0000, 0x00FFFFFF
See Also:
Control.setBackgroundColor(int bgcolor)

setColSpan

public void setColSpan(int colspan)
(non-Javadoc)

Specified by:
setColSpan in interface Control
Parameters:
colspan - int value of the column span
See Also:
Control.setColSpan(int colspan)

getColSpan

public int getColSpan()
(non-Javadoc)

Specified by:
getColSpan in interface Control
Returns:
int value of the column span
See Also:
Control.getColSpan()

setRowSpan

public void setRowSpan(int rowspan)
(non-Javadoc)

Specified by:
setRowSpan in interface Control
Parameters:
rowspan - int value of the row span
See Also:
Control.setRowSpan(int rowspan)

getRowSpan

public int getRowSpan()
(non-Javadoc)

Specified by:
getRowSpan in interface Control
Returns:
int value of the row span
See Also:
Control.getRowSpan()

getHorizontalAlignment

public long getHorizontalAlignment()
(non-Javadoc)

Specified by:
getHorizontalAlignment in interface Control
Returns:
long value of the horizontal alignment. Possible values could be Field.FIELD_HCENTER, Field.FIELD_RIGHT, or Field.FIELD_LEFT
See Also:
Control.getHorizontalAlignment()

getVerticalAlignment

public long getVerticalAlignment()
(non-Javadoc)

Specified by:
getVerticalAlignment in interface Control
Returns:
long value of the vertical alignment Possible values could be Field.FIELD_TOP, Field.FIELD_BOTTOM, or Field.FIELD_VCENTER
See Also:
Control.getVerticalAlignment()

setVariableInput

public void setVariableInput(ControlVariable variable)
Set the control variable object for the input value

Parameters:
variable - ControlVariable control variable object
See Also:
ControlVariable

getFontStyle

public FontStyle getFontStyle()
Retrieve this control's font style

Returns:
FontStyle font style object
See Also:
FontStyle

setFontStyle

public void setFontStyle(FontStyle fontStyle)
Set the font style for this control

Parameters:
fontStyle - FontStyle font style object
See Also:
FontStyle

getFieldIndex

public int getFieldIndex()
Retrieve the edit index for this checkbox

Returns:
int value for the field index

getDisplayName

public java.lang.String getDisplayName()
Retrieve the display name

Returns:
String value of the display name

getType

public java.lang.String getType()
Retrieve the type for this checkbox

Returns:
String value for the control type

getName

public java.lang.String getName()
(non-Javadoc)

Specified by:
getName in interface Control
Returns:
String value of the key name
See Also:
Control.getName()

getValidationObj

public ValidationObject getValidationObj()
Retrieve the validation object set on this checkbox

Returns:
ValidationObject validation object
See Also:
ValidationObject

hasValidation

public boolean hasValidation()
Check if there is a validation object assigned to this control

Returns:
true if there is validation object set, otherwise false

setRequired

public void setRequired(boolean required)
Set if this checkbox is required

Parameters:
required - true if control is required, otherwise false

isRequired

public boolean isRequired()
Check if this checkbox is required

Returns:
true if required, otherwise false

setLayoutWidth

public void setLayoutWidth(int width)
(non-Javadoc)

Specified by:
setLayoutWidth in interface Control
Parameters:
width - int value of the available layout width
See Also:
Control.setLayoutWidth(int width)

onFocus

protected void onFocus(int direction)
(non-Javadoc)

Overrides:
onFocus in class net.rim.device.api.ui.component.TextField
See Also:
Field.onFocus(int direction)

getPreferredWidth

public int getPreferredWidth()
(non-Javadoc)

Specified by:
getPreferredWidth in interface Control
Overrides:
getPreferredWidth in class net.rim.device.api.ui.component.TextField
Returns:
int value of the available layout width
See Also:
Control.getPreferredWidth()

setLayoutHeight

public void setLayoutHeight(int height)
(non-Javadoc)

Specified by:
setLayoutHeight in interface Control
Parameters:
height - int value of the available layout height
See Also:
Control.setLayoutHeight(int height)

getPreferredHeight

public int getPreferredHeight()
(non-Javadoc)

Specified by:
getPreferredHeight in interface Control
Overrides:
getPreferredHeight in class net.rim.device.api.ui.component.RichTextField
Returns:
int value of the available layout height
See Also:
Control.getPreferredHeight()

getText

public java.lang.String getText()
Retrieve the current text value in this input

Overrides:
getText in class net.rim.device.api.ui.component.RichTextField
Returns:
String value of the text in this input

setText

public void setText(java.lang.String text)
Set the text value in this input

Overrides:
setText in class net.rim.device.api.ui.component.RichTextField
Parameters:
text - string value for the text input

setValue

public void setValue(java.lang.String value)
Set the value for this input

Parameters:
value - String value for the input

getValue

public java.lang.Object getValue()
(non-Javadoc)

Specified by:
getValue in interface Control
Returns:
Object of the value set for this control
See Also:
Control.getValue()

getWid

public java.lang.String getWid()
Retrieve wid for this text input

Returns:
String value of the wid

onUnfocus

protected void onUnfocus()
Overrides:
onUnfocus in class net.rim.device.api.ui.Field

paint

protected void paint(net.rim.device.api.ui.Graphics g)
(non-Javadoc)

Overrides:
paint in class net.rim.device.api.ui.component.RichTextField
See Also:
Field.paint(Graphics g)

refresh

public void refresh()
(non-Javadoc)

Specified by:
refresh in interface Control
See Also:
Control.refresh()

setName

public void setName(java.lang.String name)
Set a key name for this control

Parameters:
name - String value for the key name for this control

drawFocus

protected void drawFocus(net.rim.device.api.ui.Graphics g,
                         boolean on)
(non-Javadoc)

Overrides:
drawFocus in class net.rim.device.api.ui.component.TextField
See Also:
Field.drawFocus(Graphics g, boolean on)