com.sptci.echo2

Class Controller<V>

java.lang.Object

com.sptci.echo2.Controller<V>

All Implemented Interfaces:

Serializable

public abstract class Controller<V>
extends Object
implements Serializable

An abstract base class for all controllers.

Note: It is imperative that sub-classes set application to a valid instance.

©Copyright 2006 Sans Pareil Technologies, Inc.

Version:

$Id: Controller.java 4950 2010-02-24 02:12:59Z rakesh $

Author:

Rakesh Vidyadharan 2006-05-16

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Controller.Updater<S> An abstract updater task used to execute timed tasks in the background and push updates to the UI.
protected class	Controller.Worker<S> An abstract worker thread used to execute tasks in the background to avoid locking up the UI.

Field Summary

Fields

Modifier and Type	Field and Description
protected Application	application The global application instance for each session.
protected static Logger	logger The logger used to log errors to.
protected V	view The view that is controlled by this instance.

Constructor Summary

Constructors

Constructor and Description
Controller(V view) Crete a new instance of the controller for the specified view.

Method Summary

Modifier and Type	Method and Description
void	addPane(FloatingPane pane) Add the specified FloatingPane to the ContentPane of Application.window with an appropriate z-index.
static boolean	checkText(String text) Check the specified string to ensure that it is not null and not empty.
Application	getApplication() Returns application.
String	getDataDirectory() Convenience method that returns Application.dataDirectory.
Logger	getLogger() Return the logger associated with this controller.
V	getView() Returns view.
void	processFatalException(String message, Throwable t) A global handler for exceptions encountered while updating the display.
void	processFatalException(Throwable t) A global handler for exceptions encountered while updating the display.
protected void	setApplication(Application application) Set application.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

The logger used to log errors to.

application

protected Application application

The global application instance for each session.

view

protected final V view

The view that is controlled by this instance.

Constructor Detail

Controller

public Controller(V view)

Crete a new instance of the controller for the specified view.

Parameters:

view - The view this controller controls.

Method Detail

checkText

public static boolean checkText(String text)

Check the specified string to ensure that it is not null and not empty. Strings that are composed entirely of spaces are also treated as empty.

Parameters:

text - The text that is to be checked.

Returns:

Return true if the string specified is not null or empty.

getApplication

public Application getApplication()

Returns application.

Returns:

Application The value/reference of/to application.

setApplication

protected void setApplication(Application application)

Set application.

Parameters:

application - The value to set.

getView

public V getView()

Returns view.

Returns:

V The value/reference of/to view.

getLogger

public Logger getLogger()

Return the logger associated with this controller.

Returns:

The logger in use.

getDataDirectory

public String getDataDirectory()

Convenience method that returns Application.dataDirectory.

Returns:

The value/reference of/to dataDirectory.

addPane

public void addPane(FloatingPane pane)

Add the specified FloatingPane to the ContentPane of Application.window with an appropriate z-index. Convenience wrapper around Application.addPane(nextapp.echo2.app.FloatingPane).

Parameters:

pane - The window pane that is to be added.

processFatalException

public void processFatalException(Throwable t)

A global handler for exceptions encountered while updating the display.

Parameters:

t - The fatal exception

See Also:

Application.processFatalException( Throwable )

processFatalException

public void processFatalException(String message,
                                  Throwable t)

A global handler for exceptions encountered while updating the display.

Parameters:

message - The message to display in the ErrorPane.

t - The fatal exception

See Also:

Application.processFatalException( String, Throwable )