com.sybase.uep.bobclient.controls
Class CheckBox

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by net.rim.device.api.ui.component.CheckboxField
          extended by com.sybase.uep.bobclient.controls.CheckBox
All Implemented Interfaces:
Control, PIMControl, net.rim.device.api.ui.FieldChangeListener

public class CheckBox
extends net.rim.device.api.ui.component.CheckboxField
implements Control, PIMControl, net.rim.device.api.ui.FieldChangeListener

This is the Check box control

Author:
tdang
See Also:
Control, PIMControl

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
 
Fields inherited from interface net.rim.device.api.ui.FieldChangeListener
PROGRAMMATIC
 
Constructor Summary
CheckBox(int labelRID, boolean checked, long style)
          Constructor to create a CheckBox control
CheckBox(int labelRID, boolean checked, long style, boolean showBackgroundColor)
          Constructor to create a CheckBox control
CheckBox(java.lang.String label, boolean checked, long style)
          Constructor to create a CheckBox controls
CheckBox(java.lang.String label, boolean checked, long style, boolean showBackgroundColor)
          Constructor to create a CheckBox controls
 
Method Summary
protected  void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
          (non-Javadoc)
 void fieldChanged(net.rim.device.api.ui.Field field, int context)
          (non-Javadoc)
 int getColSpan()
          (non-Javadoc)
 int getControlID()
          Returns the control's ID
 ICustomEventsDelegate getCustomEventsDelegate()
          Returns the control's custom events delegate
 int getFieldIndex()
          Retrieve the edit index for this checkbox
 FontStyle getFontStyle()
          Retrieve this control's font style
 long getHorizontalAlignment()
          (non-Javadoc)
 LogicalType getLogicalType()
          Retrieve the logical type assign to this control
 java.lang.String getName()
          (non-Javadoc)
 java.lang.Object getPIMValue()
          Retrieve the PIM value
 int getPreferredHeight()
          (non-Javadoc)
 int getPreferredWidth()
          (non-Javadoc)
 int getRowSpan()
          (non-Javadoc)
 java.lang.String getSchemaType()
          Retrieve the schema type
 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)
 boolean hasValidation()
          Check if there is a validation object assigned to this control
 boolean isRequired()
          Check to see if this checkbox is required
protected  void layout(int width, int height)
          (non-Javadoc)
protected  boolean navigationClick(int status, int time)
          (non-Javadoc)
protected  boolean navigationMovement(int dx, int dy, int status, int time)
          (non-Javadoc)
protected  boolean navigationUnclick(int status, int time)
          (non-Javadoc)
protected  void onFocus(int direction)
          (non-Javadoc)
protected  void onUnfocus()
          (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 setControlID(int controlID)
          Sets the control's ID
 void setCustomEventsDelegate(ICustomEventsDelegate delegate, int eventsFlags)
          Sets the control's custom events delegate for the given events
 void setFieldIndex(int index)
          Set field 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 setLogicalType(LogicalType logicalType)
          Set logical type
 void setName(java.lang.String name)
          Set a key name for this control
 void setPIMValue(java.lang.Object value)
          Sets the PIM value
 void setProperty(int key, java.lang.String value)
          Set the property values for this button
 void setRequired(boolean required)
          Set if this checkbox is required
 void setRowSpan(int rowspan)
          (non-Javadoc)
 void setSchemaType(java.lang.String schemaType)
          Set the schema type
 void setType(java.lang.String type)
          Set type
 void setValidationObj(ValidationObject obj)
          Set validation object
 void setVariableCheck(ControlVariable variable)
          Set the control variable object for the checkbox if it's checked or not
 void setVariableLabel(ControlVariable variable)
          Set the control variable object for the label
protected  boolean touchEvent(net.rim.device.api.ui.TouchEvent message)
          (non-Javadoc)
 
Methods inherited from class net.rim.device.api.ui.component.CheckboxField
getAccessibleContext, getChecked, getFocusRect, getLabel, invokeAction, keyChar, keyDown, makeContextMenu, moveFocus, setChecked, setLabel, toString, trackwheelClick
 
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, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isPasteable, isSelectable, isSelecting, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, keyControl, keyRepeat, keyStatus, keyUp, makeContextMenu, moveFocus, 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, trackwheelUnclick, updateLayout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckBox

public CheckBox(int labelRID,
                boolean checked,
                long style)
Constructor to create a CheckBox control

Parameters:
labelRID - localization resource ID for the label of this checkbox
checked - true if the checkbox is checked, otherwise false
style - long value for the style of the label control eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
See Also:
net.rim.device.api.ui.Field.FIELD_LEFT, net.rim.device.api.ui.Field.FIELD_RIGHT, net.rim.device.api.ui.Field.FIELD_HCENTER

CheckBox

public CheckBox(java.lang.String label,
                boolean checked,
                long style)
Constructor to create a CheckBox controls

Parameters:
label - String value for the label of this checkbox
checked - true if the checkbox is checked, otherwise false
style - long value for the style of the label control eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
See Also:
net.rim.device.api.ui.Field.FIELD_LEFT, net.rim.device.api.ui.Field.FIELD_RIGHT, net.rim.device.api.ui.Field.FIELD_HCENTER

CheckBox

public CheckBox(int labelRID,
                boolean checked,
                long style,
                boolean showBackgroundColor)
Constructor to create a CheckBox control

Parameters:
labelRID - localization resource ID for the label of this checkbox
checked - true if the checkbox is checked, otherwise false
style - long value for the style of the label control eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
showBackgroundColor - true to show background color, otherwise false
See Also:
net.rim.device.api.ui.Field.FIELD_LEFT, net.rim.device.api.ui.Field.FIELD_RIGHT, net.rim.device.api.ui.Field.FIELD_HCENTER

CheckBox

public CheckBox(java.lang.String label,
                boolean checked,
                long style,
                boolean showBackgroundColor)
Constructor to create a CheckBox controls

Parameters:
label - String value for the label of this checkbox
checked - true if the checkbox is checked, otherwise false
style - long value for the style of the label control eg. Field.FIELD_LEFT, Field.FIELD_RIGHT, Field.FIELD_HCENTER, etc.
showBackgroundColor - true to show background color, otherwise false
See Also:
net.rim.device.api.ui.Field.FIELD_LEFT, net.rim.device.api.ui.Field.FIELD_RIGHT, net.rim.device.api.ui.Field.FIELD_HCENTER
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)

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 for the label

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

setVariableCheck

public void setVariableCheck(ControlVariable variable)
Set the control variable object for the checkbox if it's checked or not

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

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 checkbox

Returns:
int value for the field index

getType

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

Returns:
String value for the 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 checkbox is required, otherwise false

isRequired

public boolean isRequired()
Check to see if this checkbox is required

Returns:
true if checkbox is 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.CheckboxField
Returns:
int value of the available layout width
See Also:
Control.getPreferredWidth()

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

getLogicalType

public LogicalType getLogicalType()
Retrieve the logical type assign to this control

Specified by:
getLogicalType in interface PIMControl
Returns:
LogicalType logical type object
See Also:
LogicalType

setLogicalType

public void setLogicalType(LogicalType logicalType)
Set logical type

Parameters:
logicalType - LogicalType logical type object
See Also:
LogicalType

getSchemaType

public java.lang.String getSchemaType()
Retrieve the schema type

Specified by:
getSchemaType in interface PIMControl
Returns:
String value for the schema type

setSchemaType

public void setSchemaType(java.lang.String schemaType)
Set the schema type

Parameters:
schemaType - String value for the schema type

setPIMValue

public void setPIMValue(java.lang.Object value)
Sets the PIM value

Specified by:
setPIMValue in interface PIMControl
Parameters:
value - Object PIM value

getPIMValue

public java.lang.Object getPIMValue()
Retrieve the PIM value

Specified by:
getPIMValue in interface PIMControl
Returns:
Object value for the PIM

layout

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

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

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.CheckboxField
Returns:
int value of the available layout height
See Also:
Control.getPreferredHeight()

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

paint

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

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

onFocus

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

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

onUnfocus

protected void onUnfocus()
(non-Javadoc)

Overrides:
onUnfocus in class net.rim.device.api.ui.component.CheckboxField
See Also:
Field.onUnfocus()

navigationClick

protected boolean navigationClick(int status,
                                  int time)
(non-Javadoc)

Overrides:
navigationClick in class net.rim.device.api.ui.Field
See Also:
Field.navigationClick(int status, int time)

navigationUnclick

protected boolean navigationUnclick(int status,
                                    int time)
(non-Javadoc)

Overrides:
navigationUnclick in class net.rim.device.api.ui.Field
See Also:
Field.navigationUnclick(int status, int time)

navigationMovement

protected boolean navigationMovement(int dx,
                                     int dy,
                                     int status,
                                     int time)
(non-Javadoc)

Overrides:
navigationMovement in class net.rim.device.api.ui.Field
See Also:
Field.navigationMovement(int dx, int dy, int status, int time)

fieldChanged

public void fieldChanged(net.rim.device.api.ui.Field field,
                         int context)
(non-Javadoc)

Specified by:
fieldChanged in interface net.rim.device.api.ui.FieldChangeListener
See Also:
FieldChangeListener.fieldChanged(Field field, int context)

touchEvent

protected boolean touchEvent(net.rim.device.api.ui.TouchEvent message)
(non-Javadoc)

Overrides:
touchEvent in class net.rim.device.api.ui.Field
See Also:
Field.touchEvent(TouchEvent message)

refresh

public void refresh()
(non-Javadoc)

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

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

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

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

setType

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

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

setValidationObj

public void setValidationObj(ValidationObject obj)
Set validation object

Parameters:
obj - ValidationObject validation object
See Also:
ValidationObject

setFieldIndex

public void setFieldIndex(int index)
Set field index

Parameters:
index - int for the field index

getCustomEventsDelegate

public ICustomEventsDelegate getCustomEventsDelegate()
Returns the control's custom events delegate

Returns:
the control's custom events delegate

setCustomEventsDelegate

public void setCustomEventsDelegate(ICustomEventsDelegate delegate,
                                    int eventsFlags)
Sets the control's custom events delegate for the given events

Parameters:
delegate - custom events delegate
eventsFlags - the events to set delegate to

getControlID

public int getControlID()
Returns the control's ID

Returns:
the control's Id

setControlID

public void setControlID(int controlID)
Sets the control's ID

Parameters:
controlId - control ID