com.sybase.uep.bobclient.controls
Class TableField

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by com.sybase.uep.bobclient.controls.TableField
All Implemented Interfaces:
Control, net.rim.device.api.ui.DrawStyle
Direct Known Subclasses:
AppLogsTable, GridLookupTable, MobileAppTable, PushLogsTable

public abstract class TableField
extends net.rim.device.api.ui.Field
implements Control, net.rim.device.api.ui.DrawStyle

This is a custom Table Field control It will draw the table with the mobile application data displayed in rows.

Author:
tdang

Field Summary
protected  int _controlID
           
protected  net.rim.device.api.ui.UiApplication _controller
           
protected  CustomEventsHandler _customEventsHandler
           
protected  int _orientation
           
static int DEFAULT_BORDER_COLOR
           
static long KEY
           
 
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.DrawStyle
BASELINE, BOTTOM, ELLIPSIS, HALIGN_MASK, HCENTER, HDEFAULT, HFULL, LEADING, LEFT, RIGHT, TOP, TRAILING, TRUNCATE_BEGINNING, VALIGN_MASK, VCENTER, VDEFAULT, VFULL
 
Constructor Summary
TableField()
          Constructor to create the table field control
 
Method Summary
 void addMenuItem(net.rim.device.api.ui.MenuItem menu)
          Add Menu Item to the Table control
 void addMenuSeperator()
          Add menu seperator
 void clearMenuItems()
          Remove all the menu items on the table control
protected  ImageScreen createImageScreen(int rowIndex, int columnIndex)
          Create an image screen for the table item selected.
protected  void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
          (non-Javadoc)
abstract  MBOModel getApplicationData()
          Retrieve the MBO that is set to the table
 int getColSpan()
          (non-Javadoc)
protected abstract  LogicalType getColumnLogicalType(int columnIndex)
          Retrieve the column logical type
protected abstract  java.lang.String getColumnSchemaType(int columnIndex)
          Retrieve the column schema type
protected abstract  boolean getColumnValues(int rowIndex, java.lang.Object[] columns)
          Retrieve the row data values
 int getControlID()
          Returns the control's ID
 ICustomEventsDelegate getCustomEventsDelegate()
          Returns the control's custom events delegate
 int getDataRecordCount()
          Get the data record count
 FontStyle getEvenRowFontStyle()
          Get the table even row font style
 FontStyle getFocusFontStyle()
          Get the table focus font style
 void getFocusRect(net.rim.device.api.ui.XYRect rect)
          Retrieve the focus section
 FontStyle getHeaderFontStyle()
          Get the table header font style
 int getHeaderHeight()
          Get the header height
 long getHorizontalAlignment()
          (non-Javadoc)
protected abstract  java.util.Vector getLogicalTypeItems()
          Retrieve all MBO attribute's information which have logical type defined
protected abstract  java.lang.String getMobileAppID()
          Retrieve the Mobile Application ID
 java.lang.String getName()
          (non-Javadoc)
 FontStyle getOddRowFontStyle()
          Get the table odd row font style
 FontStyle getPendingFontStyle()
          Get the table Pending font style
 int getPreferredHeight()
          (non-Javadoc)
 int getPreferredWidth()
          (non-Javadoc)
abstract  java.lang.Object getRowByIndex(int rowIndex)
          Retrieve data of a row by row index of the table
 int getRowCount()
          Retrieve the table row count
 net.rim.device.api.ui.Font getRowFont()
          Retrieve the row font
 int getRowHeight()
          Retrieve the row height
 int getRowSpan()
          (non-Javadoc)
 int getSelectedColumn()
          The current selected column
 int getSelectedRow()
          Retrieve the selected row in the table control
 java.lang.Object getValue()
          (non-Javadoc)
 long getVerticalAlignment()
          (non-Javadoc)
 int getVisiableRows()
          Get the number of visiable rows being displayed
 boolean hasSearchMenus()
          Check if search menu flag is turned on
 boolean hasSortMenus()
          Check if sort menu flag is turned on
 void invalidate()
          Invalidate and repaint the table
 boolean keyChar(char key, int status, int time)
          (non-Javadoc)
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)
 void moveToBottom()
          Move focus to the bottom of the table
 void moveToTop()
          Move focus to the top of the table
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 onRecordChange()
          This method is called when the record selection changes.
protected  void onUnfocus()
          (non-Javadoc)
 void pageDown()
          Page down on the table
 void pageUp()
          Page up in the table
protected  void paint(net.rim.device.api.ui.Graphics g)
          (non-Javadoc)
 void populateEmptyTable()
          Create a empty table
 void refresh()
          (non-Javadoc)
protected abstract  void refreshFooter(java.lang.String valueToBeDisplay)
          Refresh the footer field from the screen that contains this table
 void resizeColumns()
          Resize the columns
 void setBackgroundColor(int bgcolor)
          (non-Javadoc)
 void setBanding(boolean banding)
          Set the table banding
 void setBorder(boolean border)
          Set the border on or off
 void setBorderColor(int color)
          Set the border color
 void setColSpan(int colspan)
          (non-Javadoc)
 void setColumnClickThru(int column, java.lang.String caLabel)
          Set the column click thru value
 void setColumnLabel(int column, java.lang.String label)
          Set the column label
 void setColumns(int columns)
          Set the number of columns
 void setColumnWidth(int column, java.lang.String typicalStr)
          Set the column width
 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 setDataRecordCount(int count)
          Set the data record count
 void setDefaultAction(IBOBAction action)
          Sets the table's default action
 void setEvenRowFontStyle(FontStyle fontStyle)
          Set the table even row font style
 void setFocusFontStyle(FontStyle fontStyle)
          Set the table focus font style
 void setHasAltRow(boolean bol)
          Set if the table has alternating colors
 void setHasBorder(boolean bol)
          Set if the table has border
 void setHasSearchMenus(boolean bol)
          Set search menu flag
 void setHasSortMenus(boolean bol)
          Set sort menu flag
 void setHeaderFontStyle(FontStyle fontStyle)
          Set the table header font style
 void setHrefTextValue(java.lang.String hrefTextValue)
          Set the href key text value
 void setImageTextValue(java.lang.String imageTextValue)
          Set the image key text value
 void setLayoutHeight(int height)
          (non-Javadoc)
 void setLayoutWidth(int width)
          (non-Javadoc)
 void setOddRowFontStyle(FontStyle fontStyle)
          Set the table odd row font style
 void setOuterBorderColor(int color)
          Set the outer border color
 void setPendingFontStyle(FontStyle fontStyle)
          Set the table pending font style
 void setProperty(int key, java.lang.Object value)
          Set the property values for the table
 void setRowCount(int count)
          Set the row count for the table
 void setRowSpan(int rowspan)
          (non-Javadoc)
 void setSelectedRow(int currentRecordIndex)
          Set the selected row in the table control
 void setTopRow(int row)
          Set the Top Row
 void setupVisibleRows()
          Setup the possible visible rows that can be displayed on the screen
 void setVisibleRows(int visible)
          Set the number of visiable rows
protected  boolean touchEvent(net.rim.device.api.ui.TouchEvent message)
           
 
Methods inherited from class net.rim.device.api.ui.Field
drawHighlightRegion, fieldChangeNotify, focusAdd, focusChangeNotify, focusRemove, getAccessibleContext, 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, keyControl, keyDown, 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, trackwheelClick, trackwheelUnclick, updateLayout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY

public static final long KEY
See Also:
Constant Field Values

DEFAULT_BORDER_COLOR

public static final int DEFAULT_BORDER_COLOR
See Also:
Constant Field Values

_controller

protected net.rim.device.api.ui.UiApplication _controller

_customEventsHandler

protected CustomEventsHandler _customEventsHandler

_controlID

protected int _controlID

_orientation

protected int _orientation
Constructor Detail

TableField

public TableField()
Constructor to create the table field control

Method Detail

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)

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)

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

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

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

refresh

public void refresh()
(non-Javadoc)

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

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)

populateEmptyTable

public void populateEmptyTable()
Create a empty table


addMenuItem

public void addMenuItem(net.rim.device.api.ui.MenuItem menu)
Add Menu Item to the Table control

Parameters:
menu - MenuItem menu object
See Also:
MenuItem

addMenuSeperator

public void addMenuSeperator()
Add menu seperator


clearMenuItems

public void clearMenuItems()
Remove all the menu items on the table control


getHeaderFontStyle

public FontStyle getHeaderFontStyle()
Get the table header font style

Returns:
FontStyle font style object
See Also:
FontStyle

setHeaderFontStyle

public void setHeaderFontStyle(FontStyle fontStyle)
Set the table header font style

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

getEvenRowFontStyle

public FontStyle getEvenRowFontStyle()
Get the table even row font style

Returns:
FontStyle font style object
See Also:
FontStyle

setEvenRowFontStyle

public void setEvenRowFontStyle(FontStyle fontStyle)
Set the table even row font style

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

getOddRowFontStyle

public FontStyle getOddRowFontStyle()
Get the table odd row font style

Returns:
FontStyle font style object
See Also:
FontStyle

setOddRowFontStyle

public void setOddRowFontStyle(FontStyle fontStyle)
Set the table odd row font style

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

getPendingFontStyle

public FontStyle getPendingFontStyle()
Get the table Pending font style

Returns:
FontStyle font style object
See Also:
FontStyle

setPendingFontStyle

public void setPendingFontStyle(FontStyle fontStyle)
Set the table pending font style

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

getFocusFontStyle

public FontStyle getFocusFontStyle()
Get the table focus font style

Returns:
FontStyle font style object
See Also:
FontStyle

setFocusFontStyle

public void setFocusFontStyle(FontStyle fontStyle)
Set the table focus font style

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

setHasAltRow

public void setHasAltRow(boolean bol)
Set if the table has alternating colors

Parameters:
bol - true if there are alternating row colors, otherwise false

setHasBorder

public void setHasBorder(boolean bol)
Set if the table has border

Parameters:
bol - true if there are border, otherwise false

setOuterBorderColor

public void setOuterBorderColor(int color)
Set the outer border color

Parameters:
color - int HEX value for the outer border color. Examples of colors are 0x00FFFFFF, 0x00FF0000, 0x00000000

setBorderColor

public void setBorderColor(int color)
Set the border color

Parameters:
color - int HEX value for the border color. Examples of colors are 0x00FFFFFF, 0x00FF0000, 0x00000000

setProperty

public void setProperty(int key,
                        java.lang.Object value)
Set the property values for the table

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

setHasSearchMenus

public void setHasSearchMenus(boolean bol)
Set search menu flag

Parameters:
bol - true if there are search menus, otherwise false

hasSearchMenus

public boolean hasSearchMenus()
Check if search menu flag is turned on

Returns:
true if there are search menus, otherwise falses

setHasSortMenus

public void setHasSortMenus(boolean bol)
Set sort menu flag

Parameters:
bol - true if there are sort menus, otherwise falses

hasSortMenus

public boolean hasSortMenus()
Check if sort menu flag is turned on

Returns:
true if there are sort menus, otherwise false

drawFocus

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

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

setImageTextValue

public void setImageTextValue(java.lang.String imageTextValue)
Set the image key text value

Parameters:
imageTextValue - String value for the image text value

setHrefTextValue

public void setHrefTextValue(java.lang.String hrefTextValue)
Set the href key text value

Parameters:
hrefTextValue - String value for the Href text value

getFocusRect

public void getFocusRect(net.rim.device.api.ui.XYRect rect)
Retrieve the focus section

Overrides:
getFocusRect in class net.rim.device.api.ui.Field
Parameters:
XYRect - XYRect value for the focused section

getHeaderHeight

public int getHeaderHeight()
Get the header height

Returns:
int value for the header height

getPreferredHeight

public int getPreferredHeight()
(non-Javadoc)

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

getPreferredWidth

public int getPreferredWidth()
(non-Javadoc)

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

getDataRecordCount

public int getDataRecordCount()
Get the data record count

Returns:
int value for the number of data record

setDataRecordCount

public void setDataRecordCount(int count)
Set the data record count

Parameters:
count - int value for the number of data records

getRowCount

public int getRowCount()
Retrieve the table row count

Returns:
int value for the number of rows in this table

getRowFont

public net.rim.device.api.ui.Font getRowFont()
Retrieve the row font

Returns:
Font font object
See Also:
Font

getRowHeight

public int getRowHeight()
Retrieve the row height

Returns:
int value for the row height

getSelectedRow

public int getSelectedRow()
Retrieve the selected row in the table control

Returns:
int value for the position of the selected row

setSelectedRow

public void setSelectedRow(int currentRecordIndex)
Set the selected row in the table control


invalidate

public void invalidate()
Invalidate and repaint the table

Overrides:
invalidate in class net.rim.device.api.ui.Field

setupVisibleRows

public void setupVisibleRows()
Setup the possible visible rows that can be displayed on the screen


layout

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

Specified by:
layout in class net.rim.device.api.ui.Field
See Also:
Field.layout(int width, int height)

makeContextMenu

protected void makeContextMenu(net.rim.device.api.ui.ContextMenu menu)
(non-Javadoc)

Overrides:
makeContextMenu in class net.rim.device.api.ui.Field
See Also:
Field.makeContextMenu(ContextMenu menu)

createImageScreen

protected ImageScreen createImageScreen(int rowIndex,
                                        int columnIndex)
Create an image screen for the table item selected.

Parameters:
rowIndex - int value for the row index of the selected cell
columnIndex - int value for the column index of the selected cell
Returns:
ImageScreen image screen object
See Also:
ImageScreen

moveFocus

protected int moveFocus(int amount,
                        int status,
                        int time)
(non-Javadoc)

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

paint

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

Specified by:
paint in class net.rim.device.api.ui.Field
See Also:
Field.paint(Graphics g)

resizeColumns

public void resizeColumns()
Resize the columns


setBanding

public void setBanding(boolean banding)
Set the table banding

Parameters:
banding - true to turn on the banding, otherwise false

setBorder

public void setBorder(boolean border)
Set the border on or off

Parameters:
border - true to turn on the border, otherwise false

setColumns

public void setColumns(int columns)
Set the number of columns

Parameters:
columns - int value for the number of columns

setColumnLabel

public void setColumnLabel(int column,
                           java.lang.String label)
Set the column label

Parameters:
column - int value for the column index
label - int value for the label of this column

setColumnClickThru

public void setColumnClickThru(int column,
                               java.lang.String caLabel)
Set the column click thru value

Parameters:
column - int value for the column index
caLabel - String value for the clickacross label

setColumnWidth

public void setColumnWidth(int column,
                           java.lang.String typicalStr)
Set the column width

Parameters:
column - int value for the position of the column
typicalStr - String value for the number of characters to display

setRowCount

public void setRowCount(int count)
Set the row count for the table

Parameters:
count - String value for the number of rows

setTopRow

public void setTopRow(int row)
Set the Top Row

Parameters:
row - String value for the row position

setVisibleRows

public void setVisibleRows(int visible)
Set the number of visiable rows

Parameters:
visible - String value for the number of visible rows

getVisiableRows

public int getVisiableRows()
Get the number of visiable rows being displayed

Returns:
String value for the number of visiable rows.

getSelectedColumn

public int getSelectedColumn()
The current selected column

Returns:
String value for the selected column

refreshFooter

protected abstract void refreshFooter(java.lang.String valueToBeDisplay)
Refresh the footer field from the screen that contains this table

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

getMobileAppID

protected abstract java.lang.String getMobileAppID()
Retrieve the Mobile Application ID

Returns:
String value for the mobile application ID

getColumnValues

protected abstract boolean getColumnValues(int rowIndex,
                                           java.lang.Object[] columns)
Retrieve the row data values

Parameters:
rowIndex - int value for the row index to retrieve the data values
columns - Object array to hold the data values
Returns:
true if the row is new or updated, otherise false

getColumnLogicalType

protected abstract LogicalType getColumnLogicalType(int columnIndex)
Retrieve the column logical type

Parameters:
columnIndex - int value for the column on table
Returns:
LogicalType logical type object
See Also:
LogicalType

getLogicalTypeItems

protected abstract java.util.Vector getLogicalTypeItems()
Retrieve all MBO attribute's information which have logical type defined

Returns:
Vector list of logical type items

getColumnSchemaType

protected abstract java.lang.String getColumnSchemaType(int columnIndex)
Retrieve the column schema type

Parameters:
columnIndex - int value for the column index
Returns:
String value for the column schema type. Can be values in MBOAttribute schema type constants. For example, MBOAttribute.SCHEMA_TYPE_STRING, MBOAttribute.SCHEMA_TYPE_INT, MBOAttribute.SCHEMA_TYPE_DATE
See Also:
MBOAttribute

getApplicationData

public abstract MBOModel getApplicationData()
Retrieve the MBO that is set to the table

Returns:
MBOModel object that represents a MBO
See Also:
MBOModel

getRowByIndex

public abstract java.lang.Object getRowByIndex(int rowIndex)
Retrieve data of a row by row index of the table

Parameters:
rowIndex - int value for the row index that starts from 0
Returns:
OBject that represents data of a table row

moveToTop

public void moveToTop()
Move focus to the top of the table


moveToBottom

public void moveToBottom()
Move focus to the bottom of the table


pageUp

public void pageUp()
Page up in the table


pageDown

public void pageDown()
Page down on the table


keyChar

public boolean keyChar(char key,
                       int status,
                       int time)
(non-Javadoc)

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

setDefaultAction

public void setDefaultAction(IBOBAction action)
Sets the table's default action

Parameters:
action - the default action to set

onFocus

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

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

onUnfocus

protected void onUnfocus()
(non-Javadoc)

Overrides:
onUnfocus in class net.rim.device.api.ui.Field
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)

onRecordChange

protected void onRecordChange()
This method is called when the record selection changes.


touchEvent

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

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