com.sybase.uep.bobclient.controls
Class RadioBox

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by net.rim.device.api.ui.component.RadioButtonField
          extended by com.sybase.uep.bobclient.controls.RadioBox
All Implemented Interfaces:
Control

public class RadioBox
extends net.rim.device.api.ui.component.RadioButtonField
implements Control

This is the Radio box control

Author:
tdang

Field Summary
 
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
RadioBox(int labelRID, long style)
          Radio box constructor
RadioBox(int labelRID, long style, boolean showBackgroundColor)
          Radio box constructor
RadioBox(int labelRID, long style, boolean showBackgroundColor, boolean emptyMeansNull)
          Radio box constructor
RadioBox(java.lang.String label, long style)
          Radio box constructor
RadioBox(java.lang.String label, long style, boolean showBackgroundColor)
          Radio box constructor
RadioBox(java.lang.String label, long style, boolean showBackgroundColor, boolean emptyMeansNull)
          Radio box constructor
 
Method Summary
protected  void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
          (non-Javadoc)
 int getColSpan()
          (non-Javadoc)
 int getFieldIndex()
          Retrieve the edit index for this radiobox
 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 getType()
          Retrieve the type for this radiobox
 ValidationObject getValidationObj()
          Retrieve the validation object set on this checkbox
 java.lang.Object getValue()
          (non-Javadoc)
 long getVerticalAlignment()
          (non-Javadoc)
 boolean hasValidation()
          Check if there is a validation object assigned to this control
 boolean isReadOnly()
          Check if this radio box is read only and can't be changed
 boolean isRequired()
          Check if this radiobox is required
protected  void layout(int width, int height)
          (non-Javadoc)
protected  void paint(net.rim.device.api.ui.Graphics g)
          (non-Javadoc)
 void refresh()
          (non-Javadoc)
 void refreshFooter(java.lang.String valueToBeDisplay)
          Refresh the footer field from the screen that contains the text of the button.
 void setBackgroundColor(int bgcolor)
          (non-Javadoc)
 void setColSpan(int colspan)
          (non-Javadoc)
 void setFieldIndex(int index)
          Set index
 void setFontStyle(FontStyle fontStyle)
          Set the font style for this control
 void setFooterField(FooterField field)
          Set the footer field
 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 setProperty(int key, java.lang.String value)
          Set the property values for this button
 void setRequired(boolean required)
          Set if this radiobox is required
 void setRowSpan(int rowspan)
          (non-Javadoc)
 void setType(java.lang.String type)
          Set type
 void setValidationObject(ValidationObject obj)
          Set validation object
 void setValue(int valueId)
          Set the value for this radiobox.
 void setValue(java.lang.String value)
          Set the value for this radiobox.
 void setVariableLabel(ControlVariable variable)
          Set the control variable object to the radio box label
 void setVariableValue(ControlVariable variable)
          Set the control variable object to the radio box value
 
Methods inherited from class net.rim.device.api.ui.component.RadioButtonField
getAccessibleContext, getFocusRect, getGroup, getLabel, isSelected, keyChar, keyDown, makeContextMenu, onFocus, onUnfocus, setLabel, setSelected
 
Methods inherited from class net.rim.device.api.ui.Field
drawHighlightRegion, fieldChangeNotify, 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, isPasteable, isSelectable, isSelecting, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, keyControl, keyRepeat, keyStatus, keyUp, makeContextMenu, moveFocus, moveFocus, navigationClick, navigationMovement, navigationUnclick, onDisplay, onExposed, onMenuDismissed, onMenuDismissed, onObscured, onUndisplay, onVisibilityChange, paintBackground, paste, select, selectionCopy, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCookie, setDirty, setEditable, setExtent, setFocus, setFocusListener, setFont, 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
 

Constructor Detail

RadioBox

public RadioBox(java.lang.String label,
                long style)
Radio box constructor

Parameters:
label - String value for the label
style - long value for the style. eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
See Also:
Field

RadioBox

public RadioBox(int labelRID,
                long style)
Radio box constructor

Parameters:
labelRID - int value for the localization resource ID for the label of this radiobox
style - long value for the style. eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.

RadioBox

public RadioBox(java.lang.String label,
                long style,
                boolean showBackgroundColor)
Radio box constructor

Parameters:
label - String value for the label
style - long value for the style. eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
showBackgroundColor - true to show background color, otherwise false
See Also:
Field

RadioBox

public RadioBox(java.lang.String label,
                long style,
                boolean showBackgroundColor,
                boolean emptyMeansNull)
Radio box constructor

Parameters:
label -
style -
showBackgroundColor -
emptyMeansNull -

RadioBox

public RadioBox(int labelRID,
                long style,
                boolean showBackgroundColor)
Radio box constructor

Parameters:
labelRID - int value for the localization resource ID for the label of this radiobox
style - long value for the style. eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
showBackgroundColor - true to show background color, otherwise false

RadioBox

public RadioBox(int labelRID,
                long style,
                boolean showBackgroundColor,
                boolean emptyMeansNull)
Radio box constructor

Parameters:
labelRID -
style -
showBackgroundColor -
emptyMeansNull -
Method Detail

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

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

setVariableLabel

public void setVariableLabel(ControlVariable variable)
Set the control variable object to the radio box label

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

setVariableValue

public void setVariableValue(ControlVariable variable)
Set the control variable object to the radio box value

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

setValue

public void setValue(java.lang.String value)
Set the value for this radiobox. If the value is empty string, we need to check if empty string means null.

Parameters:
value - String new value

setValue

public void setValue(int valueId)
Set the value for this radiobox. If the matching value in localization file is empty string, we need to check if empty string means null.

Parameters:
valueId - key in localization files

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

getFieldIndex

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

Returns:
int value for the index

getType

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

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 radiobox is required

Parameters:
required - true if it's required, otherwise false

isRequired

public boolean isRequired()
Check if this radiobox 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)

getPreferredWidth

public int getPreferredWidth()
(non-Javadoc)

Specified by:
getPreferredWidth in interface Control
Overrides:
getPreferredWidth in class net.rim.device.api.ui.component.RadioButtonField
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.RadioButtonField
Returns:
int value of the available layout height
See Also:
Control.getPreferredHeight()

refresh

public void refresh()
(non-Javadoc)

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

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.RadioButtonField
See Also:
Field.drawFocus(Graphics g, boolean on)

setProperty

public void setProperty(int key,
                        java.lang.String value)
Set the property values for this button

Parameters:
key - int int value for the key of a specific attribute
value - String value for this attribute

refreshFooter

public void refreshFooter(java.lang.String valueToBeDisplay)
Refresh the footer field from the screen that contains the text of the button.

Parameters:
valueToBeDisplay - String value for the text to be display in the footer

layout

protected void layout(int width,
                      int height)
(non-Javadoc)

Overrides:
layout in class net.rim.device.api.ui.component.RadioButtonField
See Also:
Field.layout(int width, int height)

paint

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

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

setFooterField

public void setFooterField(FooterField field)
Set the footer field

Parameters:
{@link - FooterField} footer field to put the text of the textinput into. This is useful for long text, so it can be displayed in the footer. null value if there is no footer.
See Also:
FooterField

setType

public void setType(java.lang.String type)
Set type

Parameters:
type - String value for the type of the update

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

setValidationObject

public void setValidationObject(ValidationObject obj)
Set validation object

Parameters:
obj - ValidationObject validation object
See Also:
ValidationObject

setFieldIndex

public void setFieldIndex(int index)
Set index

Parameters:
index - int value for the edit index

isReadOnly

public boolean isReadOnly()
Check if this radio box is read only and can't be changed

Returns:
true if the radio box is read only, otherwise false