com.sybase.uep.bobclient.screens
Interface IBOBScreen

All Known Implementing Classes:
AboutScreen, AppLogDetailScreen, BaseBOBScreen, BaseBOBSettingsScreen, BaseBOBStockScreen, FileExplorerScreen, GridSelectionScreen, ImageScreen, LoggingScreen, LogInfoScreen, LoginScreen, LogsScreen, MobileBusinessObjectInfoScreen, PendingOperationInfoScreen, PendingOperationScreen, PersonalizationScreen, ProfileScreen, ProfileUpdateScreen, PushLogsScreen, PushRequestScreen, PushSettingsScreen, ScalarPKEditorScreen, ScreenSaverScreen, SearchScreen, SplashScreen, SynchronizationGroupInfoScreen, SynchronizationScreen, SyncProgressScreen

public interface IBOBScreen

This is an interface implementation of a screen used in BOB Blackberry client. All screens needs to implement this interface.

This allows the screen to be hooked into the navigation of the designer and also allow navigation hooks to be passed to this screen for navigation from this screen to other designer based screens.

To use existing generated screens that layout out controls based on the designer, you will want to extend the base class BaseBOBScreen

Author:
tdang
See Also:
BaseBOBScreen

Method Summary
 void addReferencedMBO(java.lang.String mboId)
          Add a MBO to the referenced MBO list.
 void addSourceConnectionReference(java.lang.String connectionType, java.lang.String screenId, IBOBScreen screen)
          Every screen connection with this screen as the source and a target of another screen will be pass here for reference in the screen implementation incase it is needed.
 void askMobileDataControlRefresh()
          Send a refresh request to all MobileDataControl instances contained in this screen, asking them to refresh data.
 IBOBScreen getParentScreen()
          Retrieves the parent screen that called this screen
 java.util.Vector getReferencedMBOList()
          Retrieves the id of the referenced MBOs
 ScreenContext getScreenContext()
          Retrieves the context of this screen.
 net.rim.device.api.ui.component.GaugeField getSyncProgressBar()
          Obtains the sync progress bar of this screen
 void initScreenContext(IBOBScreen parentScreen, java.lang.String[] relationships)
          When switch to this screen from a parent one, will call this method to initialize the context
 boolean isSynchronizing()
          Returns whether the screen is in synchronization.
 void refresh()
          This will be called to refresh the screen
 void refreshScreenContext()
          Refreshes the screen context
 void run()
          This method is called when it is push onto the UI stack by the BOBController.
 void setParentScreen(IBOBScreen parentScreen)
          Set the parent screen that called this screen
 void setSynchronizing(boolean isSynchronizing)
          Sets the tag to indicate whether the screen is in synchronizing, and redraw the synchronizing indicator.
 

Method Detail

run

void run()
This method is called when it is push onto the UI stack by the BOBController. All initialization of layout and controls to the screen should be done here.

See Also:
BOBController

refresh

void refresh()
This will be called to refresh the screen


setParentScreen

void setParentScreen(IBOBScreen parentScreen)
Set the parent screen that called this screen

Parameters:
parentScreen - IBOBScreen screen reference

getParentScreen

IBOBScreen getParentScreen()
Retrieves the parent screen that called this screen

Returns:
IBOBScreen screen reference

addSourceConnectionReference

void addSourceConnectionReference(java.lang.String connectionType,
                                  java.lang.String screenId,
                                  IBOBScreen screen)
Every screen connection with this screen as the source and a target of another screen will be pass here for reference in the screen implementation incase it is needed. If the screen connection is used in an actions the screen will still be passed in the action but for unreferenced connection like done for custom coded screens this give access to these connections.

NOTE: this doesn't include "alert" connections because they have localizable parts and can't be used in a generic manor.

Parameters:
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.
See Also:
IBOBScreen

getScreenContext

ScreenContext getScreenContext()
Retrieves the context of this screen.

Returns:
ScreenContext screen context object
See Also:
ScreenContext

refreshScreenContext

void refreshScreenContext()
Refreshes the screen context


getReferencedMBOList

java.util.Vector getReferencedMBOList()
Retrieves the id of the referenced MBOs

Returns:
Vector value for the list of referenced MBO list

addReferencedMBO

void addReferencedMBO(java.lang.String mboId)
Add a MBO to the referenced MBO list. It is only added if it hasn't been contained in the list yet. Otherwise, nothing happens.

Parameters:
String - value for the mobile application ID

initScreenContext

void initScreenContext(IBOBScreen parentScreen,
                       java.lang.String[] relationships)
When switch to this screen from a parent one, will call this method to initialize the context

Parameters:
parentScreen - IBOBScreen parent screen that called this screen
relationships - String array of relationship information

askMobileDataControlRefresh

void askMobileDataControlRefresh()
Send a refresh request to all MobileDataControl instances contained in this screen, asking them to refresh data. However, there is no guarantee that MobileDataControl will actually perform refresh Data. They can decide by themselves whether to refresh or not according to current context.


isSynchronizing

boolean isSynchronizing()
Returns whether the screen is in synchronization.

Returns:
true if the screen is in synchronization and false otherwise.

setSynchronizing

void setSynchronizing(boolean isSynchronizing)
Sets the tag to indicate whether the screen is in synchronizing, and redraw the synchronizing indicator.

Parameters:
isSynchronizing -

getSyncProgressBar

net.rim.device.api.ui.component.GaugeField getSyncProgressBar()
Obtains the sync progress bar of this screen

Returns: