facets.core.app
Class StatefulViewable<S extends Stateful>

java.lang.Object
  facets.util.Tracer
      facets.core.superficial.TargetCore
          facets.core.superficial.SFrameTarget
              facets.core.superficial.app.SelectingFrame
                  facets.core.superficial.app.ViewableFrame
                      facets.core.app.StatefulViewable<S>

All Implemented Interfaces:

Notifiable, Notifying, STarget, TargeterCore.TargetType, Identified, Titled

Direct Known Subclasses:

NodeViewable

public abstract class StatefulViewable<S extends Stateful>
extends ViewableFrame

ViewableFrame with Stateful content.

StatefulViewable extends its superclass by requiring both its SFrameTarget.framed content and all members of its SelectingFrame.selection() to be Stateful, enabling the provision of

• data transfer using a StatefulViewable.Clipper connection to the system clipboard and drag and drop implementation
• state management (undo/redo)

Nested Class Summary

static interface	StatefulViewable.Clipper Can copy and paste the content of a StatefulViewable.
static interface	StatefulViewable.ClipperSource Can supply a StatefulViewable with a suitable StatefulViewable.Clipper.

Nested classes/interfaces inherited from interface facets.core.superficial.STarget

STarget.Targeted

Nested classes/interfaces inherited from interface facets.core.superficial.Notifying

Notifying.Impact

Field Summary

protected StatefulViewable.Clipper

clipper

Fields inherited from class facets.core.superficial.SFrameTarget

framed

Fields inherited from class facets.core.superficial.TargetCore

targets

Fields inherited from interface facets.core.superficial.STarget

NONE

Constructor Summary

protected

StatefulViewable(java.lang.String title, S content, StatefulViewable.ClipperSource clipperSource) Unique constructor.

Method Summary

boolean	actionIsLive(SViewer viewer, ViewableAction action) Re-implementation that understands ActionViewerTarget.Actions.
protected void	actionTriggered(SViewer viewer, ViewableAction action) Re-implementation that understands ActionViewerTarget.Actions.
protected boolean	blockNotification() Enables notification to be restricted to this member of the tree.
protected boolean	canMergeEdits(Stateful[] earlier, Stateful[] later) Can one edit state subsume the other?
protected boolean	canPaste()
protected boolean	checkStateChange(Stateful stateThen, Stateful stateNow) Check for difference between two states of a content member.
protected void	copyContentState()
void	copyStatefulSelection()
void	deleteSelection()
boolean	editSelection()
java.lang.Object	identity() Return an object that is as far as possible unique for the implementation.
Notifying.Impact	impact() Allows this Notifying to specify a default Notifying.Impact.
void	insertStatefuls(Stateful... stateful)
void	iterateSelection(boolean forward)
protected Stateful[]	matchSelectionEdits(Stateful[] selections, Stateful[] edits) Ensure that the list of edits matches that of the content passed.
Notifiable	monitor() The current Notifiable in the notification tree, as set with setMonitor.
protected static TypedNode	newDebugContentNode(java.lang.String title, java.lang.Object source)
protected static TypedNode	newDebugContentNode(java.lang.String title, java.lang.Object[] source)
protected static TypedNode	newDebugMonitorNode(Notifiable monitor)
TypedNode	newGraphNode() Returns a descriptive node for use in debug object graph.
protected Stateful[]	newPasteStatefuls()
protected S[]	newPasteTextStatefuls(java.lang.String text) Attempt to create content from a text representation.
static Stateful[]	newStatefulArray(java.lang.Object[] array)
java.lang.String	newStatefulsText(S[] selected) Create a textual representation of one or more Statefuls for use in data transfer.
void	notify(Notice notice) Respond to the Notice passed.
void	notifyMonitor(Notifying.Impact impact) Call notify on the parent monitor in the notification tree, typically with itself as parameter to the Notice passed.
protected void	restoreState(Stateful content, Stateful state)
void	setFramedState(java.lang.Object stateSpec, boolean interim) Overrides method from ViewableFrame.
void	setMonitor(Notifiable monitor) Attach the Notifying to a Notifiable parent in the notification tree.
boolean	textSeemsPastable(java.lang.String text) Does the text passed seem to represent suitable content?
void	updateAfterEditAction()

Methods inherited from class facets.core.superficial.app.ViewableFrame

newViewerSelection, viewerActions, viewerSelectionChanged, viewerSelectionEdited

Methods inherited from class facets.core.superficial.app.SelectingFrame

defineSelection, selection, selectionFrame, setSelection

Methods inherited from class facets.core.superficial.SFrameTarget

newDebugChildren, notifiesTargeter, title

Methods inherited from class facets.core.superficial.TargetCore

elements, findMonitorOfType, isLive, join, lazyElements, newTargeter, setElements, setLive, toString, wantsFocus

Methods inherited from class facets.util.Tracer

trace, trace, trace, trace, trace, traceDebug, traceDebug, traceObjectText, traceOutput, traceOutputWithClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface facets.core.superficial.Notifying

impact, monitor, notifyMonitor, setMonitor

Methods inherited from interface facets.core.superficial.Notifiable

notify

Field Detail

clipper

protected final StatefulViewable.Clipper clipper

Constructor Detail

StatefulViewable

protected StatefulViewable(java.lang.String title,
                           S content,
                           StatefulViewable.ClipperSource clipperSource)

Unique constructor.

Parameters:

title - passed to superclass

content - passed to superclass

clipperSource - if non-null will be used for data transfer

Method Detail

copyStatefulSelection

public final void copyStatefulSelection()

canPaste

protected final boolean canPaste()

newPasteStatefuls

protected final Stateful[] newPasteStatefuls()

newStatefulsText

public java.lang.String newStatefulsText(S[] selected)

Create a textual representation of one or more Statefuls for use in data transfer.

May be called (indirectly) from copyStatefulSelection(); default returns a debug string.

Parameters:

selected - are the currently selected content

textSeemsPastable

public boolean textSeemsPastable(java.lang.String text)

Does the text passed seem to represent suitable content?

Used to determine the live state of the viewer 'Paste' target; default return false.

Parameters:

text - is currently on the system clipboard

newPasteTextStatefuls

protected S[] newPasteTextStatefuls(java.lang.String text)

Attempt to create content from a text representation.

Called by newPasteStatefuls(); may return null (the default) to signal failure.

Parameters:

text - is currently on the system clipboard

iterateSelection

public void iterateSelection(boolean forward)

insertStatefuls

public void insertStatefuls(Stateful... stateful)

deleteSelection

public void deleteSelection()

editSelection

public boolean editSelection()

copyContentState

protected void copyContentState()

actionIsLive

public boolean actionIsLive(SViewer viewer,
                            ViewableAction action)

Re-implementation that understands ActionViewerTarget.Actions.

Overrides:

actionIsLive in class ViewableFrame

Parameters:

viewer - the active viewer

action - to be exposed

actionTriggered

protected void actionTriggered(SViewer viewer,
                               ViewableAction action)

Re-implementation that understands ActionViewerTarget.Actions.

Overrides:

actionTriggered in class ViewableFrame

Parameters:

viewer - the active viewer

action - specifies the action proposed

updateAfterEditAction

public final void updateAfterEditAction()

setFramedState

public void setFramedState(java.lang.Object stateSpec,
                           boolean interim)

Overrides method from ViewableFrame.

Having converted both stateSpec and the PathSelection.selections() of SelectingFrame.selection() to Stateful[],

1. matches edits to their targets by calling matchSelectionEdits(Stateful[], Stateful[])
2. compares array members using checkStateChange(Stateful, Stateful)
3. calls Stateful.setState(Object) in each path target with the appropriate edit
4. stores non-interim changes in a private state management sequence

Overrides:

setFramedState in class SFrameTarget

Parameters:

stateSpec - must define the new state of SFrameTarget.framed

interim - if true the edit forms part of a sequence

matchSelectionEdits

protected Stateful[] matchSelectionEdits(Stateful[] selections,
                                         Stateful[] edits)

Ensure that the list of edits matches that of the content passed.

Called from setFramedState(Object, boolean); default returns the edits passed.

Parameters:

selections - from the current selection

edits - were passed to setFramedState(Object, boolean)

checkStateChange

protected boolean checkStateChange(Stateful stateThen,
                                   Stateful stateNow)

Check for difference between two states of a content member.

Called from setFramedState(Object, boolean); default returns false.

Parameters:

stateThen - a copy of the previous state

stateNow - the current state

canMergeEdits

protected boolean canMergeEdits(Stateful[] earlier,
                                Stateful[] later)

Can one edit state subsume the other?

Called (indirectly) from setFramedState(Object, boolean); default is false

Parameters:

earlier - the previous edit

later - the new edit which may subsume earlier

restoreState

protected void restoreState(Stateful content,
                            Stateful state)

newStatefulArray

public static final Stateful[] newStatefulArray(java.lang.Object[] array)

newDebugContentNode

protected static final TypedNode newDebugContentNode(java.lang.String title,
                                                     java.lang.Object source)

newDebugContentNode

protected static final TypedNode newDebugContentNode(java.lang.String title,
                                                     java.lang.Object[] source)

newDebugMonitorNode

protected static final TypedNode newDebugMonitorNode(Notifiable monitor)

newGraphNode

public final TypedNode newGraphNode()

Returns a descriptive node for use in debug object graph.

impact

public Notifying.Impact impact()

Description copied from interface: Notifying

Allows this Notifying to specify a default Notifying.Impact.

Specified by:

impact in interface Notifying

Returns:

typically Notifying.Impact.DEFAULT

identity

public java.lang.Object identity()

Description copied from interface: Identified

Return an object that is as far as possible unique for the implementation.

This will usually be a class instance counter.

Specified by:

identity in interface Identified

monitor

public final Notifiable monitor()

The current Notifiable in the notification tree, as set with setMonitor.

Complains if no parent has been set.

Specified by:

monitor in interface Notifying

notify

public void notify(Notice notice)

Description copied from interface: Notifiable

Respond to the Notice passed.

When this method is called, the Notifiable should respond based on

• its own nature and state
• the Notice passed.

Specified by:

notify in interface Notifiable

notifyMonitor

public final void notifyMonitor(Notifying.Impact impact)

Description copied from interface: Notifying

Call notify on the parent monitor in the notification tree, typically with itself as parameter to the Notice passed.

Has no effect if no monitor has been set.

This is the usual means to trigger a surface retargeting, being called by an exposing SFacet on its target.

Specified by:

notifyMonitor in interface Notifying

Parameters:

impact - suggests the level of retargeting required

blockNotification

protected boolean blockNotification()

Enables notification to be restricted to this member of the tree.

Checked by notify(Notice); default returns false.

setMonitor

public final void setMonitor(Notifiable monitor)

Description copied from interface: Notifying

Attach the Notifying to a Notifiable parent in the notification tree.

Specified by:

setMonitor in interface Notifying