org.useware.kernel.gui.behaviour

Class DialogState

java.lang.Object

org.useware.kernel.gui.behaviour.DialogState

public class DialogState
extends Object

Reflects the dialog state. Breaks down into statements and scopes.

Author:

Heiko Braun

Constructor Summary

Constructors

Constructor and Description
DialogState(Dialog dialog, StatementContext parentContext, StateCoordination coordination)

Method Summary

Methods

Modifier and Type	Method and Description
QName	activateBranch(InteractionUnit unit)
QName	activateBranch(InteractionUnit unit, String suffix)
void	activateScope(QName targetUnit) Deactivates a previously active sibling scope and activate a new one.
boolean	canBeActivated(QName interactionUnit) A unit can be activated if the parent is a demarcation type or it is a root element
void	clearStatement(QName sourceId, String key)
void	flushChildScopes(QName unitId) Flush the scope of unit and all children.
StatementContext	getContext(QName unitId)
boolean	isWithinActiveScope(QName unitId) Is within active scope when itself and all it's parent scopes are active as well.
void	reset()
void	setStatement(QName interactionUnitId, String key, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogState

public DialogState(Dialog dialog,
           StatementContext parentContext,
           StateCoordination coordination)

Method Detail

reset

public void reset()

activateBranch

public QName activateBranch(InteractionUnit unit)

activateBranch

public QName activateBranch(InteractionUnit unit,
                   String suffix)

activateScope

public void activateScope(QName targetUnit)

Deactivates a previously active sibling scope and activate a new one. (Only a single sibling scope can be active at a time)

Parameters:

targetUnit - the unit from which the scope will be derived

flushChildScopes

public void flushChildScopes(QName unitId)

Flush the scope of unit and all children.

Parameters:

unitId -

clearStatement

public void clearStatement(QName sourceId,
                  String key)

setStatement

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

getContext

public StatementContext getContext(QName unitId)

canBeActivated

public boolean canBeActivated(QName interactionUnit)

A unit can be activated if the parent is a demarcation type or it is a root element

Parameters:

interactionUnit -

Returns:

isWithinActiveScope

public boolean isWithinActiveScope(QName unitId)

Is within active scope when itself and all it's parent scopes are active as well. This is necessary to ensure access to statements from parent scopes.

Parameters:

unitId -

Returns: