|
|||||||||
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.Manager
net.rim.device.api.ui.Screen
net.rim.device.api.ui.container.FullScreen
net.rim.device.api.ui.container.MainScreen
com.sybase.uep.bobclient.screens.BaseBOBScreen
public abstract class BaseBOBScreen
This is a base implementation of a screen used in BOB Blackberry client.
This base screen is extended by all the generated screen from BOB tooling
as well as the base stock screen BaseBOBStockScreen
.
Extends from MainScreen
BaseBOBStockScreen
,
IBOBScreen
,
MainScreen
,
Runnable
Field Summary | |
---|---|
protected AppLoggerWrapper |
_appLogger
|
static long |
KEY
|
Fields inherited from class net.rim.device.api.ui.container.MainScreen |
---|
NO_STATUS_SEPARATOR, NO_TITLE_SEPARATOR |
Fields inherited from class net.rim.device.api.ui.Screen |
---|
DEFAULT_CLOSE, DEFAULT_MENU, NO_SYSTEM_MENU_ITEMS |
Fields inherited from class net.rim.device.api.ui.Manager |
---|
BOTTOMMOST, DOWNWARD, HORIZONTAL_SCROLL, HORIZONTAL_SCROLL_MASK, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_MASK, LEAVE_BLANK_SPACE, LEFTMOST, LEFTWARD, NO_HORIZONTAL_SCROLL, NO_HORIZONTAL_SCROLLBAR, NO_SCROLL_RESET, NO_VERTICAL_SCROLL, NO_VERTICAL_SCROLLBAR, QUANTA_FONT, RIGHTMOST, RIGHTWARD, TOPMOST, UPWARD, VERTICAL_SCROLL, VERTICAL_SCROLL_MASK, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_MASK |
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 | |
---|---|
BaseBOBScreen()
Constructor to create a base BOB screen |
|
BaseBOBScreen(long style)
Constructor to create a base BOB screen |
Method Summary | |
---|---|
net.rim.device.api.ui.MenuItem |
addMenuAction(int resourceID,
IBOBAction action)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(int resourceID,
IBOBAction action,
ControlVariable variable,
int menuGroupType)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(int resourceID,
IBOBAction action,
ControlVariable variable,
int menuGroupType,
net.rim.device.api.ui.Field control,
boolean showForTable)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(int resourceID,
IBOBAction action,
int menuGroupType)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(MenuAction mi,
int menuGroupType)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(java.lang.String label,
IBOBAction action)
Add new menu Runnable action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(java.lang.String label,
IBOBAction action,
ControlVariable variable,
int menuGroupType)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(java.lang.String label,
IBOBAction action,
ControlVariable variable,
int menuGroupType,
net.rim.device.api.ui.Field control,
boolean showForTable)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(java.lang.String label,
IBOBAction action,
int menuGroupType)
Add new menu action to this screen |
net.rim.device.api.ui.MenuItem |
addMenuAction(java.lang.String label,
IBOBAction action,
int menuGroupType,
net.rim.device.api.ui.Field control)
Add new menu action to this screen |
void |
addMenuSeperator()
Add a menu seperator |
void |
addMenuSeperator(int menuGroupType)
Add a menu seperator |
void |
addReferencedMBO(java.lang.String mboId)
(non-Javadoc) |
void |
addSourceConnectionReference(java.lang.String connectionType,
java.lang.String screenId,
IBOBScreen screen)
(non-Javadoc) |
void |
addSpacer(int lines)
Add spacers between fields |
void |
askMobileDataControlRefresh()
(non-Javadoc) |
void |
closeScreen()
Pop off this screen from the UI stack |
protected abstract void |
defineScreen()
This is called by the run method Instantiation of layout and controls added to the screen should be defined in this method |
void |
deleteMenuAction(java.lang.String menuName)
Delete menu action by menu name |
FooterField |
getFooter()
Get the footer field of this screen |
java.lang.String |
getLabelMsgString(int key,
java.lang.String defaultLabelMsg)
Get the label or message string based on the key |
java.lang.Object |
getLabelMsgValue(int key)
Retrieve the label/message based on the resource key |
MenuGroup |
getMenuGroup()
Get the menu group |
MenuAction |
getMenuItemByName(java.lang.String menuName)
Check to see if a menu item by name exist |
MenuAction |
getMenuItemByNameAndDisable(java.lang.String menuName)
Check to see if a menu item by name exist Return the Menu Item and disable it |
IBOBScreen |
getParentScreen()
(non-Javadoc) |
java.util.Vector |
getReferencedMBOList()
(non-Javadoc) |
ScreenContext |
getScreenContext()
(non-Javadoc) |
net.rim.device.api.ui.component.GaugeField |
getSyncProgressBar()
(non-Javadoc) |
protected net.rim.device.api.ui.UiApplication |
getUIController()
|
protected void |
initAppLogger()
|
void |
initScreenContext(IBOBScreen parentScreen,
java.lang.String[] relationshipList)
(non-Javadoc) |
boolean |
isCache()
Check if screen is cached |
boolean |
isSynchronizing()
Returns whether the screen is in synchronization. |
boolean |
keyChar(char key,
int status,
int time)
(non-Javadoc) |
protected void |
makeMenu(net.rim.device.api.ui.component.Menu menu,
int instance)
(non-Javadoc) |
protected void |
onFocusNotify(boolean focus)
(non-Javadoc) |
void |
refresh()
(non-Javadoc) |
void |
refreshScreenContext()
(non-Javadoc) |
void |
run()
(non-Javadoc) |
void |
setFooter(java.lang.Object footer)
Set the footer for this screen using a custom footer control |
void |
setFooterBorderColor(int color)
Set the border color for the footer |
void |
setFooterFontStyle(FontStyle fs)
Set the footer font style on the screen |
void |
setFooterHasBorder(boolean hasBorder)
Set to have border around the footer or not |
void |
setFooterLabel(java.lang.String label)
Set the label for the footer |
void |
setHeaderFooter(java.lang.Object header,
java.lang.Object footer)
Set the header and footer object to show on the screen |
void |
setIsCache(boolean bol)
Set if the screen is cached |
void |
setLabelMsgValue(int key,
java.lang.String labelMsg)
Set the label/message based on the resource key |
void |
setParentScreen(IBOBScreen parentScreen)
(non-Javadoc) |
void |
setProperty(int key,
int resourceID)
Set the property values for the screen |
void |
setProperty(int key,
java.lang.Object value)
Set the property values for this screen |
void |
setSynchronizing(boolean isSynchronizing)
(non-Javadoc) |
Methods inherited from class net.rim.device.api.ui.container.MainScreen |
---|
addMenuItem, getField, getFieldCount, getFieldWithFocus, getFieldWithFocusIndex, getMainManager, keyCharUnhandled, onSavePrompt, removeAllMenuItems, removeMenuItem, setBanner, setId, setStatus, setTitle, setTitle, setTitle, setTitle |
Methods inherited from class net.rim.device.api.ui.container.FullScreen |
---|
sublayout |
Methods inherited from class net.rim.device.api.ui.Screen |
---|
add, addKeyListener, addScreenUiEngineAttachedListener, addTrackwheelListener, close, delete, deleteRange, dispatchKeyEvent, doLayout, doPaint, ensureRegionVisible, getAccessibleContext, getApplication, getDefaultMenuItem, getDelegate, getFieldAtLocation, getFocusRect, getGraphics, getLeafFieldWithFocus, getMenu, getScreenAbove, getScreenBelow, getUiEngine, getVirtualKeyboard, insert, invalidate, invalidate, invalidateAll, invalidateLayout, invokeAction, isDataValid, isDirty, isDisplayed, isFocus, isFocusable, isGlobal, isGlobalStatus, isMuddy, isObscured, isSelecting, keyControl, keyDown, keyRepeat, keyStatus, keyUp, layoutDelegate, navigationClick, navigationMovement, navigationUnclick, onClose, onDisplay, onExposed, onFocus, onMenu, onMenuDismissed, onMenuDismissed, onObscured, onSave, onUiEngineAttached, onUndisplay, onUnfocus, openDevelopmentBackdoor, openProductionBackdoor, paint, paintBackground, removeFocus, removeKeyListener, removeScreenUiEngineAttachedListener, removeTrackwheelListener, replace, save, scroll, setBackdoorAltStatus, setDefaultClose, setDirty, setFocus, setFocus, setFocus, setHorizontalQuantization, setPositionDelegate, setTrackballFilter, setTrackballSensitivityXOffset, setTrackballSensitivityYOffset, setVerticalQuantization, touchEvent, trackwheelClick, trackwheelClickUnhandled, trackwheelRoll, trackwheelUnclick, updateDisplay |
Methods inherited from class net.rim.device.api.ui.Manager |
---|
clearCustomScrollArrows, deleteAll, getHorizontalScroll, getPreferredHeightOfChild, getPreferredWidthOfChild, getVerticalScroll, getVirtualHeight, getVirtualWidth, getVisibleHeight, getVisibleWidth, invalidateFieldRange, isDownArrowShown, isUpArrowShown, isValidLayout, layout, layoutChild, moveFocus, moveFocus, moveFocus, nextFocus, nextFocus, paintChild, setFocus, setHorizontalScroll, setNonfocusableOverride, setPositionChild, setScrollListener, setVerticalScroll, setVirtualExtent, subpaint |
Methods inherited from class net.rim.device.api.ui.Field |
---|
drawFocus, 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, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPreferredHeight, getPreferredWidth, getScreen, getState, getStyle, getTop, getVisualState, getWidth, isEditable, isPasteable, isSelectable, isSelectionCopyable, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, makeContextMenu, makeContextMenu, onVisibilityChange, paste, select, selectionCopy, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCookie, setEditable, setExtent, setFocusListener, setFont, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPadding, setPadding, setPosition, setVisualState, updateLayout |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long KEY
protected AppLoggerWrapper _appLogger
Constructor Detail |
---|
public BaseBOBScreen()
By default this is called by code generation.
public BaseBOBScreen(long style)
This can only be used internally by the parent subclass.
style
- long
value for the screen styleField
Method Detail |
---|
public void run()
run
in interface IBOBScreen
run
in interface java.lang.Runnable
IBOBScreen.run()
protected abstract void defineScreen()
public void addSourceConnectionReference(java.lang.String connectionType, java.lang.String screenId, IBOBScreen screen)
addSourceConnectionReference
in interface IBOBScreen
connectionType
- String
value for the type of connection defined by the bob_1_2.xsd, ie.
screenId
- String
value for the the unique id attached to the screen in the Bob model design.screen
- IBOBScreen
value for the actual screen referenced in the code generation.IBOBScreen.addSourceConnectionReference(String connectionType, String screenId, IBOBScreen screen)
public boolean isCache()
true
means the screen is cached and doesn't need to be redrawn, otherwise false
public void setIsCache(boolean bol)
bol
- true
if cached, otherwise true
xpublic void setParentScreen(IBOBScreen parentScreen)
setParentScreen
in interface IBOBScreen
parentScreen
- IBOBScreen
screen referenceIBOBScreen.setParentScreen(IBOBScreen parentScreen)
public IBOBScreen getParentScreen()
getParentScreen
in interface IBOBScreen
IBOBScreen
screen referenceIBOBScreen.getParentScreen()
public MenuGroup getMenuGroup()
MenuGroup
objectMenuGroup
public MenuAction getMenuItemByName(java.lang.String menuName)
menuName
- String
value for the menu name to search
MenuAction
menu action objectMenuAction
public MenuAction getMenuItemByNameAndDisable(java.lang.String menuName)
menuName
- String
value for the menu name to search and disable
MenuAction
menu action objectMenuAction
protected void makeMenu(net.rim.device.api.ui.component.Menu menu, int instance)
makeMenu
in class net.rim.device.api.ui.container.MainScreen
MainScreen.makeMenu(Menu menu, int instance)
public void setHeaderFooter(java.lang.Object header, java.lang.Object footer)
header
- Object
value for the header objectfooter
- Object
value for the footer objectpublic void setFooterFontStyle(FontStyle fs)
fs
- FontStyle
objectFontStyle
public void setFooterHasBorder(boolean hasBorder)
bol
- true
if the footer has a border around it, otherwise false
public void setFooterBorderColor(int color)
int
- Hex value for the color of the footer
Example of some Hex value would be 0x00FF0000, 0x00FFFFFF, 0x00000000public void setFooterLabel(java.lang.String label)
String
- value for the labelpublic void setFooter(java.lang.Object footer)
footer
- Object
value that can be a String
, FooterField
, or a Field
FooterField
,
Field
public FooterField getFooter()
FooterField
footer objectFooterField
public void addMenuSeperator()
public void addMenuSeperator(int menuGroupType)
menuGroupType
- int
value for the menu group type
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or
MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuGroup
public net.rim.device.api.ui.MenuItem addMenuAction(java.lang.String label, IBOBAction action)
label
- String
value for them enu labelaction
- IBOBAction
action object to perform
MenuItem
menu objectMenuItem
,
IBOBAction
public net.rim.device.api.ui.MenuItem addMenuAction(int resourceID, IBOBAction action)
resourceID
- int
value for the localization resource ID of the menu labelaction
- IBOBAction
action object to perform
MenuItem
menu item objectMenuItem
public net.rim.device.api.ui.MenuItem addMenuAction(java.lang.String label, IBOBAction action, int menuGroupType)
label
- String
value for them enu labelaction
- IBOBAction
action object to performmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuItem
menu item objectMenuItem
,
MenuGroup
public net.rim.device.api.ui.MenuItem addMenuAction(int resourceID, IBOBAction action, int menuGroupType)
resourceID
- int
value for the localization resource ID of the menu labelaction
- IBOBAction
action object to performmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuItem
menu item objectMenuItem
,
MenuGroup
public net.rim.device.api.ui.MenuItem addMenuAction(java.lang.String label, IBOBAction action, int menuGroupType, net.rim.device.api.ui.Field control)
label
- String
value for them enu labelaction
- IBOBAction
action object to performmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
control
- Field
value for the focus control
MenuItem
menu item objectMenuItem
,
MenuGroup
public net.rim.device.api.ui.MenuItem addMenuAction(int resourceID, IBOBAction action, ControlVariable variable, int menuGroupType)
resourceID
- int
value for the localization resource ID of the menu labelaction
- IBOBAction
action object to performvariable
- ControlVariable
object used to get user defined valuesmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuItem
menu item objectMenuItem
,
MenuGroup
,
ControlVariable
public net.rim.device.api.ui.MenuItem addMenuAction(java.lang.String label, IBOBAction action, ControlVariable variable, int menuGroupType)
label
- String
value for them enu labelaction
- IBOBAction
action object to performvariable
- ControlVariable
object used to get user defined valuesmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuItem
menu item objectMenuItem
,
MenuGroup
,
ControlVariable
public net.rim.device.api.ui.MenuItem addMenuAction(int resourceID, IBOBAction action, ControlVariable variable, int menuGroupType, net.rim.device.api.ui.Field control, boolean showForTable)
resourceID
- int
value for the localization resource ID of the menu labelaction
- IBOBAction
action object to performvariable
- ControlVariable
object used to get user defined valuesmenuGroupType
- int
value for the menu group type.
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
control
- Field
value for the focus controlshowForTable
- boolean
boolean value whether to always show the menu for the focus table
MenuItem
menu item objectMenuItem
,
MenuGroup
,
ControlVariable
public net.rim.device.api.ui.MenuItem addMenuAction(java.lang.String label, IBOBAction action, ControlVariable variable, int menuGroupType, net.rim.device.api.ui.Field control, boolean showForTable)
label
- String
value for them enu labelaction
- IBOBAction
action object to performvariable
- ControlVariable
object used to get user defined valuesmenuGroupType
- int
value for the menu group type.s
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
control
- if not null, we add the menu action into the controlshowForTable
- boolean
boolean value whether to always show the menu for the focus table
MenuItem
menu item objectMenuItem
,
MenuGroup
public net.rim.device.api.ui.MenuItem addMenuAction(MenuAction mi, int menuGroupType)
MenuAction
- com.sybase.uep.bobclient.controls.IBOBAction
menu action to addmenuGroupType
- int
value for the menu group type.s
Can be MenuGroup.MENU_GROUP_TYPE_ABOVE_CONTEXT
or MenuGroup.MENU_GROUP_TYPE_BELOW_CONTEXT
MenuItem
menu item objectMenuItem
,
MenuGroup
public void deleteMenuAction(java.lang.String menuName)
menuName
- String
value for the menu namepublic void closeScreen()
public void addSpacer(int lines)
int
- value for the lines number of linespublic void refresh()
refresh
in interface IBOBScreen
IBOBScreen.refresh()
public java.lang.String getLabelMsgString(int key, java.lang.String defaultLabelMsg)
key
- int
value for the reference key of the label or messagedefaultLabelMsg
- String
value for the label message
String
value of the label/messagepublic java.lang.Object getLabelMsgValue(int key)
key
- int
value for the resource key
Object
value of the label/messagepublic void setLabelMsgValue(int key, java.lang.String labelMsg)
key
- int
value for the resource keylabelMsg
- String
value for the new label/message valuepublic void setProperty(int key, int resourceID)
key
- int
value for the screen property attributeresourceID
- int
for the string localization resource IDpublic void setProperty(int key, java.lang.Object value)
key
- int
value for a screen attributevalue
- Object
value for the attribute valueScreenProperties
public boolean keyChar(char key, int status, int time)
keyChar
in class net.rim.device.api.ui.Screen
Screen.keyChar(char key,int status,int time)
public void addReferencedMBO(java.lang.String mboId)
addReferencedMBO
in interface IBOBScreen
IBOBScreen.addReferencedMBO(String mboId)
public java.util.Vector getReferencedMBOList()
getReferencedMBOList
in interface IBOBScreen
Vector
value for the list of referenced MBO listIBOBScreen.getReferencedMBOList()
public ScreenContext getScreenContext()
getScreenContext
in interface IBOBScreen
ScreenContext
screen context objectIBOBScreen.getScreenContext()
public void refreshScreenContext()
refreshScreenContext
in interface IBOBScreen
IBOBScreen.refreshScreenContext()
protected void onFocusNotify(boolean focus)
onFocusNotify
in class net.rim.device.api.ui.Screen
Screen.onFocusNotify(boolean focus)
public void askMobileDataControlRefresh()
askMobileDataControlRefresh
in interface IBOBScreen
IBOBScreen.askMobileDataControlRefresh()
public void initScreenContext(IBOBScreen parentScreen, java.lang.String[] relationshipList)
initScreenContext
in interface IBOBScreen
parentScreen
- IBOBScreen
parent screen that called this screenrelationshipList
- String
array of relationship informationIBOBScreen.initScreenContext(IBOBScreen parentScreen, String[] relationshipList)
public void setSynchronizing(boolean isSynchronizing)
setSynchronizing
in interface IBOBScreen
IBOBScreen.setSynchronizing(boolean isSynchronizing)
public boolean isSynchronizing()
IBOBScreen
isSynchronizing
in interface IBOBScreen
public net.rim.device.api.ui.component.GaugeField getSyncProgressBar()
getSyncProgressBar
in interface IBOBScreen
IBOBScreen.getSyncProgressBar()
protected net.rim.device.api.ui.UiApplication getUIController()
protected void initAppLogger()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |