facets.core.superficial.app
Class SelectingFrame

java.lang.Object
  extended by facets.util.Tracer
      extended by facets.core.superficial.TargetCore
          extended by facets.core.superficial.SFrameTarget
              extended by facets.core.superficial.app.SelectingFrame
All Implemented Interfaces:
Notifiable, Notifying, STarget, TargeterCore.TargetType, Identified, Titled
Direct Known Subclasses:
IndexingFrame, ViewableFrame

public abstract class SelectingFrame
extends SFrameTarget

SFrameTarget that maintains a SSelection.

SelectingFrame extends its superclass by


Nested Class Summary
 
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
 
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
SelectingFrame(java.lang.String title, java.lang.Object content)
          Unique constructor.
 
Method Summary
protected  boolean blockNotification()
          Enables notification to be restricted to this member of the tree.
 void defineSelection(java.lang.Object definition)
          Define a selection within the content framed.
 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.
 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.
 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.
 SSelection selection()
          The current selection within the content framed.
 SFrameTarget selectionFrame()
          Return a SFrameTarget framing the currently selected content.
 void setMonitor(Notifiable monitor)
          Attach the Notifying to a Notifiable parent in the notification tree.
protected  void setSelection(SSelection selection)
          Sets the selection to be returned by selection().
 
Methods inherited from class facets.core.superficial.SFrameTarget
newDebugChildren, notifiesTargeter, setFramedState, 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
 

Constructor Detail

SelectingFrame

public SelectingFrame(java.lang.String title,
                      java.lang.Object content)
Unique constructor.

Parameters:
title - passed to superclass
content - passed to superclass
Method Detail

defineSelection

public void defineSelection(java.lang.Object definition)
Define a selection within the content framed.

Parameters:
definition - in the default implementation is cast to a SSelection and passed to setSelection(SSelection)

selection

public final SSelection selection()
The current selection within the content framed.

Returns:
the SSelection last set with setSelection(SSelection)

setSelection

protected final void setSelection(SSelection selection)
Sets the selection to be returned by selection().

This method is defined protected as it should only be called by subclasses; external callers should use the more general defineSelection(Object).

Parameters:
selection - must have a SSelection.content() equal to SFrameTarget.framed.

selectionFrame

public SFrameTarget selectionFrame()
Return a SFrameTarget framing the currently selected content.

Content framed should be that returned in the selection methods of selection().

Default frames a single selection, titled from the selected content or else using SFrameTarget.title().


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

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