org.useware.kernel.gui.behaviour

Class InteractionCoordinator

java.lang.Object

org.useware.kernel.gui.behaviour.InteractionCoordinator

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, InteractionEvent.InteractionHandler, KernelContract, NavigationEvent.NavigationHandler, ProcedureExecution, ProcedureRuntimeAPI, StateCoordination, StatementEvent.StatementHandler

public class InteractionCoordinator
extends Object
implements KernelContract, InteractionEvent.InteractionHandler, NavigationEvent.NavigationHandler, StatementEvent.StatementHandler, ProcedureExecution, ProcedureRuntimeAPI, StateCoordination

A coordinator acts as the middleman between a framework (i.e. GWTP), the structure (interface model) and the behaviour (interaction model).

It wires the Resource input/output of interaction units to certain behaviour and vice versa. It's available at reification time to interaction units and provides an API to register Procedure's.

Author:

Heiko Braun

Constructor Summary

Constructors

Constructor and Description
InteractionCoordinator(Dialog dialog, StatementContext parentContext, NavigationDelegate navigationDelegate)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accepts(InteractionEvent event)
boolean	accepts(NavigationEvent event)
boolean	accepts(StatementEvent event)
void	activate()
void	activateUnit(QName unitId)
void	addProcedure(Procedure procedure) Procedures of same kind (same ID) can coexist if they can be further distinguished. A typical example stock procedures (save, load, etc) that are registered for different origins (interaction units).
boolean	canBeActivated(QName interactionUnit)
void	clearStatement(QName sourceId, String key)
void	fireEvent(com.google.web.bindery.event.shared.Event<?> event) Event delegation.
DialogState	getDialogState()
com.google.web.bindery.event.shared.EventBus	getLocalBus()
boolean	isActive(QName interactionUnit)
Map<QName,Set<Procedure>>	listProcedures()
void	onInteractionEvent(InteractionEvent event) Find the corresponding procedures and execute it.
void	onNavigationEvent(NavigationEvent event) Find and activate another IU.
void	onStatementEvent(StatementEvent event)
void	passivate()
void	reset()
void	setStatement(QName sourceId, String key, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractionCoordinator

@Inject
public InteractionCoordinator(Dialog dialog,
                             StatementContext parentContext,
                             NavigationDelegate navigationDelegate)

Method Detail

getDialogState

public DialogState getDialogState()

getLocalBus

public com.google.web.bindery.event.shared.EventBus getLocalBus()

isActive

public boolean isActive(QName interactionUnit)

Specified by:

isActive in interface ProcedureRuntimeAPI

canBeActivated

public boolean canBeActivated(QName interactionUnit)

Specified by:

canBeActivated in interface ProcedureRuntimeAPI

addProcedure

public void addProcedure(Procedure procedure)

Procedures of same kind (same ID) can coexist if they can be further distinguished.
A typical example stock procedures (save, load, etc) that are registered for different origins (interaction units).

Specified by:

addProcedure in interface ProcedureExecution

Parameters:

procedure -

listProcedures

public Map<QName,Set<Procedure>> listProcedures()

Specified by:

listProcedures in interface ProcedureExecution

fireEvent

public void fireEvent(com.google.web.bindery.event.shared.Event<?> event)

Event delegation. Uses the dialog ID as source.

Parameters:

event -

activateUnit

public void activateUnit(QName unitId)

Specified by:

activateUnit in interface StateCoordination

activate

public void activate()

Specified by:

activate in interface KernelContract

reset

public void reset()

Specified by:

reset in interface KernelContract

passivate

public void passivate()

Specified by:

passivate in interface KernelContract

accepts

public boolean accepts(InteractionEvent event)

Specified by:

accepts in interface InteractionEvent.InteractionHandler

onInteractionEvent

public void onInteractionEvent(InteractionEvent event)

Find the corresponding procedures and execute it.

Specified by:

onInteractionEvent in interface InteractionEvent.InteractionHandler

Parameters:

event -

accepts

public boolean accepts(NavigationEvent event)

Specified by:

accepts in interface NavigationEvent.NavigationHandler

onNavigationEvent

public void onNavigationEvent(NavigationEvent event)

Find and activate another IU. Can delegate to another context (i.e. gwtp placemanager) or handle it internally (same dialog)

Specified by:

onNavigationEvent in interface NavigationEvent.NavigationHandler

Parameters:

event -

accepts

public boolean accepts(StatementEvent event)

Specified by:

accepts in interface StatementEvent.StatementHandler

onStatementEvent

public void onStatementEvent(StatementEvent event)

Specified by:

onStatementEvent in interface StatementEvent.StatementHandler

setStatement

public void setStatement(QName sourceId,
                String key,
                String value)

Specified by:

setStatement in interface KernelContract

clearStatement

public void clearStatement(QName sourceId,
                  String key)

Specified by:

clearStatement in interface KernelContract