facets.core.superficial.app
Class IndexingFrame

java.lang.Object
  facets.util.Tracer
      facets.core.superficial.TargetCore
          facets.core.superficial.SFrameTarget
              facets.core.superficial.app.SelectingFrame
                  facets.core.superficial.app.IndexingFrame

All Implemented Interfaces:

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

public abstract class IndexingFrame
extends SelectingFrame

SelectingFrame that selects with an SIndexing.

IndexingFrame specialises its superclass for content that can be selected by index.

Nested Class Summary

static class

IndexingFrame.FrameTargeter Targeter for an IndexingFrame.

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

protected	IndexingFrame(java.lang.String title, java.lang.Object content) Core constructor.
	IndexingFrame(java.lang.String title, java.lang.Object[] indexables, int index) Convenience constructor for use with simple array content.
	IndexingFrame(java.lang.String title, java.lang.Object content, SIndexing children) Main constructor.

Method Summary

protected boolean	blockNotification() Enables notification to be restricted to this member of the tree.
void	defineSelection(java.lang.Object definition) Re-implementation that creates a suitable SSelection.
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.
SIndexing	indexing() The indexing last set with setIndexing(SIndexing).
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 abstract SFrameTarget	newIndexedFrame(java.lang.Object indexed) Create a SFrameTarget complying with selectionFrame().
STargeter	newTargeter() Overrides superclass method.
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.
SFrameTarget	selectionFrame() Re-implementation.
void	setIndexing(SIndexing indexing) Sets an SIndexing that can index into content of SFrameTarget.framed.
void	setMonitor(Notifiable monitor) Attach the Notifying to a Notifiable parent in the notification tree.

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

selection, setSelection

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, 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

IndexingFrame

public IndexingFrame(java.lang.String title,
                     java.lang.Object content,
                     SIndexing children)

Main constructor.

Parameters:

title - passed to core

content - passed to core

children - passed to setIndexing(SIndexing)

IndexingFrame

public IndexingFrame(java.lang.String title,
                     java.lang.Object[] indexables,
                     int index)

Convenience constructor for use with simple array content.

Parameters:

title - passed to core constructor

indexables - passed to core and SIndexing constructors

index - used for SIndexing constructor

IndexingFrame

protected IndexingFrame(java.lang.String title,
                        java.lang.Object content)

Core constructor.

NOTE Where called from subclass constructors, these must also create and SIndexing and pass to setIndexing(SIndexing).

Parameters:

title - passed to superclass

content - passed to superclass

Method Detail

defineSelection

public void defineSelection(java.lang.Object definition)

Re-implementation that creates a suitable SSelection.

Calls SIndexing.setIndexed(Object) in indexing() with definition, then SelectingFrame.setSelection(SSelection) with a new SSelection returning as SSelection.selection() the new SIndexing.indexed() (which will be definition).

Overrides:

defineSelection in class SelectingFrame

Parameters:

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

selectionFrame

public final SFrameTarget selectionFrame()

Re-implementation.

Returns the SFrameTarget created in newIndexedFrame(Object).

Overrides:

selectionFrame in class SelectingFrame

newIndexedFrame

protected abstract SFrameTarget newIndexedFrame(java.lang.Object indexed)

Create a SFrameTarget complying with selectionFrame().

Parameters:

indexed - the currently indexed member of SFrameTarget.framed

setIndexing

public void setIndexing(SIndexing indexing)

Sets an SIndexing that can index into content of SFrameTarget.framed.

Also calls defineSelection(Object) with the current SIndexing.indexed().

Parameters:

indexing - must have SIndexing.indexables() matching the current state of SFrameTarget.framed.

indexing

public final SIndexing indexing()

The indexing last set with setIndexing(SIndexing).

newTargeter

public STargeter newTargeter()

Overrides superclass method.

Must return an IndexingFrame.FrameTargeter.

Overrides:

newTargeter in class TargetCore

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