|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.ui.Field
net.rim.device.api.ui.component.CheckboxField
com.sybase.uep.bobclient.controls.CheckBox
public class CheckBox
This is the Check box control
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 |
---|
public CheckBox(int labelRID, boolean checked, long style)
labelRID
- localization resource ID for the label of this checkboxchecked
- 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.net.rim.device.api.ui.Field.FIELD_LEFT
,
net.rim.device.api.ui.Field.FIELD_RIGHT
,
net.rim.device.api.ui.Field.FIELD_HCENTER
public CheckBox(java.lang.String label, boolean checked, long style)
label
- String
value for the label of this checkboxchecked
- 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.net.rim.device.api.ui.Field.FIELD_LEFT
,
net.rim.device.api.ui.Field.FIELD_RIGHT
,
net.rim.device.api.ui.Field.FIELD_HCENTER
public CheckBox(int labelRID, boolean checked, long style, boolean showBackgroundColor)
labelRID
- localization resource ID for the label of this checkboxchecked
- 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
net.rim.device.api.ui.Field.FIELD_LEFT
,
net.rim.device.api.ui.Field.FIELD_RIGHT
,
net.rim.device.api.ui.Field.FIELD_HCENTER
public CheckBox(java.lang.String label, boolean checked, long style, boolean showBackgroundColor)
label
- String
value for the label of this checkboxchecked
- 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
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 |
---|
public void setBackgroundColor(int bgcolor)
setBackgroundColor
in interface Control
bgcolor
- int
value of the color in HEX.
For example: 0x00000000, 0x00FF0000, 0x00FFFFFFControl.setBackgroundColor(int bgcolor)
public long getHorizontalAlignment()
getHorizontalAlignment
in interface Control
long
value of the horizontal alignment.
Possible values could be Field.FIELD_HCENTER, Field.FIELD_RIGHT, or Field.FIELD_LEFTControl.getHorizontalAlignment()
public long getVerticalAlignment()
getVerticalAlignment
in interface Control
long
value of the vertical alignment
Possible values could be Field.FIELD_TOP, Field.FIELD_BOTTOM, or Field.FIELD_VCENTERControl.getVerticalAlignment()
public void setVariableLabel(ControlVariable variable)
variable
- ControlVariable
control variable objectControlVariable
public void setVariableCheck(ControlVariable variable)
variable
- ControlVariable
control variable objectControlVariable
public FontStyle getFontStyle()
FontStyle
font style objectFontStyle
public void setFontStyle(FontStyle fontStyle)
fontStyle
- FontStyle
font style objectFontStyle
public java.lang.Object getValue()
getValue
in interface Control
Object
of the value set for this controlControl.getValue()
public int getFieldIndex()
int
value for the field indexpublic java.lang.String getType()
String
value for the typepublic java.lang.String getName()
getName
in interface Control
String
value of the key nameControl.getName()
public ValidationObject getValidationObj()
ValidationObject
validation objectValidationObject
public boolean hasValidation()
true
if there is validation object set, otherwise false
public void setRequired(boolean required)
required
- true
if checkbox is required, otherwise false
public boolean isRequired()
true
if checkbox is required, otherwise false
public void setLayoutWidth(int width)
setLayoutWidth
in interface Control
width
- int
value of the available layout widthControl.setLayoutWidth(int width)
public int getPreferredWidth()
getPreferredWidth
in interface Control
getPreferredWidth
in class net.rim.device.api.ui.component.CheckboxField
int
value of the available layout widthControl.getPreferredWidth()
public void setColSpan(int colspan)
setColSpan
in interface Control
colspan
- int
value of the column spanControl.setColSpan(int colspan)
public int getColSpan()
getColSpan
in interface Control
int
value of the column spanControl.getColSpan()
public void setRowSpan(int rowspan)
setRowSpan
in interface Control
rowspan
- int
value of the row spanControl.setRowSpan(int rowspan)
public int getRowSpan()
getRowSpan
in interface Control
int
value of the row spanControl.getRowSpan()
public LogicalType getLogicalType()
getLogicalType
in interface PIMControl
LogicalType
logical type objectLogicalType
public void setLogicalType(LogicalType logicalType)
logicalType
- LogicalType
logical type objectLogicalType
public java.lang.String getSchemaType()
getSchemaType
in interface PIMControl
String
value for the schema typepublic void setSchemaType(java.lang.String schemaType)
schemaType
- String
value for the schema typepublic void setPIMValue(java.lang.Object value)
setPIMValue
in interface PIMControl
value
- Object
PIM valuepublic java.lang.Object getPIMValue()
getPIMValue
in interface PIMControl
Object
value for the PIMprotected void layout(int width, int height)
layout
in class net.rim.device.api.ui.component.CheckboxField
Field.layout(int width, int height)
public void setLayoutHeight(int height)
setLayoutHeight
in interface Control
height
- int
value of the available layout heightControl.setLayoutHeight(int height)
public int getPreferredHeight()
getPreferredHeight
in interface Control
getPreferredHeight
in class net.rim.device.api.ui.component.CheckboxField
int
value of the available layout heightControl.getPreferredHeight()
protected void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
drawFocus
in class net.rim.device.api.ui.component.CheckboxField
Field.drawFocus(Graphics g, boolean on)
protected void paint(net.rim.device.api.ui.Graphics g)
paint
in class net.rim.device.api.ui.component.CheckboxField
Field.paint(Graphics g)
protected void onFocus(int direction)
onFocus
in class net.rim.device.api.ui.component.CheckboxField
Field.onFocus(int direction)
protected void onUnfocus()
onUnfocus
in class net.rim.device.api.ui.component.CheckboxField
Field.onUnfocus()
protected boolean navigationClick(int status, int time)
navigationClick
in class net.rim.device.api.ui.Field
Field.navigationClick(int status, int time)
protected boolean navigationUnclick(int status, int time)
navigationUnclick
in class net.rim.device.api.ui.Field
Field.navigationUnclick(int status, int time)
protected boolean navigationMovement(int dx, int dy, int status, int time)
navigationMovement
in class net.rim.device.api.ui.Field
Field.navigationMovement(int dx, int dy, int status, int time)
public void fieldChanged(net.rim.device.api.ui.Field field, int context)
fieldChanged
in interface net.rim.device.api.ui.FieldChangeListener
FieldChangeListener.fieldChanged(Field field, int context)
protected boolean touchEvent(net.rim.device.api.ui.TouchEvent message)
touchEvent
in class net.rim.device.api.ui.Field
Field.touchEvent(TouchEvent message)
public void refresh()
refresh
in interface Control
Control.refresh()
public void setProperty(int key, java.lang.String value)
key
- int
int value for the key of a specific attributevalue
- String
value for this attributepublic void refreshFooter(java.lang.String valueToBeDisplay)
valueToBeDisplay
- String
value for the text to be display in the footerpublic void setFooterField(FooterField field)
{@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.FooterField
public void setName(java.lang.String name)
name
- String
value for the key name for this controlpublic void setType(java.lang.String type)
type
- String
value for the type of the updatepublic void setValidationObj(ValidationObject obj)
obj
- ValidationObject
validation objectValidationObject
public void setFieldIndex(int index)
index
- int
for the field indexpublic ICustomEventsDelegate getCustomEventsDelegate()
public void setCustomEventsDelegate(ICustomEventsDelegate delegate, int eventsFlags)
delegate
- custom events delegateeventsFlags
- the events to set delegate topublic int getControlID()
public void setControlID(int controlID)
controlId
- control ID
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |