AbstractAppController Class Reference

Inheritance diagram for AbstractAppController:

[legend]Collaboration diagram for AbstractAppController:

[legend]List of all members.

---

Detailed Description

A basic controller that negotiates the state between a model and one or more views.

Author:

Author

tvaline

Version:

Revision

1.3

,

Date

2005/05/31 20:10:59

Definition at line 31 of file AbstractAppController.java.

Public Member Functions
	AbstractAppController (AbstractAppModel model, AbstractAppView view, AppOption options[]) throws AppException
	Creates a new AppController object.
final void	actionPerformed (ActionEvent evt)
	ActionEvent perform method.
synchronized void	addView (AppControllerEventListener view)
	Registers ActionListener to receive events.
abstract ActionEvent	processEvent (ActionEvent evt)
	Event processing method.
synchronized void	removeView (AppControllerEventListener view)
	Removes ActionListener from the list of listeners.
abstract void	startController ()
	This method starts the controller and should perform any application initialization that is required.
String	toString ()
	Returns a string representation of this object.
Protected Member Functions
void	notifyModel (ActionEvent event)
	Sends notification to update the model.
void	notifyViews (ActionEvent event)
	Sends notification to update the views.
synchronized void	setModel (AppControllerEventListener model) throws TooManyListenersException
	Registers ActionListener to receive events.
Protected Attributes
transient AppControllerEventListener	model = null
	The application model.
AppOption	options [] = null
	Command line options.
ThreadFactory	pool = Executors.defaultThreadFactory()
	The application thread pool.
transient List< AppControllerEventListener >	views
	The application views.

---

Constructor & Destructor Documentation

AbstractAppController (  AbstractAppModel  model, AbstractAppView  view, AppOption  options[] )  throws AppException

Creates a new AppController object. Adds the controller as a listener to both the application model and the application view. Also adds the application model and the application view as event listeners of the controller. Parameters: model  The application model to control view  The application view to control options  The applications command line options Exceptions: AppException  If an error in processing occurs Definition at line 57 of file AbstractAppController.java. References AbstractAppController.addView(), AbstractAppController.model, AbstractAppController.options, and AbstractAppController.setModel(). { this.options = options; try { model.setController(this); view.setController(this); setModel(model); addView(view); } catch(TooManyListenersException e) { throw new AppException(e.getMessage()); } }

---

Member Function Documentation

final void actionPerformed (  ActionEvent  evt  )

ActionEvent perform method. This method passes events to the processEvent method for dispatch. Parameters: evt  The event to process Definition at line 97 of file AbstractAppController.java. References AbstractAppController.notifyModel(), AbstractAppController.notifyViews(), and AbstractAppController.processEvent(). { ActionEvent event = processEvent(evt); notifyModel(event); notifyViews(event); }

synchronized void addView (  AppControllerEventListener  view  )

Registers ActionListener to receive events. Parameters: view  The listener to register. Definition at line 108 of file AbstractAppController.java. References AbstractAppController.views. Referenced by AbstractAppController.AbstractAppController(). { if(views == null){views = new ArrayList<AppControllerEventListener>();} views.add(view); }

void notifyModel (  ActionEvent  event  )  [protected]

Sends notification to update the model. Parameters: event  The event to send to the model Definition at line 134 of file AbstractAppController.java. References AbstractAppController.model, and AbstractAppController.pool. Referenced by AbstractAppController.actionPerformed(). { if((model == null) || (event == null)){return;} final AppControllerEventListener mod = model; final ActionEvent evt = event; pool.newThread(new Runnable() { public void run(){mod.actionPerformed(evt);} }).start(); }

void notifyViews (  ActionEvent  event  )  [protected]

Sends notification to update the views. Parameters: event  The event to send to the views Definition at line 148 of file AbstractAppController.java. Referenced by AbstractAppController.actionPerformed(). { List list; synchronized(this) { if((views == null) || (event == null)){return;} list = (List)((ArrayList)views).clone(); } final ActionEvent evt = event; for(int i = 0;i < list.size();i++) { final AppControllerEventListener view = (AppControllerEventListener)list .get(i); pool.newThread(new Runnable() { public void run(){view.actionPerformed(evt);} }).start(); } }

abstract ActionEvent processEvent (  ActionEvent  evt  )  [pure virtual]

Event processing method. This method is responsible for handling all events processed by the controller. This method must be implemented by all subclasses. Parameters: evt  The event to process. Returns: An event sent to update the model and views in response to the received event. This method should return null if no response is required. Referenced by AbstractAppController.actionPerformed().

synchronized void removeView (  AppControllerEventListener  view  )

Removes ActionListener from the list of listeners. Parameters: view  The listener to remove. Definition at line 118 of file AbstractAppController.java. References AbstractAppController.views. { if(views != null){views.remove(view);} }

synchronized void setModel (  AppControllerEventListener  model  )  throws TooManyListenersException [protected]

Registers ActionListener to receive events. Parameters: model  The listener to register. Exceptions: TooManyListenersException  If an attempt is made to associate more than one model with this controller. Definition at line 172 of file AbstractAppController.java. Referenced by AbstractAppController.AbstractAppController(). { if(model == null){this.model = null;} else { if(this.model != null){throw new TooManyListenersException();} this.model = model; } }

abstract void startController (   )  [pure virtual]

This method starts the controller and should perform any application initialization that is required. This method must be implemented by all subclasses. Referenced by AbstractApp.run().

String toString (   )

Returns a string representation of this object. Returns: The physical address of this instance. Definition at line 127 of file AbstractAppController.java. {return super.toString();}

---

Member Data Documentation

transient AppControllerEventListener model = null [protected]

The application model. Definition at line 34 of file AbstractAppController.java. Referenced by AbstractAppController.AbstractAppController(), and AbstractAppController.notifyModel().

AppOption options[] = null [protected]

Command line options. Definition at line 37 of file AbstractAppController.java. Referenced by AbstractAppController.AbstractAppController().

ThreadFactory pool = Executors.defaultThreadFactory() [protected]

The application thread pool. Definition at line 40 of file AbstractAppController.java. Referenced by AbstractAppController.notifyModel().

transient List<AppControllerEventListener> views [protected]

The application views. Definition at line 43 of file AbstractAppController.java. Referenced by AbstractAppController.addView(), and AbstractAppController.removeView().

---

The documentation for this class was generated from the following file:

• com/ohrasys/app/AbstractAppController.java

---