facets.idiom
Class XmlView

java.lang.Object
  facets.util.Tracer
      facets.util.app.AppValues
          facets.core.app.AppSpecifier
              facets.facet.app.FacetAppSpecifier
                  facets.facet.app.tree.TreeAppSpecifier
                      facets.idiom.XmlView

public final class XmlView
extends TreeAppSpecifier

TreeAppSpecifier that defines a utility application for viewing and editing simple tree content.

XmlView provides a minimal subset of the functionality defined by TreeAppSpecifier:

• viewing and editing of XML files
• search by XML tags, content, attributes and attribute values
• changing XML tag names case by case or globally
• save and read of compressed files
• encoding and decoding of content as ASCII text
• multiple document interface
• quick-expand tree display
• status bar with information on selected element
• content selection restored on file reload

More complex applications can be based on TreeAppSpecifier by reimplementing methods as listed below; XmlView itself provides examples which can be switched on by passing ARG_DEMO to main(String[]).

In TreeAppSpecifier:

• TreeAppSpecifier.xmlPolicy() to redefine XmlSpecifiers used in file dialogs
• newContentViews(NodeViewable) to add and customise content viewers
• newContentRootTargets() to define additional STargets to be exposed in the "Tree" menu; and newTreeMenuItems(FacetFactory, STargeter[], STargeter[]) to define the SFacets exposing them.
• getInternalContentSource() to redefine default content

In FacetAppSpecifier:

• FacetAppSpecifier.canCreateContent() to toggle content creation
• isFileApp() to toggle file open/close
• FacetAppSpecifier.canSaveContent() to toggle file save/restore
• FacetAppSpecifier.contentStyle() to redefine content presentation
• FacetAppSpecifier.toolkitType() to redefine look-and-feel

In AppSpecifier:

• AppSpecifier.canEditContent() to toggle editing
• AppSpecifier.canOverwriteContent() to toggle overwriting files
• AppSpecifier.offersHelp() if help resources are available

In Tracer:

• AppValues.traceOutput(String) to toggle debug tracing

Field Summary

static java.lang.String

ARG_DEMO

Fields inherited from class facets.facet.app.FacetAppSpecifier

ARG_NO_CREATE, ARG_NO_FILES, DRAG_WAIT_MIN, KEY_DEBUG_STATUS, KEY_DRAG_NOTIFY, KEY_DRAG_PAUSE, KEY_DRAG_WAIT, KEY_GRAPH_BUILD, KEY_GRAPH_FIND, KEY_GRAPH_OFFSETS, KEY_GRAPH_SPLIT, KEY_GRAPH_WHERE, KEY_SPLASH, KEY_TEXT_ALIASING

Fields inherited from class facets.util.app.AppValues

appName, KEY_TIMEOUT, KEY_TIMEOUT_SYSTEM, NATURE_DEBUG, NATURE_NO_SYSTEM_ACCESS, NATURE_RECORD_RUNS, NATURE_WRITABLE, PATH_APP, PATH_CORE, PATH_CORE_APP, PATH_CORE_DEBUG, PATH_DEBUG, PATH_RUNS, stateDebug, TYPE_NATURE, TYPE_STATE

Constructor Summary

XmlView()

Method Summary

protected void	addNatureDefaults(ValueNode root) Can set default configuration values.
protected java.lang.Object	getInternalContentSource() Fulfils FacetAppSurface.getInternalContentSource() in the return of TreeAppSpecifier.newApp(FacetFactory).
boolean	isFileApp() Defines default returns of FacetAppSpecifier.newActions(ActionAppSurface) and FacetAppSpecifier.contentStyle().
static void	main(java.lang.String[] args)
protected STarget[]	newContentRootTargets() Enables definition of additional STargets to be exposed in the TreeTargets.TITLE_MENU menu.
protected SView[]	newContentViews(NodeViewable viewable) Enables redefinition of SViews supplying viewer policy.
protected SFacet[]	newTreeMenuItems(FacetFactory ff, STargeter[] treeLinks, STargeter[] contentLinks) Defines SFacet items for the TreeTargets.TITLE_MENU menu.

Methods inherited from class facets.facet.app.tree.TreeAppSpecifier

newActions, newApp, xmlPolicy

Methods inherited from class facets.facet.app.FacetAppSpecifier

addStateDefaults, adjustClassValues, buildAndLaunchApp, canCreateContent, canSaveContent, contentStyle, decorationValues, joinValues, newFacetFactory, newPreferences, toolkitType

Methods inherited from class facets.core.app.AppSpecifier

app, canEditContent, canOverwriteContent, offersHelp

Methods inherited from class facets.util.app.AppValues

hasSystemAccess, nature, readValues, state, traceOutput, tryWriteValues

Methods inherited from class facets.util.Tracer

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

Methods inherited from class java.lang.Object

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

Field Detail

ARG_DEMO

public static final java.lang.String ARG_DEMO

See Also:

Constant Field Values

Constructor Detail

XmlView

public XmlView()

Method Detail

isFileApp

public boolean isFileApp()

Description copied from class: FacetAppSpecifier

Defines default returns of FacetAppSpecifier.newActions(ActionAppSurface) and FacetAppSpecifier.contentStyle().

Overrides:

isFileApp in class FacetAppSpecifier

Returns:

by default true unless contradicted using FacetAppSpecifier.ARG_NO_FILES

getInternalContentSource

protected java.lang.Object getInternalContentSource()

Description copied from class: TreeAppSpecifier

Fulfils FacetAppSurface.getInternalContentSource() in the return of TreeAppSpecifier.newApp(FacetFactory).

Overrides:

getInternalContentSource in class TreeAppSpecifier

Returns:

by default Nodes.newTestTree(String, int, double) with broad=5 which may be changed by passing TreeAppSpecifier.ARG_TREE_SIZE=broad

newContentViews

protected SView[] newContentViews(NodeViewable viewable)

Description copied from class: TreeAppSpecifier

Enables redefinition of SViews supplying viewer policy.

Called from TreeAppContenter.newContentViewers(ViewableFrame).

Overrides:

newContentViews in class TreeAppSpecifier

Parameters:

viewable - has the content as its SFrameTarget.framed

Returns:

by default a single TreeView

newContentRootTargets

protected STarget[] newContentRootTargets()

Description copied from class: TreeAppSpecifier

Enables definition of additional STargets to be exposed in the TreeTargets.TITLE_MENU menu.

Called from TreeAppContenter.lazyContentRootElements(SAreaTarget).

Overrides:

newContentRootTargets in class TreeAppSpecifier

Returns:

targets whose STargeters will be passed to TreeAppSpecifier.newTreeMenuItems(FacetFactory, STargeter[], STargeter[]); by default an empty STarget[]

newTreeMenuItems

protected SFacet[] newTreeMenuItems(FacetFactory ff,
                                    STargeter[] treeLinks,
                                    STargeter[] contentLinks)

Description copied from class: TreeAppSpecifier

Defines SFacet items for the TreeTargets.TITLE_MENU menu.

Called from TreeAppFacets.adjustMenuRoots(MenuFacets[])

Overrides:

newTreeMenuItems in class TreeAppSpecifier

Parameters:

ff - the calling TreeAppFacets

treeLinks - exposing TreeTargets.appTargets()

contentLinks - targeting returns (if any) of TreeAppSpecifier.newContentRootTargets()

Returns:

by default treeAppFacets indexed with TreeTargets.TARGET_SEARCH, TreeTargets.TARGET_ENCODE,TreeTargets.TARGET_TYPE,

addNatureDefaults

protected void addNatureDefaults(ValueNode root)

Description copied from class: AppValues

Can set default configuration values.

Called from AppValues.readValues(String[]); values added are treated as defaults for AppValues.nature(boolean).

Default implementation is empty.

Overrides:

addNatureDefaults in class FacetAppSpecifier

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception