com.softwareag.mobile.runtime.toolkit.ui.controller

Class AbstractViewController

java.lang.Object

com.softwareag.mobile.runtime.toolkit.ui.controller.AbstractViewController

All Implemented Interfaces:

IDialogDelegate, IController, IResourceController, IViewController

Direct Known Subclasses:

TransitionStackController

public abstract class AbstractViewController
extends java.lang.Object
implements IViewController, IResourceController, IDialogDelegate

This is an abstract base class for view controllers which provides default implementation for common methods of following interfaces:

• IViewController
• IResourceController
• IDialogDelegate

Version:

9.6.0.0000-0237

Constructor Summary

Constructors

Constructor and Description
AbstractViewController()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBackButtonText()
javax.microedition.lcdui.Image	getDefaultPlaceHolderImage() Return the default place holder image that will be used if requested image was not found.
java.util.Hashtable	getMappedTransitionStackControllers() Returns all TransitionStackController, which were stored by stackTransition(nUIObject, int, AbstractViewController, int, int) method calls.
TransitionStackController	getTransitionStackController() Returns the assigned TransitionStackController or null if no TransitionStackController is used for the observed element.
int	getWindowPane() Returns the Integer representation of the pane, which displays the observed UI element.
boolean	isVisible(com.softwareag.mobile.runtime.nui.nUIObject element) Checks if the given element is visible.
javax.microedition.lcdui.Image	loadImage(java.lang.String imageName) Tries to find and load image with the given name.
javax.microedition.lcdui.Image	loadImage(java.lang.String imageName, int viewBackGroundColor) Tries to find and load image with the given name.
javax.microedition.lcdui.Image	loadImage(java.lang.String imageName, int viewBackGroundColor, int parentsWidth) Tries to find and load image with the given name.
java.lang.String	loadWWWResource(com.softwareag.mobile.runtime.nui.nUIObject target, java.lang.String fileName, java.lang.String prefix, java.lang.String encoding) Loads the given html file to the string
void	onAlertDialogButtonPressed(AbstractAlertDialog dialog, int buttonId) implement IDialogDelegate interface
void	onBackButtonEvent(com.softwareag.mobile.runtime.nui.nUINavbuttonElement backButton) This method is called when the back button is selected.
void	onHideView() This methods gets called when the view becomes hidden on a pane.
void	onShowView() This method is called when the view becomes visible on a pane.
void	onTransitionFrom() This method is called right before the view is transitioned off the screen by a TransitionStackController.
void	onTransitionTo() This method is called right after the view is created and before it is transitioned on to the screen by a TransitionStackController.
void	resetView() Removes reference to the view and destroys it.
javax.microedition.lcdui.Image	resizeImage(javax.microedition.lcdui.Image image, int width, int height) Resize the given image.
boolean	setVisible(com.softwareag.mobile.runtime.nui.nUIObject element, boolean visible) Hides or makes the given element visible in the view.
void	setWindowPane(int pane) The integer identifier of the pane will be set automatically using this method by TransitionStackController or by AbstractApplicationController.
void	stackTransition(com.softwareag.mobile.runtime.nui.nUIObject sender, int evtType, AbstractViewController controller, int transition, int pane) This method creates a new TransitionStackController(TSC) using sender as identifier if it does not already exist and navigates to the view created by the given controller into the given pane.
void	transition(com.softwareag.mobile.runtime.nui.nUIObject sender, int evtType, AbstractViewController controller, int transition, int pane) Navigates to the view created by controller.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.softwareag.mobile.runtime.toolkit.ui.controller.IViewController

addBackButton, createView, getViewDisplay, hidesBackButton

Constructor Detail

AbstractViewController

public AbstractViewController()

Method Detail

transition

public void transition(com.softwareag.mobile.runtime.nui.nUIObject sender,
              int evtType,
              AbstractViewController controller,
              int transition,
              int pane)

Description copied from interface: IController

Navigates to the view created by controller. The view with given transition effect appears on the given pane. If there is a StackTransitionController, which is associated with the pane, the controller will be pushed to it.

Specified by:

transition in interface IController

Parameters:

sender - The nUIObject which triggers the event.

controller - The controller which contains a View to push.

transition - The type of the transition. Transition types are defined in nUIController.

pane - The Integer representation of the pane to push the View on.

See Also:

IController.getTransitionStackController(), IController.getWindowPane()

stackTransition

public void stackTransition(com.softwareag.mobile.runtime.nui.nUIObject sender,
                   int evtType,
                   AbstractViewController controller,
                   int transition,
                   int pane)

Description copied from interface: IController

This method creates a new TransitionStackController(TSC) using sender as identifier if it does not already exist and navigates to the view created by the given controller into the given pane. The new created TSC will be mapped to sender and saved in the current controller. If a TransitionStackController exists, the controller will be ignored. Depending on which controller is currently associated with the target pane, methods navigates either to

• the top view of TSC, if this view is not being shown currently on the target pane
• the root view of TSC, if the top view is being shown currently on the target pane

In most cases, this method is used in applications with multiple panes configuration, whereby the current view controller besides in the pane, which is differ from the target pane. E.g. a Navbutton of Navview(NavPane) triggers transition to a view into the MaterPane.

Specified by:

stackTransition in interface IController

Parameters:

sender - object that triggered this call. Its NUIID is used as key to store/retrieve TSC.

evtType - type of the event that triggered the call.

controller - if TSC does not exist, controller is used as root controller for the TSC

transition - transition effect.

pane - target pane

getMappedTransitionStackControllers

public java.util.Hashtable getMappedTransitionStackControllers()

Returns all TransitionStackController, which were stored by stackTransition(nUIObject, int, AbstractViewController, int, int) method calls.

Returns:

Hashtable, whereby Key - NUIID, value - TransitionStackController

getTransitionStackController

public TransitionStackController getTransitionStackController()

Description copied from interface: IController

Returns the assigned TransitionStackController or null if no TransitionStackController is used for the observed element.
For Templates, this method returns the TransitionStackController assigned to the controller, which observes a given View the Template is assigned to.
For Views, this method returns the TransitionStackController assigned to the View's controller.

Specified by:

getTransitionStackController in interface IController

Returns:

The assigned TransitionStackController or null.

setWindowPane

public void setWindowPane(int pane)

Description copied from interface: IViewController

The integer identifier of the pane will be set automatically using this method by TransitionStackController or by AbstractApplicationController. This value is accessible by IController.getWindowPane()

Specified by:

setWindowPane in interface IViewController

Parameters:

pane - integer identifier of pane defined in Constants

getWindowPane

public int getWindowPane()

Description copied from interface: IController

Returns the Integer representation of the pane, which displays the observed UI element.
The Integer values for each pane will be generated in the specific Constants interface.

Specified by:

getWindowPane in interface IController

Returns:

The pane as an Integer value.

getBackButtonText

public java.lang.String getBackButtonText()

onBackButtonEvent

public void onBackButtonEvent(com.softwareag.mobile.runtime.nui.nUINavbuttonElement backButton)

Description copied from interface: IViewController

This method is called when the back button is selected. The default implementation based on AbstractViewController and TransitionStackController will just go back in the stack hierarchy by calling TransitionStackController.popViewController()-

Overwrite this method to implement custom workflow or behavior.

Specified by:

onBackButtonEvent in interface IViewController

Parameters:

backButton - the nUINavbuttonElement instance that was selected

onTransitionTo

public void onTransitionTo()

Description copied from interface: IViewController

This method is called right after the view is created and before it is transitioned on to the screen by a TransitionStackController. Overwrite to add, remove or customize controls programmatically or load data in the background. This is the entry point for all business logic that needs to be executed for a view.

Specified by:

onTransitionTo in interface IViewController

See Also:

TransitionStackController}

onTransitionFrom

public void onTransitionFrom()

Description copied from interface: IViewController

This method is called right before the view is transitioned off the screen by a TransitionStackController. Overwrite to save data or execute any logic needed right before the view will be removed.

Specified by:

onTransitionFrom in interface IViewController

See Also:

TransitionStackController}

onShowView

public void onShowView()

Description copied from interface: IViewController

This method is called when the view becomes visible on a pane. AbstractApplicationController#showPane(int) triggers this call.

Specified by:

onShowView in interface IViewController

onHideView

public void onHideView()

Description copied from interface: IViewController

This methods gets called when the view becomes hidden on a pane. AbstractApplicationController#hidePane(int) triggers this call.

Specified by:

onHideView in interface IViewController

resetView

public void resetView()

Description copied from interface: IViewController

Removes reference to the view and destroys it.

Specified by:

resetView in interface IViewController

See Also:

#createView()}

onAlertDialogButtonPressed

public void onAlertDialogButtonPressed(AbstractAlertDialog dialog,
                              int buttonId)

implement IDialogDelegate interface

Specified by:

onAlertDialogButtonPressed in interface IDialogDelegate

Parameters:

dialog - The AbstractAlertDialog containing the button.

buttonId - The id of the triggered button as modeled with the editor.

isVisible

public boolean isVisible(com.softwareag.mobile.runtime.nui.nUIObject element)

Description copied from interface: IViewController

Checks if the given element is visible.

Specified by:

isVisible in interface IViewController

Parameters:

element - the given element

setVisible

public boolean setVisible(com.softwareag.mobile.runtime.nui.nUIObject element,
                 boolean visible)

Description copied from interface: IViewController

Hides or makes the given element visible in the view.

Specified by:

setVisible in interface IViewController

Parameters:

element - target element, which belongs to the view

visible - if true makes the element visible, otherwise hides it

Returns:

true if operation was successful

loadWWWResource

public java.lang.String loadWWWResource(com.softwareag.mobile.runtime.nui.nUIObject target,
                               java.lang.String fileName,
                               java.lang.String prefix,
                               java.lang.String encoding)

Description copied from interface: IResourceController

Loads the given html file to the string

Specified by:

loadWWWResource in interface IResourceController

Parameters:

target - object that triggers the call

fileName - requested html file

prefix - relative path, where the given file is supposed to be found.

encoding - this encoding will be used by reading the html file. return content of the given file.

getDefaultPlaceHolderImage

public javax.microedition.lcdui.Image getDefaultPlaceHolderImage()

Description copied from interface: IResourceController

Return the default place holder image that will be used if requested image was not found. You can override this method to use another image.

Specified by:

getDefaultPlaceHolderImage in interface IResourceController

loadImage

public javax.microedition.lcdui.Image loadImage(java.lang.String imageName)

Description copied from interface: IResourceController

Tries to find and load image with the given name. See IResourceController.loadImage(String, int, int) for more details

Specified by:

loadImage in interface IResourceController

loadImage

public javax.microedition.lcdui.Image loadImage(java.lang.String imageName,
                                       int viewBackGroundColor)

Description copied from interface: IResourceController

Tries to find and load image with the given name. See IResourceController.loadImage(String, int, int) for more details

Specified by:

loadImage in interface IResourceController

loadImage

public javax.microedition.lcdui.Image loadImage(java.lang.String imageName,
                                       int viewBackGroundColor,
                                       int parentsWidth)

Description copied from interface: IResourceController

Tries to find and load image with the given name. If image could not be found #defaultPlaceHolderImage will be returned. Following paths are used for searching in the given ordering:

• platform specific folders. E.g. "drawable-mdpi/" on Android or "Non-Retina/" on iOS or "W360/" on BlackBerry. You can change the platform folders by overriding one of the following methods:
  • AbstractApplicationController#getAndroidGraphicsFolder(int, int)
  • AbstractApplicationController#getBlackBerryGraphicsFolder(int, int, int)
  • AbstractApplicationController#getIOSGraphicsFolders(int, int)
  • AbstractApplicationController#getWinPhoneGraphicFolder(int, int, int) see also AbstractApplicationController#getWinPhoneThemeFolder(int)
• platform specific "fallback" folder(it's just a root folder "/")
• general specific folders. E.g. "general/w200/" or "general/w400/". You can extend general folders by overriding AbstractApplicationController#getGeneralGraphicsFolder(int, int)
• general "fallback" folder: "general/"

Specified by:

loadImage in interface IResourceController

viewBackGroundColor - background color of view, where image will be shown

Returns:

an image or default image if image with the given name was not found

resizeImage

public javax.microedition.lcdui.Image resizeImage(javax.microedition.lcdui.Image image,
                                         int width,
                                         int height)

Description copied from interface: IResourceController

Resize the given image. See ImageHandler#resizeImage(Image, int, int, boolean) for more details.

Specified by:

resizeImage in interface IResourceController