com.codename1.rad.controllers

Class ViewController

java.lang.Object

com.codename1.rad.controllers.Controller

com.codename1.rad.controllers.ViewController

All Implemented Interfaces:

ActionListener<ControllerEvent>

Direct Known Subclasses:

FormController, LoginViewController

public class ViewController
extends Controller

A controller class that handles application logic for a view. In most cases a FormController will be sufficient to handle the logic for a form. Some more complex views may require their own controllers as well, in which case you might use a ViewController to handle Action dispatch on the view.

Controller Hierarchy

Controllers form a hierarchy similar to UI components. E.g. A controller has a parent controller, and events that are not consumed by the child will propagate to the parent. See FormController for a more details discussion of the Controller hierarchy.

Author:

shannah

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewController.DidSetViewEvent Event that is fired when a "view" is set in a view controller.
static class	ViewController.DidUnSetViewEvent Event that is fired when a "view" is unset from a view controller.
static interface	ViewController.ViewDecorator

Nested classes/interfaces inherited from class com.codename1.rad.controllers.Controller

Controller.CreateObjectRequest<T>, Controller.ObjectFactory

Constructor Summary

Constructors

Constructor and Description
ViewController(Controller parent) Creates a new ViewController with the given parent controller.

Method Summary

Modifier and Type	Method and Description
void	addViewDecorator(ViewController.ViewDecorator decorator)
<T extends Entity> ViewContext<T>	createViewContext(Class<T> type, T entity)
protected Component	decorateView(Component view)
void	deinitialize() Callback called when the view is deinitialized (i.e.
Entity	getNearestViewModel() Crawls up controller hierarchy until it finds a controller with an attached view model.
String	getTitle()
Component	getView() Gets the view associated with this controller.
static ViewController	getViewController(ActionEvent evt)
static ViewController	getViewController(Component cmp) Gets the ViewController associated with this component.
Entity	getViewModel() Gets the ViewModel.
void	initController() Callback called when the view is initialized (i.e.
void	removeViewDecorator(ViewController.ViewDecorator decorator)
void	setTitle(String title)
void	setView(Component view) Sets the view associated with this controller.

Methods inherited from class com.codename1.rad.controllers.Controller

actionPerformed, addAction, addAction, addActionListener, addActions, addActions, addEventListener, addLookup, addLookup, addObjectFactory, createObjectWithFactory, createViewNode, dispatchEvent, extendAction, extendAction, fillSlot, getAction, getActions, getActionsNode, getApplicationController, getFormController, getFormController, getInheritedAction, getInheritedActions, getParent, getSectionController, getSingleActionsNode, getViewController, getViewNode, initControllerActions, isStarted, lookup, lookupEntity, onStartController, onStopController, parentLookup, parentLookupEntity, refresh, removeActionListener, removeEventListener, setParent, start, startController, withLookup, withLookupEntity, withParentLookup, withParentLookupEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewController

public ViewController(Controller parent)

Creates a new ViewController with the given parent controller.

Parameters:

parent -

Method Detail

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

addViewDecorator

public void addViewDecorator(ViewController.ViewDecorator decorator)

removeViewDecorator

public void removeViewDecorator(ViewController.ViewDecorator decorator)

decorateView

protected Component decorateView(Component view)

setView

public void setView(Component view)

Sets the view associated with this controller.

Parameters:

view -

getViewController

public static ViewController getViewController(Component cmp)

Gets the ViewController associated with this component. This will return the "nearest" view controller found in the view hierarchy. I.e. If the cmp has no view controller, then it will look in the parent container, and it’s parent, if necessary, all the way up to the Form.

Parameters:

cmp - Component whose ViewController we wish to retrieve.

Returns:

The ViewController for the component.

getViewController

public static ViewController getViewController(ActionEvent evt)

getView

public Component getView()

Gets the view associated with this controller.

Returns:

initController

public void initController()

Callback called when the view is initialized (i.e. made visible)

deinitialize

public void deinitialize()

Callback called when the view is deinitialized (i.e. removed from display hierarchy).

getViewModel

public Entity getViewModel()

Gets the ViewModel.

Returns:

getNearestViewModel

public Entity getNearestViewModel()

Crawls up controller hierarchy until it finds a controller with an attached view model.

Returns:

The nearest view model or null.

createViewContext

public <T extends Entity> ViewContext<T> createViewContext(Class<T> type,
                                                           T entity)