com.softwareag.mobile.runtime.toolkit

Class AbstractApplicationController

java.lang.Object

com.softwareag.mobile.runtime.toolkit.AbstractApplicationController

All Implemented Interfaces:

com.softwareag.mobile.core.IMDApplicationListener, com.softwareag.mobile.runtime.pn.IPushNotificationListener, IDialogDelegate, IResourceController, IPaneConfigDelegate

public abstract class AbstractApplicationController
extends java.lang.Object
implements IResourceController, IPaneConfigDelegate, IDialogDelegate, com.softwareag.mobile.runtime.pn.IPushNotificationListener, com.softwareag.mobile.core.IMDApplicationListener

The AbstractApplicationController manages the inner life cycle of the application and is responsible for resource loading, pane configurations and transitions. The singleton instance can be accessed by getInstance() method. The AbstractApplicationController contains a lot of important methods which allow you to perform following operations:

• transition to a pane in the main window(see setView(nUIViewDisplay, int, int) and setViewController(AbstractViewController, int, int))
• change pane configuration (see changePaneConfiguration(nUIObject, PaneConfiguration, IPaneConfigDelegate, Hashtable))
• manage particular pane(see showPane(int), hidePane(int) and isPaneVisible(int))
• open/close dialog window(see openDialog(AbstractAlertDialog) and closeDialog())
• open/close progress dialog window(see openProgressWindow() and closeProgressWindow())
• manage resources(see loadImage(String, int, int) and loadWWWResource(nUIObject, String, String, String))

Code snippet to change pane configuration:

 final AbstractApplicationController controller = AbstractApplicationController.getInstance();
 controller.changePangeConfiguration(null, myPaneConfiguration, controller new Hashtable());
 

It's also possible to set a new view controller without the TransitionStackController, for that use

 final AbstractViewController avc = ...;
 final int transitionStyle = nUIController.TRANSITION_FADE;
 final int paneId = 0;
 final AbstractApplicationController controller = AbstractApplicationController.getInstance();
 controller.setViewController(avc, transitionStyle, paneId);
 

Version:

10.3.0.0002-0443

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSITION_STYLE_NOT_DEFINED

Constructor Summary

Constructors

Constructor and Description
AbstractApplicationController()

Method Summary

Modifier and Type	Method and Description
boolean	allowUnsecureSSLConnectionForURL(java.lang.String url)
void	changePaneConfiguration(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, IPaneConfigDelegate delegate, java.util.Hashtable viewControllers) Changes pane configuration of the application.
void	closeDialog() Closes the current opened dialog.
void	closeProgressWindow() Closes the current progress window.
com.softwareag.mobile.runtime.nui.nUINavbuttonElement	createNavButton(int nuiid, java.lang.String text, javax.microedition.lcdui.Image icon) Creates a new instance of nUINavButtonElement.
com.softwareag.mobile.runtime.nui.nUINavbuttonElement	createNavButton(int nuiid, java.lang.String text, int type, javax.microedition.lcdui.Image icon) Creates a new instance of nUINavButtonElement.
com.softwareag.mobile.runtime.nui.nUISearchNavButton	createSearchNavButton(int nuiid, java.lang.String text, javax.microedition.lcdui.Image icon) Creates a new instance of nUISearchNavButton.
boolean	createTransitionStackController(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, PaneDefinition pane, AbstractViewController assignedAVC) Override this method to disable the automatically creation of a TransitionStackController.
boolean	expandPaneToFullScreen(int paneId) Expands the delivered pane to full screen and hides all other panes.
java.util.Hashtable	getActiveViewAndControllerFromType(java.lang.String viewClassName) Tries to find all nUIViewDisplay's which class names matches the delivered String and returns a Hashtable containing the view as key and the correspondent controller as value.
PaneConfiguration	getCurrentPaneConfig() Returns the current used PaneConfiguration.
javax.microedition.lcdui.Image	getDefaultPlaceHolderImage() Return the default place holder image that will be used if requested image was not found.
static AbstractApplicationController	getInstance()
com.softwareag.mobile.runtime.nui.nUIWindowDisplay	getMainWindow() Creates the main window if it does not exist and configures the window with the start PaneConfiguration.
OperationHandler	getOperationHandler() Returns the OperationHandler for this application.
PaneDefinition	getPaneDefinition(int paneId) Returns the PaneDefinition which is correspondent to the delivered pane id.
java.util.Hashtable	getPaneToViewControllerMap() By transition to a view, information about it's controller and target pane is storing in this class.
com.softwareag.mobile.runtime.nui.nUIWindowDisplay	getProgressWindow() Returns the overlay window used to display progress indicators and making sure the user can not interact with the main window.
SideViewControllerImpl	getSideViewController() Returns the SideViewController for this application.
abstract PaneConfiguration	getStartPaneConiguration()
int	getTransitionFromStyle(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, int pane) Use this method to change transition effect by transition from the given pane.
int	getTransitionToStyle(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, int pane) Use this method to change transition effect by transition to the given pane.
com.softwareag.mobile.runtime.nui.nUIViewDisplay	getView(int pane)
AbstractViewController	getViewController(int pane)
AbstractViewController	getViewController(com.softwareag.mobile.runtime.nui.nUIViewDisplay view)
boolean	hidePane(int paneId) Hides the delivered pane if it exists.
boolean	isPaneVisible(int paneId) Returns a boolean indicating if the delivered pane is existing and visible.
javax.microedition.lcdui.Image	loadImage(java.lang.String name) Loads an icon asset specified by it's name.
javax.microedition.lcdui.Image	loadImage(java.lang.String name, int viewBackGroundcolor) Deprecated. Please use the new asset management.
javax.microedition.lcdui.Image	loadImage(java.lang.String name, int viewBackgroundColor, int containerWidth) Deprecated. Please use the new asset management.
java.lang.String	loadWWWResource(com.softwareag.mobile.runtime.nui.nUIObject target, java.lang.String fileName, java.lang.String prefix, java.lang.String encoding) Deprecated. use loadWWWResource(String) or loadWWWResource(String, String) Might be removed with the next release.
java.lang.String	loadWWWResource(java.lang.String fileName) Loads a resource from the default folder (resources/www) with the default encoding (UTF-8) and returns the content of the given resource as String.
java.lang.String	loadWWWResource(java.lang.String fileName, java.lang.String encoding) Loads a resource from the default folder (resources/www) with the given encoding and returns the content of the given resource as String.
void	onAppDestroyed()
void	onAppDirectionalityChanged(int direction)
void	onAppPaused()
void	onAppResumed()
void	onAppStarted()
AbstractViewController	onAssignView(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, PaneDefinition pane, AbstractViewController avcToAssign) This callback can be used to change a view controller that will be used to create a view for the given pane.
void	onCreateWindow(com.softwareag.mobile.runtime.nui.nUIWindowDisplay window) Delegate method to notify that the main window is created.
void	onDeviceRegistered(java.lang.String newPushUID) Will be called after the device is successfully registered to the platform's push notification service.
void	onDeviceRegistrationError(java.lang.String error) Will be called if a registration for a device token, used to receive push notifications, could not be completed successfully.
void	onDialogButtonPressed(AbstractDialog dialog, int buttonId) This method will be called if a event occurs in given AbstractDialog.
void	onMessage(com.softwareag.mobile.runtime.pn.PushNotification notification) Will be called once a push notification is received and the app is running or is in the background.
void	onOrientationChange() Will be called after the user decides to change the device orientation.
void	onPushNotification(java.lang.String message, java.util.Hashtable extraParams) Deprecated. Please implement onMessage(PushNotification). Older implementations may stay with this method, as onMessage(PushNotification) delegates to it.
void	onPushNotificationError(java.lang.String errorMessage) Will be called when a push notification results in an error.
void	onSetupPaneDimension(com.softwareag.mobile.runtime.nui.nUIObject sender, PaneConfiguration pc, PaneDefinition pane) This callback will be called after dimensions for the current pane are calculated.
void	onSizeChanged(int width, int height)
void	onStartAppFromFile(java.lang.String mimeType, java.lang.String absolutePath) Will be called when the application is started by passing a file into the application.
void	onStartAppFromPushNotification(com.softwareag.mobile.runtime.pn.PushNotification notification) This method will be called if the app receives a push notification, but is not running in the background.
void	onStartAppFromURL(java.lang.String scheme, java.lang.String url) Will be called when the application is started from an URI scheme it is registered for.
void	onViewCreated(com.softwareag.mobile.runtime.nui.nUIViewDisplay view, AbstractViewController avc) Each view controller calls this method immediately after it has created a new view.
void	onViewRemoved(com.softwareag.mobile.runtime.nui.nUIViewDisplay view) If view was reset or a new view was created, the related view controller calls this method.
void	openDialog(AbstractAlertDialog dialog) Shows the delivered dialog of no one is actually shown.
void	openProgressWindow() Opens the default progress window if no progress window is currently shown.
void	openProgressWindow(com.softwareag.mobile.runtime.nui.nUIViewDisplay view) Opens the delivered view as a progress window if no progress window is currently shown.
javax.microedition.lcdui.Image	resizeImage(javax.microedition.lcdui.Image image, int width, int height) Resize the given image.
boolean	runningOnAndroid() Returns a boolean value indicating if we are currently running on an Android device.
boolean	runningOnIOS() Returns a boolean value indicating if we are currently running on an iOS device.
boolean	runningOnWin8() Returns a boolean value indicating if we are currently running on an Windows 8 device.
boolean	runningOnWinPhone() Returns a boolean value indicating if we are currently running on an Windows Phone device.
void	setDefaultPlaceHolderImage(javax.microedition.lcdui.Image defaultImage) Sets the default Image used as placeholder.
void	setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView) Sets the delivered nUIViewDisplay by using nUIController.TRANSITION_APPEAR as transition style.
void	setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView, int transition) Sets the delivered nUIViewDisplay and uses 0 as pane id.
void	setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView, int transition, int pane) Initializes the transition to the delivered nUIViewDisplay.
void	setViewController(AbstractViewController controller) Sets the new AbstractViewController by using nUIController.TRANSITION_APPEAR as transition style.
void	setViewController(AbstractViewController controller, int transition) Sets the new AbstractViewController.
void	setViewController(AbstractViewController controller, int transition, int pane) Sets the new AbstractViewController and assigns the pane to the delivered controller.
boolean	showDialogButton(AbstractDialog dialog, int buttonId) This method is called for each button.
boolean	showPane(int paneId) Displays the delivered pane if it is existing.
void	updatePaneDimensions() Updates the dimension for all panes.

Methods inherited from class java.lang.Object

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

Field Detail

TRANSITION_STYLE_NOT_DEFINED

public static final int TRANSITION_STYLE_NOT_DEFINED

See Also:

Constant Field Values

Constructor Detail

AbstractApplicationController

public AbstractApplicationController()

Method Detail

getInstance

public static AbstractApplicationController getInstance()

getSideViewController

public SideViewControllerImpl getSideViewController()

Returns the SideViewController for this application.

It is a singleton and only created, if this method is called. Clients need to overwrite createSideViewController() to pass a custom instance.

Returns:

getOperationHandler

public OperationHandler getOperationHandler()

Returns the OperationHandler for this application.

It is a singleton and only created, if this method is called. Clients need to overwrite createOperationHandler() to pass a custom instance.

Returns:

onDialogButtonPressed

public void onDialogButtonPressed(AbstractDialog dialog,
                                  int buttonId)

Description copied from interface: IDialogDelegate

This method will be called if a event occurs in given AbstractDialog.

Specified by:

onDialogButtonPressed in interface IDialogDelegate

Parameters:

dialog - The AbstractDialog containing the button.

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

showDialogButton

public boolean showDialogButton(AbstractDialog dialog,
                                int buttonId)

Description copied from interface: IDialogDelegate

This method is called for each button. Depending on the return value the button will be shown or hidden.

Specified by:

showDialogButton in interface IDialogDelegate

Parameters:

dialog - The AbstractDialog containing the button.

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

Returns:

true if the button should be shown; false otherwise

getPaneToViewControllerMap

public java.util.Hashtable getPaneToViewControllerMap()

By transition to a view, information about it's controller and target pane is storing in this class. This information can be requested by this method.

Returns all active controllers.

Returns:

Hashtable with pane id as key and AbstractViewController as value.

getCurrentPaneConfig

public PaneConfiguration getCurrentPaneConfig()

Returns the current used PaneConfiguration.

Returns:

onViewCreated

public void onViewCreated(com.softwareag.mobile.runtime.nui.nUIViewDisplay view,
                          AbstractViewController avc)

Each view controller calls this method immediately after it has created a new view. The relationship between view and its view controller is stored by this class.

Parameters:

view - just created view

avc - AbstractViewController, which created the view.

onViewRemoved

public void onViewRemoved(com.softwareag.mobile.runtime.nui.nUIViewDisplay view)

If view was reset or a new view was created, the related view controller calls this method.

Parameters:

view - obsolete view

getViewController

public AbstractViewController getViewController(com.softwareag.mobile.runtime.nui.nUIViewDisplay view)

Parameters:

view - the given view

Returns:

AbstractViewController for the given view if it exists or null if the view was created not with a controller.

getViewController

public AbstractViewController getViewController(int pane)

Parameters:

pane - pane id

Returns:

AbstractViewController for the given pane or null if there is no view created by a controller was assigned to the given pane

getView

public com.softwareag.mobile.runtime.nui.nUIViewDisplay getView(int pane)

Parameters:

pane - pane id

Returns:

nUIViewDisplay assigned to the given pane or null.

getStartPaneConiguration

public abstract PaneConfiguration getStartPaneConiguration()

Returns:

initial pane configuration defined in the model.

getMainWindow

public com.softwareag.mobile.runtime.nui.nUIWindowDisplay getMainWindow()

Creates the main window if it does not exist and configures the window with the start PaneConfiguration. Clients should override createMainWindow() or onCreateWindow(nUIWindowDisplay) to adapt the window to their needs.

Returns:

the main window of the application.

See Also:

getStartPaneConiguration(), changePaneConfiguration(nUIObject, PaneConfiguration, IPaneConfigDelegate, Hashtable)

getProgressWindow

public com.softwareag.mobile.runtime.nui.nUIWindowDisplay getProgressWindow()

Returns the overlay window used to display progress indicators and making sure the user can not interact with the main window.

Returns:

the currently used progress nUIViewDisplay

See Also:

openProgressWindow(), openProgressWindow(nUIViewDisplay), closeProgressWindow()

changePaneConfiguration

public void changePaneConfiguration(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                    PaneConfiguration pc,
                                    IPaneConfigDelegate delegate,
                                    java.util.Hashtable viewControllers)

Changes pane configuration of the application.

Parameters:

sender - This parameter is optional. The native UI object that caused the call

pc - a new pane configuration

delegate - This parameter is optional. Use this delegate to change default behavior.

viewControllers - This parameter is optional. Pass a Hashtable with controllers to alternate settings in the model. Expected keys are pane ids, values - abstract view controllers.

setViewController

public void setViewController(AbstractViewController controller)

Sets the new AbstractViewController by using nUIController.TRANSITION_APPEAR as transition style. Delegates to setViewController(AbstractViewController, int).

Parameters:

controller -

See Also:

setViewController(AbstractViewController, int)

setViewController

public void setViewController(AbstractViewController controller,
                              int transition)

Sets the new AbstractViewController. Delegates to setViewController(AbstractViewController, int, int). Uses as AbstractViewController.getWindowPane() as pane id.

Parameters:

controller -

transition -

See Also:

setViewController(AbstractViewController, int, int)

setViewController

public void setViewController(AbstractViewController controller,
                              int transition,
                              int pane)

Sets the new AbstractViewController and assigns the pane to the delivered controller. Delegates to setView(nUIViewDisplay, int, int) to do the transition.

Parameters:

controller -

transition -

pane -

See Also:

setView(nUIViewDisplay, int, int)

setView

public void setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView)

Sets the delivered nUIViewDisplay by using nUIController.TRANSITION_APPEAR as transition style. Delegates to setView(nUIViewDisplay, int).

Parameters:

requestedView -

See Also:

setView(nUIViewDisplay, int)

setView

public void setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView,
                    int transition)

Sets the delivered nUIViewDisplay and uses 0 as pane id. Delegates to setView(nUIViewDisplay, int, int).

Parameters:

requestedView -

transition -

See Also:

setView(nUIViewDisplay, int, int)

setView

public void setView(com.softwareag.mobile.runtime.nui.nUIViewDisplay requestedView,
                    int transition,
                    int pane)

Initializes the transition to the delivered nUIViewDisplay. Calls AbstractViewController.onTransitionFrom() and AbstractViewController.onTransitionTo() as delegates. Uses getViewController(nUIViewDisplay) to fetch the views controller.

If not set, the default transition style is nUIController.TRANSITION_APPEAR.
Calls nUIWindowDisplay.transitionFrom(nUIViewDisplay) and nUIWindowDisplay.transitionTo(nUIViewDisplay) under the hood.
For Android devices, checks if the views header must be added.

After performing the transition, we'll iterate about all panes to check if a SideView should be displayed or not.

Parameters:

requestedView -

transition -

pane -

expandPaneToFullScreen

public boolean expandPaneToFullScreen(int paneId)

Expands the delivered pane to full screen and hides all other panes. This method has no effect if the delivered pane is not visible.
Returns a boolean value indicating if the delivered pane is visible or not.

Parameters:

paneId -

Returns:

isPaneVisible

public boolean isPaneVisible(int paneId)

Returns a boolean indicating if the delivered pane is existing and visible.

Parameters:

paneId -

Returns:

showPane

public boolean showPane(int paneId)

Displays the delivered pane if it is existing.
Returns true, if the pane exists and is not already visible.

Parameters:

paneId -

Returns:

See Also:

updatePaneDimensions()

hidePane

public boolean hidePane(int paneId)

Hides the delivered pane if it exists.
Returns true if the pane exists and is not already hidden.

Parameters:

paneId -

Returns:

See Also:

updatePaneDimensions()

getPaneDefinition

public PaneDefinition getPaneDefinition(int paneId)

Returns the PaneDefinition which is correspondent to the delivered pane id.

Parameters:

paneId -

Returns:

updatePaneDimensions

public void updatePaneDimensions()

Updates the dimension for all panes.

onOrientationChange

public void onOrientationChange()

Will be called after the user decides to change the device orientation. Updates all panes dimension.

onPushNotification

public void onPushNotification(java.lang.String message,
                               java.util.Hashtable extraParams)

Deprecated. Please implement onMessage(PushNotification). Older implementations may stay with this method, as onMessage(PushNotification) delegates to it.

Will be called when a push notification is received by the application.

This delegate will only be called if you enabled push notifications for your application.

Parameters:

message -

extraParams -

onPushNotificationError

public void onPushNotificationError(java.lang.String errorMessage)

Will be called when a push notification results in an error.

This delegate will only be called if you enabled push notifications for your application.

Parameters:

errorMessage -

onDeviceRegistered

public void onDeviceRegistered(java.lang.String newPushUID)

Will be called after the device is successfully registered to the platform's push notification service. This method is only called once after the uid becomes visible.

Depending on the platform, the newPushUID represents the following id:

• Android: the registrationId
• iOS: the pushTokenHex
• Windows: the mpns_uri

Overwrite this method to do a further registration, e.g. to register the newPushUID to Mobile Administrator.

This delegate will only be called if you enabled push notifications for your application.

Specified by:

onDeviceRegistered in interface com.softwareag.mobile.runtime.pn.IPushNotificationListener

Parameters:

newPushUID -

onDeviceRegistrationError

public void onDeviceRegistrationError(java.lang.String error)

Will be called if a registration for a device token, used to receive push notifications, could not be completed successfully.

Specified by:

onDeviceRegistrationError in interface com.softwareag.mobile.runtime.pn.IPushNotificationListener

Parameters:

error -

onMessage

public void onMessage(com.softwareag.mobile.runtime.pn.PushNotification notification)

Will be called once a push notification is received and the app is running or is in the background. If the app is closed, onStartAppFromPushNotification(PushNotification) will be called.

Delegates to onPushNotification(String, Hashtable) to support projects built with an older version.

This delegate will only be called if you enabled push notifications for your application.

Specified by:

onMessage in interface com.softwareag.mobile.runtime.pn.IPushNotificationListener

Parameters:

notification -

onStartAppFromFile

public void onStartAppFromFile(java.lang.String mimeType,
                               java.lang.String absolutePath)

Will be called when the application is started by passing a file into the application. The mime-type is provided as well as the absolute path to read the file from.

Specified by:

onStartAppFromFile in interface com.softwareag.mobile.core.IMDApplicationListener

Parameters:

mimeType - the mime type of the file

absolutePath - the absolute path to the file

onStartAppFromURL

public void onStartAppFromURL(java.lang.String scheme,
                              java.lang.String url)

Will be called when the application is started from an URI scheme it is registered for.

Specified by:

onStartAppFromURL in interface com.softwareag.mobile.core.IMDApplicationListener

Parameters:

scheme - the custom URI scheme the application is using

url - the complete URL the application was started with

onStartAppFromPushNotification

public void onStartAppFromPushNotification(com.softwareag.mobile.runtime.pn.PushNotification notification)

This method will be called if the app receives a push notification, but is not running in the background.

As a counterpart, onMessage(PushNotification) will be called if the app receives a push notification and is running or in the background.

This delegate will only be called if you enabled push notifications for your application.

Specified by:

onStartAppFromPushNotification in interface com.softwareag.mobile.core.IMDApplicationListener

Parameters:

notification -

onCreateWindow

public void onCreateWindow(com.softwareag.mobile.runtime.nui.nUIWindowDisplay window)

Delegate method to notify that the main window is created.
Clients should override this method if they wish to adapt the window.

Parameters:

window -

openDialog

public void openDialog(AbstractAlertDialog dialog)

Shows the delivered dialog of no one is actually shown.
Calls nUIController.transitionTo(nUIWindowDisplay).

Parameters:

dialog -

See Also:

nUIController.transitionTo(nUIWindowDisplay)

closeDialog

public void closeDialog()

Closes the current opened dialog.
Delegates to nUIController.transitionFrom(nUIWindowDisplay).

See Also:

nUIController.transitionFrom(nUIWindowDisplay)

openProgressWindow

public void openProgressWindow(com.softwareag.mobile.runtime.nui.nUIViewDisplay view)

Opens the delivered view as a progress window if no progress window is currently shown.
It creates a new nUIWindowDisplay and assigns the delivered view to it. Uses -1 as NUIID for the created window. Also calls AbstractViewController.onTransitionTo() if the view has a registered controller.

Parameters:

view -

See Also:

getViewController(nUIViewDisplay), nUIController.transitionTo(nUIWindowDisplay)

openProgressWindow

public void openProgressWindow()

Opens the default progress window if no progress window is currently shown.
The default progress window consists of a single transparent nUIViewDisplay with a nUIProgressanimElement assigned.
Uses -1 as NUIID for all created elements.

See Also:

nUIController.transitionTo(nUIWindowDisplay)

closeProgressWindow

public void closeProgressWindow()

Closes the current progress window.
If the progress window consists of custom nUIViewDisplay, tries to find the correspondent AbstractViewController and calls AbstractViewController.onTransitionFrom() and AbstractViewController.resetView() if the controller exists.

See Also:

AbstractViewController.onTransitionTo(), AbstractViewController.resetView(), nUIController.transitionFrom(nUIWindowDisplay)

getActiveViewAndControllerFromType

public java.util.Hashtable getActiveViewAndControllerFromType(java.lang.String viewClassName)

Tries to find all nUIViewDisplay's which class names matches the delivered String and returns a Hashtable containing the view as key and the correspondent controller as value.

Parameters:

viewClassName -

Returns:

onAssignView

public AbstractViewController onAssignView(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                           PaneConfiguration pc,
                                           PaneDefinition pane,
                                           AbstractViewController avcToAssign)

Description copied from interface: IPaneConfigDelegate

This callback can be used to change a view controller that will be used to create a view for the given pane. By default, the PaneDefinition#getStartView() controller will be applied.

Specified by:

onAssignView in interface IPaneConfigDelegate

Parameters:

sender - object that caused the PaneConfiguration changing.

pc - a PaneConfiguration, which is being activated.

pane - current PaneDefinition. (The most important information for this callback is paneId).

avcToAssign - AbstractViewController, that will be used to create a view for current pane.

Returns:

any concrete view controller, e.g. new MasterViewControllerImpl()

onSetupPaneDimension

public void onSetupPaneDimension(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                 PaneConfiguration pc,
                                 PaneDefinition pane)

Description copied from interface: IPaneConfigDelegate

This callback will be called after dimensions for the current pane are calculated. You can adjust the size of the pane by using AbstractPane.getPaneRect() method. However it can cause pane overlapping.

Specified by:

onSetupPaneDimension in interface IPaneConfigDelegate

createTransitionStackController

public boolean createTransitionStackController(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                               PaneConfiguration pc,
                                               PaneDefinition pane,
                                               AbstractViewController assignedAVC)

Description copied from interface: IPaneConfigDelegate

Override this method to disable the automatically creation of a TransitionStackController.

Specified by:

createTransitionStackController in interface IPaneConfigDelegate

assignedAVC - view controller that was assigned for this pane.

Returns:

true if you want to create TransitionStackController for this pane and false otherwise.

getTransitionFromStyle

public int getTransitionFromStyle(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                  PaneConfiguration pc,
                                  int pane)

Description copied from interface: IPaneConfigDelegate

Use this method to change transition effect by transition from the given pane.

Specified by:

getTransitionFromStyle in interface IPaneConfigDelegate

Returns:

any constant from nUIController#TRANSITION_*

getTransitionToStyle

public int getTransitionToStyle(com.softwareag.mobile.runtime.nui.nUIObject sender,
                                PaneConfiguration pc,
                                int pane)

Description copied from interface: IPaneConfigDelegate

Use this method to change transition effect by transition to the given pane.

Specified by:

getTransitionToStyle in interface IPaneConfigDelegate

Returns:

any constant from nUIController#TRANSITION_*

loadWWWResource

public java.lang.String loadWWWResource(java.lang.String fileName)
                                 throws FileNotFoundException,
                                        java.io.UnsupportedEncodingException

Loads a resource from the default folder (resources/www) with the default encoding (UTF-8) and returns the content of the given resource as String.

Parameters:

fileName - the file to load. Must not contain any subfolders!

Returns:

the content of the given file as UTF-8 encoded String; might by empty, but not null

Throws:

FileNotFoundException - if the resource can not be found

java.io.UnsupportedEncodingException - if the given encoding does not exist/work

loadWWWResource

public java.lang.String loadWWWResource(java.lang.String fileName,
                                        java.lang.String encoding)
                                 throws FileNotFoundException,
                                        java.io.UnsupportedEncodingException

Loads a resource from the default folder (resources/www) with the given encoding and returns the content of the given resource as String.

Parameters:

fileName - the file to load. Must not contain any subfolders!

encoding - the encoding that should be used to read the content.

Returns:

the content of the given file as encoded String; might by empty, but not null

Throws:

FileNotFoundException - if the resource can not be found

java.io.UnsupportedEncodingException - if the given encoding does not exist/work

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)

Deprecated. use loadWWWResource(String) or loadWWWResource(String, String) Might be removed with the next release.

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.

Returns:

the 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

setDefaultPlaceHolderImage

public void setDefaultPlaceHolderImage(javax.microedition.lcdui.Image defaultImage)

Sets the default Image used as placeholder.

Parameters:

defaultImage -

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

loadImage

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

Description copied from interface: IResourceController

Loads an icon asset specified by it's name.

There are two types of icon assets:

• .asset - following the platforms asset catalog definition.
• .png - mainly to support projects created before 10.1.

The loading of .asset icons depend on the target platform. Please see AssetImageLoader for more details.

To load .png assets, this method uses a search path according to:

• platform specific folders. E.g. "drawable-mdpi/" on Android or "Non-Retina/" on iOS. You can change the platform folders by overriding one of the following methods:
  • AbstractApplicationController#getAndroidGraphicsFolder(int, int)
  • AbstractApplicationController#getIOSGraphicsFolders(int, int)
  • AbstractApplicationController#getWinPhoneGraphicFolder(int, int, int) see also AbstractApplicationController#getWinPhoneThemeFolder(int)

  A default placeholder, configurable by overwriting #defaultPlaceHolderImage, will be returned if the asset could not be found.

Specified by:

loadImage in interface IResourceController

Parameters:

name - filename to load

Returns:

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

loadImage

public javax.microedition.lcdui.Image loadImage(java.lang.String name,
                                                int viewBackGroundcolor)

Deprecated. Please use the new asset management.

Kept to support the legacy .png support.

loadImage

public javax.microedition.lcdui.Image loadImage(java.lang.String name,
                                                int viewBackgroundColor,
                                                int containerWidth)

Deprecated. Please use the new asset management.

Kept to support the legacy .png support.

runningOnAndroid

public boolean runningOnAndroid()

Returns a boolean value indicating if we are currently running on an Android device.

Returns:

runningOnIOS

public boolean runningOnIOS()

Returns a boolean value indicating if we are currently running on an iOS device.

Returns:

runningOnWinPhone

public boolean runningOnWinPhone()

Returns a boolean value indicating if we are currently running on an Windows Phone device.

Returns:

runningOnWin8

public boolean runningOnWin8()

Returns a boolean value indicating if we are currently running on an Windows 8 device.

Returns:

createNavButton

public com.softwareag.mobile.runtime.nui.nUINavbuttonElement createNavButton(int nuiid,
                                                                             java.lang.String text,
                                                                             javax.microedition.lcdui.Image icon)

Creates a new instance of nUINavButtonElement. Overwriting this methods enable users to inject a custom implementation.

Delegates to createNavButton(int, String, int, Image) and uses nUINavbuttonElement.TYPE_DEFAULT as type.

Parameters:

nuiid -

text -

icon -

Returns:

createSearchNavButton

public com.softwareag.mobile.runtime.nui.nUISearchNavButton createSearchNavButton(int nuiid,
                                                                                  java.lang.String text,
                                                                                  javax.microedition.lcdui.Image icon)

Creates a new instance of nUISearchNavButton. Overwriting this methods enable users to inject a custom implementation.

createNavButton

public com.softwareag.mobile.runtime.nui.nUINavbuttonElement createNavButton(int nuiid,
                                                                             java.lang.String text,
                                                                             int type,
                                                                             javax.microedition.lcdui.Image icon)

Creates a new instance of nUINavButtonElement. Overwriting this methods enable users to inject a custom implementation.

Parameters:

nuiid -

text -

type -

icon -

Returns:

onAppStarted

public void onAppStarted()

Specified by:

onAppStarted in interface com.softwareag.mobile.core.IMDApplicationListener

onAppPaused

public void onAppPaused()

Specified by:

onAppPaused in interface com.softwareag.mobile.core.IMDApplicationListener

onAppResumed

public void onAppResumed()

Specified by:

onAppResumed in interface com.softwareag.mobile.core.IMDApplicationListener

onAppDestroyed

public void onAppDestroyed()

Specified by:

onAppDestroyed in interface com.softwareag.mobile.core.IMDApplicationListener

onSizeChanged

public void onSizeChanged(int width,
                          int height)

Specified by:

onSizeChanged in interface com.softwareag.mobile.core.IMDApplicationListener

onAppDirectionalityChanged

public void onAppDirectionalityChanged(int direction)

Specified by:

onAppDirectionalityChanged in interface com.softwareag.mobile.core.IMDApplicationListener

allowUnsecureSSLConnectionForURL

public boolean allowUnsecureSSLConnectionForURL(java.lang.String url)