com.sybase.uep.bobclient.controller
Interface UIController


public interface UIController

This is the UI Controller interface This will be interfaced with the BOB Client controller class.

Author:
tdang

Method Summary
 void addModalScreen(IBOBScreen screen)
          Add Modal screen to UI screen stack
 void addScreen(IBOBScreen screen)
          Add screen to UI screen stack
 void addScreen(IBOBScreen screen, boolean checkData)
          Add screen to UI screen stack
 void callActionAndWait(java.lang.Runnable runnable)
          Invoke the runnable class now and wait
 void callActionLater(java.lang.Runnable runnable)
          Invoke the runnable class later
 void callActionLater(java.lang.Runnable runnable, long time, boolean repeat)
          Invoke the runnable class later at a specific time
 void checkSyncProperties()
          Check the sync properties to sync in the background
 void clearAppMenuRepository()
          Clear registered menu items in ApplicationMenuItemRepository
 AppLoggerWrapper getAppLogger()
          Gets the application logger from current UIcontroller
 net.rim.device.api.ui.Screen getCurrentFocusScreen()
          Retrieve the screen currently in focus
 PushController getPushController()
          Get the push mobile application controller
 java.lang.Object getUIEventLock()
          Get the UI event lock
 UserActionListener getUserActionListener()
          Get the user action listener
 void removeAllScreens()
          Remove all screens from the UI screen stack but minimize the last one
 void removeAllScreens(boolean isMinimized)
          Remove all screens from the UI screen stack
 boolean removeScreen(net.rim.device.api.ui.Screen screen)
          Remove screen from the UI screen stack if the screen is not the last one in stack, otherwise minimize the screen.
 boolean removeScreen(net.rim.device.api.ui.Screen screen, boolean isMinimized)
          Remove screen from the UI screen stack
 void resetRefreshingApps()
          Reset currently refreshing applications
 void startup()
          Retrieve the first screen and push it to view
 

Method Detail

getPushController

PushController getPushController()
Get the push mobile application controller

Returns:
The PushController object to perform push request

getUserActionListener

UserActionListener getUserActionListener()
Get the user action listener

Returns:
The PushController object to perform push request

getUIEventLock

java.lang.Object getUIEventLock()
Get the UI event lock

Returns:
The Object of the UI event

callActionLater

void callActionLater(java.lang.Runnable runnable)
Invoke the runnable class later

Parameters:
runnable - runable class to be run

callActionLater

void callActionLater(java.lang.Runnable runnable,
                     long time,
                     boolean repeat)
Invoke the runnable class later at a specific time

Parameters:
runnable - runable class to be run
time - the time to execute the runnable class
repeat - condition to repeart the task

callActionAndWait

void callActionAndWait(java.lang.Runnable runnable)
Invoke the runnable class now and wait

Parameters:
runnable - runable class to be run

addScreen

void addScreen(IBOBScreen screen)
Add screen to UI screen stack

Parameters:
screen - - IBOBScreen reference to be added to UI stack

addScreen

void addScreen(IBOBScreen screen,
               boolean checkData)
Add screen to UI screen stack

Parameters:
screen - - IBOBScreen reference to be added to UI stack
checkData - - if true check the mobile business objects to sync

addModalScreen

void addModalScreen(IBOBScreen screen)
Add Modal screen to UI screen stack

Parameters:
screen - - IBOBScreen reference to be added to UI stack

removeAllScreens

void removeAllScreens()
Remove all screens from the UI screen stack but minimize the last one


removeAllScreens

void removeAllScreens(boolean isMinimized)
Remove all screens from the UI screen stack

Parameters:
isMinimized - - If true then the last screen in the stack will be minimized

removeScreen

boolean removeScreen(net.rim.device.api.ui.Screen screen)
Remove screen from the UI screen stack if the screen is not the last one in stack, otherwise minimize the screen.

Parameters:
screen - - IBOBScreen reference to be removed
Returns:
If true, the screen being removed is the last screen being removed from of the UI stack

removeScreen

boolean removeScreen(net.rim.device.api.ui.Screen screen,
                     boolean isMinimized)
Remove screen from the UI screen stack

Parameters:
screen - - IBOBScreen reference to be removed
isMinimized - - If true and the screen is the last one, it will be minimized, otherwise the screen is removed
Returns:
If true, the screen being removed is the last screen being removed from of the UI stack

getCurrentFocusScreen

net.rim.device.api.ui.Screen getCurrentFocusScreen()
Retrieve the screen currently in focus

Returns:
Screen - Screen reference

startup

void startup()
Retrieve the first screen and push it to view


checkSyncProperties

void checkSyncProperties()
Check the sync properties to sync in the background


resetRefreshingApps

void resetRefreshingApps()
Reset currently refreshing applications


getAppLogger

AppLoggerWrapper getAppLogger()
Gets the application logger from current UIcontroller


clearAppMenuRepository

void clearAppMenuRepository()
Clear registered menu items in ApplicationMenuItemRepository