|
|||||||||
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.ListField
com.sybase.uep.bobclient.controls.ListFieldControl
public class ListFieldControl
List Field Control class Contains the list of ListItems
Field Summary |
---|
Fields inherited from class net.rim.device.api.ui.component.ListField |
---|
MULTI_SELECT, NO_ALTED_PAGE_UP_DOWN, NON_CONTIGUOUS_SELECT, ROW_HEIGHT_FONT |
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 | |
---|---|
ListFieldControl(long style)
Constructor to create List Field Control |
Method Summary | |
---|---|
void |
addListItem(ListItem listItem)
Add ListItem to the list field |
void |
addMenuItem(net.rim.device.api.ui.MenuItem menu)
Add Menu Item |
void |
addMenuSeperator()
Add menu seperator |
void |
clearMenuItems()
Remove all the menu items |
protected void |
drawFocus(net.rim.device.api.ui.Graphics graphics,
boolean on)
(non-Javadoc) |
void |
drawListItem(net.rim.device.api.ui.Graphics g,
int index,
boolean focus)
Draw the list item |
int |
getColSpan()
(non-Javadoc) |
int |
getControlID()
Returns the control's ID |
ICustomEventsDelegate |
getCustomEventsDelegate()
Returns the control's custom events delegate |
long |
getHorizontalAlignment()
(non-Javadoc) |
ListItem |
getListItemAt(int index)
Retrieve the ListItem by index |
ListItem[] |
getListItems()
Retrieve the ListItems |
java.lang.String |
getName()
(non-Javadoc) |
int |
getPreferredHeight()
(non-Javadoc) |
int |
getPreferredWidth()
(non-Javadoc) |
int |
getRowSpan()
(non-Javadoc) |
java.lang.Object |
getValue()
(non-Javadoc) |
long |
getVerticalAlignment()
(non-Javadoc) |
int |
getYLocation(int index)
Retrieve the Y location of the next list item to be drawn |
protected void |
layout(int width,
int height)
(non-Javadoc) |
protected void |
makeContextMenu(net.rim.device.api.ui.ContextMenu menu)
(non-Javadoc) |
protected int |
moveFocus(int amount,
int status,
int time)
(non-Javadoc) |
protected void |
moveFocus(int x,
int y,
int status,
int time)
(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 list item. |
void |
removeAllListItems()
Remove all the ListItems |
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 |
setFooterField(FooterField field)
Set the footer field |
void |
setLayoutHeight(int height)
(non-Javadoc) |
void |
setLayoutWidth(int width)
(non-Javadoc) |
void |
setListItems(ListItem[] list)
Set list items |
void |
setListItems(java.util.Vector items)
Set list items |
void |
setRowSpan(int rowspan)
(non-Javadoc) |
protected boolean |
touchEvent(net.rim.device.api.ui.TouchEvent message)
(non-Javadoc) |
Methods inherited from class net.rim.device.api.ui.component.ListField |
---|
delete, getAccessibleContext, getCallback, getEmptyString, getEmptyStringStyle, getFocusRect, getRowHeight, getRowHeight, getSelectedIndex, getSelection, getSize, getVisibleLinesPageDown, indexOfList, insert, invalidate, invalidate, invalidateRange, isEmpty, keyChar, keyControl, setCallback, setEmptyString, setEmptyString, setRowHeight, setRowHeight, setSearchable, setSelectedIndex, setSize, setSize |
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, invalidateAll, invokeAction, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isPasteable, isSelectable, isSelecting, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, keyDown, keyRepeat, keyStatus, keyUp, makeContextMenu, 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, trackwheelClick, trackwheelUnclick, updateLayout |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ListFieldControl(long style)
style
- long
value for the style of this label control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.Field
Method Detail |
---|
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.ListField
int
value of the available layout widthControl.getPreferredWidth()
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.Field
int
value of the available layout heightControl.getPreferredHeight()
public java.lang.Object getValue()
getValue
in interface Control
Object
of the value set for this controlControl.getValue()
public java.lang.String getName()
getName
in interface Control
String
value of the key nameControl.getName()
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 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 refresh()
refresh
in interface Control
Control.refresh()
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 void removeAllListItems()
public void addListItem(ListItem listItem)
listItem
- ListItem
object that contains the label and actionListItem
public ListItem[] getListItems()
ListItem
array list of ListItem
objectsListItem
public ListItem getListItemAt(int index)
index
- int
value for the index location of the ListItem
ListItem
list item objectListItem
public void addMenuItem(net.rim.device.api.ui.MenuItem menu)
menu
- new MenuItempublic void addMenuSeperator()
public void clearMenuItems()
protected void makeContextMenu(net.rim.device.api.ui.ContextMenu menu)
makeContextMenu
in class net.rim.device.api.ui.Field
Field.makeContextMenu(ContextMenu menu)
public int getYLocation(int index)
index
- int
value for the current list item index to be drawn
int
value for the Y locationprotected int moveFocus(int amount, int status, int time)
moveFocus
in class net.rim.device.api.ui.component.ListField
Field.moveFocus(int amount, int status, int time)
protected void moveFocus(int x, int y, int status, int time)
moveFocus
in class net.rim.device.api.ui.component.ListField
Field.moveFocus( int x, int y, int status, int time )
protected void drawFocus(net.rim.device.api.ui.Graphics graphics, boolean on)
drawFocus
in class net.rim.device.api.ui.component.ListField
Field.drawFocus(Graphics g, boolean on)
public void drawListItem(net.rim.device.api.ui.Graphics g, int index, boolean focus)
graphics
- Graphics
object for drawing the focus.index
- int
value for the row index to display.focus
- true
if the list item is in focus, otherwise false
Graphics
protected void paint(net.rim.device.api.ui.Graphics g)
paint
in class net.rim.device.api.ui.component.ListField
Field.paint(Graphics g)
protected void layout(int width, int height)
layout
in class net.rim.device.api.ui.component.ListField
Field.layout(int width, int height)
protected void onFocus(int direction)
onFocus
in class net.rim.device.api.ui.component.ListField
Field.onFocus(int direction)
protected void onUnfocus()
onUnfocus
in class net.rim.device.api.ui.Field
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)
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 refreshFooter(java.lang.String valueToBeDisplay)
valueToBeDisplay
- String
value for the text to be display in the footerpublic void setListItems(java.util.Vector items)
items
- Vector
list of ListItem
ListItem
public void setListItems(ListItem[] list)
list
- ListItem
array listListItem
public 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 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 |