com.sybase.uep.bobclient.screens
Class LoginScreen

java.lang.Object
  extended by net.rim.device.api.ui.Field
      extended by net.rim.device.api.ui.Manager
          extended by net.rim.device.api.ui.Screen
              extended by net.rim.device.api.ui.container.FullScreen
                  extended by net.rim.device.api.ui.container.MainScreen
                      extended by com.sybase.uep.bobclient.screens.BaseBOBScreen
                          extended by com.sybase.uep.bobclient.screens.BaseBOBStockScreen
                              extended by com.sybase.uep.bobclient.screens.LoginScreen
All Implemented Interfaces:
IBOBScreen, java.lang.Runnable

public class LoginScreen
extends BaseBOBStockScreen

This is the login screen

This screen shows the password input screen to request user to enter a password

Author:
tdang
See Also:
BaseBOBStockScreen

Field Summary
static net.rim.device.api.system.EncodedImage DEFAULT_BANNER_IMAGE
           
static java.lang.String DEFAULT_CANCEL_BUTTON_LABEL
           
static java.lang.String DEFAULT_CANCEL_MENU_LABEL
           
static java.lang.String DEFAULT_ENTER_LOGIN_MESSAGE
           
static java.lang.String DEFAULT_ENTER_PASSWORD_MESSAGE
           
static java.lang.String DEFAULT_ERROR_AUTHENTICATE_MESSAGE
           
static java.lang.String DEFAULT_ERROR_LOADING_PROFILES_MESSAGE
           
static java.lang.String DEFAULT_FAILED_LOGIN_ALERT_MESSAGE
           
static java.lang.String DEFAULT_LOGIN_BUTTON_LABEL
           
static java.lang.String DEFAULT_LOGIN_INPUT_LABEL
           
static java.lang.String DEFAULT_LOGIN_MENU_LABEL
           
static java.lang.String DEFAULT_PASSWORD_INPUT_LABEL
           
static java.lang.String DEFAULT_TITLE_LABEL
           
static java.lang.String DEFAULT_WAIT_AUTHENTICATE_MESSAGE
           
 
Fields inherited from class com.sybase.uep.bobclient.screens.BaseBOBStockScreen
_backgroundImage, _isScaleBackgroundImageAspectFit, _navigationBarBorderStyle, _navigationBarStyle, _screenTitle
 
Fields inherited from class com.sybase.uep.bobclient.screens.BaseBOBScreen
_appLogger, 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
LoginScreen(int screenTitleRID)
          Constructor to create a login screen
LoginScreen(int screenTitleRID, boolean isScreenSaver)
          Constructor to create a login screen
LoginScreen(java.lang.String screenTitle)
          Constructor to create a login screen
LoginScreen(java.lang.String screenTitle, boolean isScreenSaver)
          Constructor to create a login screen
 
Method Summary
 void buttonClicked(net.rim.device.api.ui.Field buttonField)
          Overridden to perform actions when buttons are clicked on
 void callOnFailAction()
          Call on fail action
 void callOnSuccessAction(boolean isLoginToSyncRequired)
          call the on success action
protected  void defineScreen()
          (non-Javadoc)
 FontStyle getButtonFocusFontStyle()
          Get the button focus font style
 FontStyle getButtonUnfocusFontStyle()
          Get the button unfocus font style
 IBOBAction getFailedLoginAlertMessageAction(java.lang.String errorMessage)
          Get the failed login alert message action
 IBOBAction getOnFailAction()
          Get on fail action
 IBOBAction getOnSuccessAction()
          Get the on success action
 FontStyle getScreenFontStyle()
          Get this screen's font style
protected  boolean onSavePrompt()
          This is called when the user click the escape We will then want to ask if the user want to save the form
 void refresh()
          (non-Javadoc)
 void setBannerImage(net.rim.device.api.system.EncodedImage banner)
          Set the banner of the login screen
 void setBannerImage(java.lang.String imageName)
          Set the banner of the login screen by image name
 void setButtonExitLabel(java.lang.String label)
          Set button exit label
 void setButtonFocusFontStyle(FontStyle fontStyle)
          Set the button focus font style for this control
 void setButtonLoginLabel(java.lang.String label)
          Set button login label
 void setButtonUnfocusFontStyle(FontStyle fontStyle)
          Set the button unfocus font style for this control
 void setErrorAuthenticateMessage(java.lang.String str)
          Set the error authenticate message
 void setErrorLoadingProfileMsg(java.lang.String msg)
          Set the error loading profile message string
 void setFailedLoginAlertMessage(java.lang.String msg)
          Set the failed login alert message string
 void setIsScreenSaver(boolean isScreenSaver)
          Set isScreenSaver flag.
 void setLoginInputLabel(java.lang.String label)
          Set the login input label
 void setLoginPromptMessage(java.lang.String str)
          Set the login prompt message
 void setMenuCancelLabel(java.lang.String label)
          Set menu exit label for exit
 void setMenuLoginLabel(java.lang.String label)
          Set menu login label for login
 void setOnFail(IBOBAction action)
          Set on fail action
 void setOnSuccess(IBOBAction action)
          Set the on success action
 void setPasswordInputLabel(java.lang.String label)
          Set the password input label
 void setPasswordPromptMessage(java.lang.String str)
          Set the password prompt message
 void setProperty(int key, java.lang.Object value)
          Set the property values for this screen
 void setScreenFontStyle(FontStyle fontStyle)
          Set the font style for this screen
 void setShowButtons(boolean bol)
          Show or hide login and exit buttons
 void setShowLogo(boolean bol)
          Hide or show the banner logo
 void setWaitAuthenticateMessage(java.lang.String str)
          Set the wait authenticate message
 
Methods inherited from class com.sybase.uep.bobclient.screens.BaseBOBStockScreen
closeScreen, runOnSaveActions, setNavigationBarBorderStyle, setNavigationBarLabel, setNavigationBarStyle, setOnCloseActions, setOnSaveActions
 
Methods inherited from class com.sybase.uep.bobclient.screens.BaseBOBScreen
addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuAction, addMenuSeperator, addMenuSeperator, addReferencedMBO, addSourceConnectionReference, addSpacer, askMobileDataControlRefresh, deleteMenuAction, getFooter, getLabelMsgString, getLabelMsgValue, getMenuGroup, getMenuItemByName, getMenuItemByNameAndDisable, getParentScreen, getReferencedMBOList, getScreenContext, getSyncProgressBar, getUIController, initAppLogger, initScreenContext, isCache, isSynchronizing, keyChar, makeMenu, onFocusNotify, refreshScreenContext, run, setFooter, setFooterBorderColor, setFooterFontStyle, setFooterHasBorder, setFooterLabel, setHeaderFooter, setIsCache, setLabelMsgValue, setParentScreen, setProperty, setSynchronizing
 
Methods inherited from class net.rim.device.api.ui.container.MainScreen
addMenuItem, getField, getFieldCount, getFieldWithFocus, getFieldWithFocusIndex, getMainManager, keyCharUnhandled, 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

DEFAULT_TITLE_LABEL

public static final java.lang.String DEFAULT_TITLE_LABEL
See Also:
Constant Field Values

DEFAULT_BANNER_IMAGE

public static final net.rim.device.api.system.EncodedImage DEFAULT_BANNER_IMAGE

DEFAULT_LOGIN_INPUT_LABEL

public static final java.lang.String DEFAULT_LOGIN_INPUT_LABEL
See Also:
Constant Field Values

DEFAULT_PASSWORD_INPUT_LABEL

public static final java.lang.String DEFAULT_PASSWORD_INPUT_LABEL
See Also:
Constant Field Values

DEFAULT_LOGIN_MENU_LABEL

public static final java.lang.String DEFAULT_LOGIN_MENU_LABEL
See Also:
Constant Field Values

DEFAULT_CANCEL_MENU_LABEL

public static final java.lang.String DEFAULT_CANCEL_MENU_LABEL
See Also:
Constant Field Values

DEFAULT_LOGIN_BUTTON_LABEL

public static final java.lang.String DEFAULT_LOGIN_BUTTON_LABEL
See Also:
Constant Field Values

DEFAULT_CANCEL_BUTTON_LABEL

public static final java.lang.String DEFAULT_CANCEL_BUTTON_LABEL
See Also:
Constant Field Values

DEFAULT_ENTER_LOGIN_MESSAGE

public static final java.lang.String DEFAULT_ENTER_LOGIN_MESSAGE
See Also:
Constant Field Values

DEFAULT_ENTER_PASSWORD_MESSAGE

public static final java.lang.String DEFAULT_ENTER_PASSWORD_MESSAGE
See Also:
Constant Field Values

DEFAULT_WAIT_AUTHENTICATE_MESSAGE

public static final java.lang.String DEFAULT_WAIT_AUTHENTICATE_MESSAGE
See Also:
Constant Field Values

DEFAULT_FAILED_LOGIN_ALERT_MESSAGE

public static final java.lang.String DEFAULT_FAILED_LOGIN_ALERT_MESSAGE
See Also:
Constant Field Values

DEFAULT_ERROR_AUTHENTICATE_MESSAGE

public static final java.lang.String DEFAULT_ERROR_AUTHENTICATE_MESSAGE
See Also:
Constant Field Values

DEFAULT_ERROR_LOADING_PROFILES_MESSAGE

public static final java.lang.String DEFAULT_ERROR_LOADING_PROFILES_MESSAGE
See Also:
Constant Field Values
Constructor Detail

LoginScreen

public LoginScreen(java.lang.String screenTitle)
Constructor to create a login screen

Parameters:
screenTitle - String value for the screen title

LoginScreen

public LoginScreen(int screenTitleRID)
Constructor to create a login screen

Parameters:
screenTitleRID - int value for the screen title resource id

LoginScreen

public LoginScreen(java.lang.String screenTitle,
                   boolean isScreenSaver)
Constructor to create a login screen

Parameters:
screenTitle - String value for the screen title
isScreenSaver - true if this is called by the screen saver, otherwise false

LoginScreen

public LoginScreen(int screenTitleRID,
                   boolean isScreenSaver)
Constructor to create a login screen

Parameters:
screenTitleRID - int value for the screen title resource id
isScreenSaver - true if this is called by the screen saver, otherwise false
Method Detail

defineScreen

protected void defineScreen()
(non-Javadoc)

Overrides:
defineScreen in class BaseBOBStockScreen
See Also:
BaseBOBScreen.defineScreen()

getScreenFontStyle

public FontStyle getScreenFontStyle()
Get this screen's font style

Returns:
FontStyle font style object
See Also:
FontStyle

setScreenFontStyle

public void setScreenFontStyle(FontStyle fontStyle)
Set the font style for this screen

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

getButtonUnfocusFontStyle

public FontStyle getButtonUnfocusFontStyle()
Get the button unfocus font style

Returns:
FontStyle font style object
See Also:
FontStyle

setButtonUnfocusFontStyle

public void setButtonUnfocusFontStyle(FontStyle fontStyle)
Set the button unfocus font style for this control

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

getButtonFocusFontStyle

public FontStyle getButtonFocusFontStyle()
Get the button focus font style

Returns:
FontStyle font style object
See Also:
FontStyle

setButtonFocusFontStyle

public void setButtonFocusFontStyle(FontStyle fontStyle)
Set the button focus font style for this control

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

setBannerImage

public void setBannerImage(java.lang.String imageName)
Set the banner of the login screen by image name

Parameters:
imageName - String value for the image file name

setBannerImage

public void setBannerImage(net.rim.device.api.system.EncodedImage banner)
Set the banner of the login screen

Parameters:
banner - EncodedImage object for the banner
See Also:
EncodedImage

setLoginInputLabel

public void setLoginInputLabel(java.lang.String label)
Set the login input label

Parameters:
label - String value for the new label

setPasswordInputLabel

public void setPasswordInputLabel(java.lang.String label)
Set the password input label

Parameters:
label - String value for the new label

setMenuLoginLabel

public void setMenuLoginLabel(java.lang.String label)
Set menu login label for login

Parameters:
label - String value for the new label

setMenuCancelLabel

public void setMenuCancelLabel(java.lang.String label)
Set menu exit label for exit

Parameters:
label - String value for the new label

setButtonLoginLabel

public void setButtonLoginLabel(java.lang.String label)
Set button login label

Parameters:
label - String value for the new label

setButtonExitLabel

public void setButtonExitLabel(java.lang.String label)
Set button exit label

Parameters:
label - String value for the new label

setShowLogo

public void setShowLogo(boolean bol)
Hide or show the banner logo


setShowButtons

public void setShowButtons(boolean bol)
Show or hide login and exit buttons


setLoginPromptMessage

public void setLoginPromptMessage(java.lang.String str)
Set the login prompt message

Parameters:
str - String value for the message

setPasswordPromptMessage

public void setPasswordPromptMessage(java.lang.String str)
Set the password prompt message

Parameters:
str - String value for the message

setWaitAuthenticateMessage

public void setWaitAuthenticateMessage(java.lang.String str)
Set the wait authenticate message

Parameters:
str - String value for the message

setErrorAuthenticateMessage

public void setErrorAuthenticateMessage(java.lang.String str)
Set the error authenticate message

Parameters:
str - String value for the message

setErrorLoadingProfileMsg

public void setErrorLoadingProfileMsg(java.lang.String msg)
Set the error loading profile message string

Parameters:
msg - String value for the new message

setFailedLoginAlertMessage

public void setFailedLoginAlertMessage(java.lang.String msg)
Set the failed login alert message string

Parameters:
msg - String value for the new message

buttonClicked

public void buttonClicked(net.rim.device.api.ui.Field buttonField)
Overridden to perform actions when buttons are clicked on

Parameters:
buttonField - Field object for the the button

setOnSuccess

public void setOnSuccess(IBOBAction action)
Set the on success action

Parameters:
action - IBOBAction action object
See Also:
IBOBAction

getOnSuccessAction

public IBOBAction getOnSuccessAction()
Get the on success action

Returns:
IBOBAction action object
See Also:
IBOBAction

callOnSuccessAction

public void callOnSuccessAction(boolean isLoginToSyncRequired)
call the on success action

Parameters:
isLoginToSyncRequired - true if login to sync is required, otherwise false

getFailedLoginAlertMessageAction

public IBOBAction getFailedLoginAlertMessageAction(java.lang.String errorMessage)
Get the failed login alert message action

Parameters:
errorMessage - String value for the error message to be appended to invalid login message
Returns:
IBOBAction action object
See Also:
IBOBAction

setOnFail

public void setOnFail(IBOBAction action)
Set on fail action

Parameters:
action - IBOBAction action object

getOnFailAction

public IBOBAction getOnFailAction()
Get on fail action

Returns:
IBOBAction action object
See Also:
IBOBAction

callOnFailAction

public void callOnFailAction()
Call on fail action


setProperty

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

Overrides:
setProperty in class BaseBOBStockScreen
Parameters:
key - int value for a screen attribute
value - Object value for the attribute value
See Also:
ScreenProperties

refresh

public void refresh()
(non-Javadoc)

Specified by:
refresh in interface IBOBScreen
Overrides:
refresh in class BaseBOBScreen
See Also:
BaseBOBScreen.refresh()

onSavePrompt

protected boolean onSavePrompt()
This is called when the user click the escape We will then want to ask if the user want to save the form

Overrides:
onSavePrompt in class net.rim.device.api.ui.container.MainScreen
Returns:
true if prompt's resulting choice is to save; false if the prompt's resulting choice is to cancel

setIsScreenSaver

public void setIsScreenSaver(boolean isScreenSaver)
Set isScreenSaver flag.

Parameters:
isScreenSaver - true to set screen save, otherwise false