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

Interface IController

All Known Subinterfaces:

IViewController

All Known Implementing Classes:

AbstractListViewController, AbstractListViewTemplate, AbstractViewController, TransitionStackController

public interface IController

This interface provides methods for performing navigation to another view as well as interacting with the TransitionStackController.

Version:

10.3.0.0002-0443

Method Summary

Modifier and Type	Method and Description
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.
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 eventType, AbstractViewController controller, int transition, int pane) Navigates to the view created by controller.

Method Detail

transition

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

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.

Parameters:

sender - The nUIObject which triggers the event.

eventType - The type of the event. Possible types are declared in nUIConstants.

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:

getTransitionStackController(), getWindowPane()

stackTransition

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. 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.

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

getTransitionStackController

TransitionStackController getTransitionStackController()

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.

Returns:

The assigned TransitionStackController or null.

getWindowPane

int getWindowPane()

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.

Returns:

The pane as an Integer value.