facets.facet
Class ViewerAreaMaster

java.lang.Object
  facets.facet.ViewerAreaMaster

public class ViewerAreaMaster
extends java.lang.Object

Parameter object for viewer creation methods in AreaFacets.

ViewerAreaMaster has two roles. It

• encapsulates parameters required when creating viewer facets and attaching them to the area target tree.
• can supply a custom ViewerMaster
• can supply a closure that creates a local viewer toolbar.

Constructor Summary

ViewerAreaMaster()

Method Summary

StringFlags	hints()
protected java.lang.String	hintString() Return concatenated hint strings.
protected ViewerAreaMaster	newChildMaster(SAreaTarget area) May return specific master for the area passed.
protected SFacet	newViewerTools(STargeter viewTargeter) May return custom local toolbar.
FacetMaster.Viewer	viewerMaster() May return custom FacetMaster.Viewer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewerAreaMaster

public ViewerAreaMaster()

Method Detail

hints

public final StringFlags hints()

viewerMaster

public FacetMaster.Viewer viewerMaster()

May return custom FacetMaster.Viewer.

Default returns null, signalling that type be determined by the surface builder based on view.

Non-null returns should be of the extension class for the builder.

hintString

protected java.lang.String hintString()

Return concatenated hint strings.

Default returns FacetFactory.HINT_NONE.

newViewerTools

protected SFacet newViewerTools(STargeter viewTargeter)

May return custom local toolbar.

Parameters:

viewTargeter - targeting the ViewerTargetCore.viewFrame()

Returns:

null by default

newChildMaster

protected ViewerAreaMaster newChildMaster(SAreaTarget area)

May return specific master for the area passed.

Default returns null.