facets.core.superficial.app
Interface SContenter

All Superinterfaces:

TargeterCore.TargetType, Titled

All Known Subinterfaces:

AppSurface.Contenter, DialogSurface.Contenter

All Known Implementing Classes:

FacetDialogContenter, SimpleContenter, TreeAppContenter, ValueDialogContenter, ViewerContenter

public interface SContenter
extends TargeterCore.TargetType, Titled

Builds a targeter tree and facets that can expose its content.

SContenter encapsulates creation of a targeter tree that exposes its content to user view and control, defining methods that can be called by a surface during (re)building.

• newContentRoot(boolean, boolean) will return a content area root which in turn creates the SContentRootTargeter to be used by the surface for the content type.
• rootRetargeted(SContentRootTargeter) can be called after the initial build and at each retargeting

Method Summary

SFrameTarget	contentFrame() Frame content wrapped by this contenter.
SAreaTarget	newContentRoot(boolean faceted, boolean shareSelection) Construct a content area tree.
void	rootRetargeted(SContentRootTargeter t) Notify the contenter of retargeting.
java.lang.String	title() Return a suitable title for the content.

Method Detail

newContentRoot

SAreaTarget newContentRoot(boolean faceted,
                           boolean shareSelection)

Construct a content area tree.

For use by SSurfaces to create content area trees for incorporation into their surface area trees.

Parameters:

faceted - should the area tree have facets attached?

shareSelection - should the new tree frame the existing viewable

Returns:

the SAreaTarget root of an area tree containing either the content or viewers for the content; the root should in turn return with SAreaTarget.newTargeter() a SContentRootTargeter for the content wrapped by the SContenter.

rootRetargeted

void rootRetargeted(SContentRootTargeter t)

Notify the contenter of retargeting.

Should be called by the surface whenever its root SContentRootTargeter has been retargeted on a content root returned by newContentRoot(boolean, boolean) in this SContenter, with the following guarantees.

• Before the first invocation, all targeter tree elements exposing this content will have been attached to rootTargeter - allows setting of references to other elements.
• All attached facets will be retargeted after any invocation - allows setting of live states etc.

Parameters:

t - will be retargeted on a content root created by this SContenter type (not generally by this instance).

contentFrame

SFrameTarget contentFrame()

Frame content wrapped by this contenter.

Must be that returned by SAreaTarget.activeContent() in each content root returned by newContentRoot(boolean, boolean) in this SContenter.

title

java.lang.String title()

Return a suitable title for the content.

This will generally be either the name of an external content source or a suitable dialog area title.

Specified by:

title in interface Titled

Returns:

non-null, non-empty string with no structural whitespace