talx.controller.extended
Class JournalInterceptor

java.lang.Object
  talx.controller.extended.JournalInterceptor

All Implemented Interfaces:

ControllerListener, java.util.EventListener, GUIStateConstants, Interceptor, TALFeature

public class JournalInterceptor

extends java.lang.Object

implements GUIStateConstants, ControllerListener, Interceptor

Field Summary

static java.lang.String

ACTIVATE_JOURNAL_COMMAND

Fields inherited from interface talx.model.GUIStateConstants

ACTIVE_COMMANDS, ARCHIVE_MESSAGE, CHOICE_DIALOG, COMPOSE_FOCUS, COMPOSE_WINDOW, COMPOSER_CAPTION, COMPOSER_DIRTY, CONFIRM_DIALOG, CURRENT_PEOPLE, CURRENT_PLAYER, DEFAULT_MESSAGE, DIALOG_FOCUS, DIALOG_TEXT, INBOX_FOCUS, INBOX_MAIL_COUNTS, INBOX_MAIL_COUNTS_ANSWERED, INBOX_MAIL_COUNTS_NEW, INBOX_PANEL, INBOX_PLAYER_CAPTIONS, NO_CHANGE, NO_MESSAGE, NO_PEOPLE, NO_PERSON, NO_PLAYER, READER_CAPTION, READER_FOCUS, READER_HEADERS, READER_WINDOW, STATE_ABBR, STATE_CONST, STATE_DESC

Constructor Summary

JournalInterceptor(Settings settings, java.lang.String param)

Method Summary

boolean	claim(java.awt.event.ActionEvent ev, Controller c) Determines whether this feature is responsible for the action.
void	controllerChange(ControllerChangeEvent ev) Sent when the controller wants the GUI to change state.
void	controllerChangeFinished(ChangeFinishedEvent ev) Listen for changes in composer focus.
void	controllerChangeVetoed(ActionVetoException ex) Sent when the system has decided not to transition on a user action.
void	initialize(Controller c) Allows the interceptor to change the gui state.
void	release() Releases all system resources held by this object.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATE_JOURNAL_COMMAND

public static final java.lang.String ACTIVATE_JOURNAL_COMMAND

See Also:

Constant Field Values

Constructor Detail

JournalInterceptor

public JournalInterceptor(Settings settings,
                          java.lang.String param)

Parameters:

param - string consisting of key=value pairs with the following keys:

• date - date format string (see java.text.SimpleDateFormat). Each time the journal is invoked, this string is appended to the text.
• caption - the text to appear above the composer when the journal is active.
• subject - the composer's subject line for the journal.

Method Detail

claim

public boolean claim(java.awt.event.ActionEvent ev,
                     Controller c)
              throws ActionVetoException

Description copied from interface: Interceptor

Determines whether this feature is responsible for the action. In response to this method, the feature can:

• Claim the action and update the volatile state
• Not claim the action and not update the volatile state
• Veto the Action and not update the volatile state

Each feature can manage its own state in any way, including updating its state in response to unclaimed or vetoed actions. However, a feature may not update the volatile state without claiming the action. This is because the controller will not fire a changeFinishedEvent if the action is vetoed. Since, by not claiming the state, a feature leaves open the possibilty that another feature will veto it, it is only safe to update the state on actions that it claims. Once an action is claimed, the controller fires a changeFinishedEvent and stops propagating the action through the chain of responsibility.

Interceptors that wish to make some minor change to the gui state but not stop other effects from an action must make their change, refire the action via the controller's doAction() method, and then claim the action. Obviously, such interceptors must remember the action event to prevent them from reacting to it the next time.

Unlike ActionHandlers, which are stateless, Interceptors must manage their own state.

Specified by:

claim in interface Interceptor

Returns:

true to claim the action, false otherwise.

Throws:

ActionVetoException - to veto the action.

initialize

public void initialize(Controller c)

Description copied from interface: Interceptor

Allows the interceptor to change the gui state. This method is called in the controller init method just after the controller restores the state but before it fires the first controller change event.

Specified by:

initialize in interface Interceptor

release

public void release()

Description copied from interface: TALFeature

Releases all system resources held by this object. The general contract of pluggable features is that once their release method is called, they should be elligible for garbage collection. The exceptions to this are references to this object held in the ActionDispatcher and in the Transport model. Both of those objects are cleared by the system. However, in all other cases, if this object subscribed to a listener interface, it must unsubscribe in this method. This method should block until all object clean-up has been accomplished. This includes closing all open files, etc. Once the object has returned from the release method, the system may go down without further warning.

Specified by:

release in interface TALFeature

controllerChange

public void controllerChange(ControllerChangeEvent ev)

Description copied from interface: ControllerListener

Sent when the controller wants the GUI to change state.

Specified by:

controllerChange in interface ControllerListener

controllerChangeVetoed

public void controllerChangeVetoed(ActionVetoException ex)

Description copied from interface: ControllerListener

Sent when the system has decided not to transition on a user action.

Specified by:

controllerChangeVetoed in interface ControllerListener

controllerChangeFinished

public void controllerChangeFinished(ChangeFinishedEvent ev)

Listen for changes in composer focus. If the composer is active, but the journal is not in it, then we hide the journal button until the composer becomes inactive again.

Specified by:

controllerChangeFinished in interface ControllerListener