com.raritantechnologies.utils.tree.taglibrary
Class ExploreTreeRenderer

java.lang.Object
  com.raritantechnologies.utils.tree.taglibrary.ExploreTreeRenderer

All Implemented Interfaces:

IConfigurable, ITreeRenderer

public class ExploreTreeRenderer

extends java.lang.Object

implements ITreeRenderer

Renders an RTI TreeRoot object as a "Explorer" Tree.

XML Configuration Template:

  <TreeRenderer class="com.raritantechnologies.utils.tree.taglibrary.ExploreTreeRenderer"
                   fieldID="[ taxonomy field to get current value from ]"
                   fieldValue="[ PATH | NODEID | NAME | Attribute:{attribute value} ]"
                   openImgURL="[ open folder image ]"
                   openLastImgURL="[ open last folder image ]"
                   closedImgURL="[ closed folder image ]"
                   closedLastImgURL="[ closed last folder image ]"
                   emptyImgURL="[ empty folder image ]"
                   emptyLastImgURL="[ empty last folder image ]"
                   lineImgURL="[ line image ]"
                   blankImgURL="[ spacer image ]"
                   activeNodeParam="[ parameter to detect active node value ]"
                   activeNodeDelimiter="[ path delimiter in active node value ]"
                   directHyperlink="[true|false(default)]"
                   hyperlinkTarget="[ target window of node hyperlinks ]"
                   hyperlinkIsJavascript="[ node hyperlinks call javascript function if true. Default is false ]"
                   onlyHyperlinkLeafNodes="[ true|false(default) ]"
                   hyperlinkClass="[ optional CSS class of hyperlink ]"
                   activeHyperlinkClass="[ css class for active hyperlink ]"
                   useChangeNodeScript="[true(default)|false]"
                   showCounts="[true(default)|false]"
                   renderRoot="[true(default)|false]"
                   hyperlinkRoot="[true(default)|false]"
                   expandCurrentNode="[true(default)|false]"
                   useTreeNameAsPrefix="[true|false(default) ]"
                   addRequestParameters="[true|false(default) ]"
                   initialRenderDepth="[ optional depth for initial rendering of open nodes ]"
                   wrapNodeText="[true(default)|false]"
                   updateNodeParam="[ used for 'lazy' tree evaluation - if parameter is present, nodes where needsUpdate( ) is true will produce a '+' server hyperlink ]" >

    <!-- Optional changeNode javascript function -->
    <ChangeNodeScript>

    </ChangeNodeScript>

    <!-- Optional NodeRenderers (main, left or right auxilliary renderers ) -->
    <NodeRenderer position="[LEFT|MAIN|RIGHT]" 
                     class="[ class of com.raritantechnologies.utils.tree.ITreeNodeRenderer ]" >

    </NodeRenderer>

    <!-- Optional Display String filter for modifications to node display -->
    <NodeNameFilter class="[ class of IStringFilter ]" >

    </NodeNameFilter>

    <LinkRenderer class="[ class of com.raritantechnologies.utils.tree.ITreeNodeHyperlinkRenderer ]" >

    </LinkRenderer>

  </TreeRenderer>

 

Developed by Raritan Technologies Inc..

Author:

Kepler Gelotte, Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.tree.taglibrary.ITreeRenderer

AT_LEFT, AT_RIGHT

Constructor Summary

ExploreTreeRenderer()

ExploreTreeRenderer(TreeRoot root)

Method Summary

void	addNodeRenderer(ITreeNodeRenderer nodeRenderer, int position) Adds an auxilliary TreeNodeRenderer - at left or right position to main node renderer.
java.lang.String	closeNodes(int level, int closeLevel, TreeNode node)
java.lang.String	closeNodes(int closeLevel, TreeNode node)
java.lang.String	closeNodes(TreeNode node)
java.lang.String	getHyperlink(java.lang.String treeName, TreeNode treeNode, java.lang.String treeURL, RaritanPageContext rpc)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
java.lang.String	renderTree()
java.lang.String	renderTree(TreeNode tree, RaritanPageContext rpc)
java.lang.String	renderTree(TreeNode tree, java.lang.String treeURL)
java.lang.String	renderTree(TreeNode tree, java.lang.String treeURL, RaritanPageContext rpc)
java.lang.String	renderTree(TreeNode tree, java.lang.String treeURL, java.lang.String treeTarget)
java.lang.String	renderTree(TreeNode tree, java.lang.String treeURL, java.lang.String treeTarget, RaritanPageContext rpc)
java.lang.String	renderTree(TreeRoot tree, java.lang.String treeURL, RaritanPageContext rpc)
java.lang.String	renderTree(TreeRoot tree, java.lang.String treeURL, RaritanPageContext rpc, java.lang.String initialState)
void	setAction(java.lang.String action)
void	setActiveNodeID(java.lang.String activeNodeID)
void	setActiveNodeParameter(java.lang.String activeNodeParameter)
void	setBlankImgURL(java.lang.String url)
void	setClosedImgURL(java.lang.String url)
void	setCloseNodeStates(java.lang.String states)
void	setCurrentPath(java.lang.String path)
void	setExpandCurrentNode(java.lang.String flag)
void	setField(java.lang.String field)
void	setLastImgClosedURL(java.lang.String url)
void	setLastImgOpenURL(java.lang.String url)
void	setLastImgURL(java.lang.String url)
void	setLineImgURL(java.lang.String url)
void	setNodeHyperlinkParameters(OrderedMap nodeParameters)
void	setNodeHyperlinkRenderer(ITreeNodeHyperlinkRenderer nodeRenderer)
void	setNodeHyperlinkRenderer(java.lang.String rendererClass) Sets the ITreeNodeHyperlinkRenderer class
void	setNodeRenderer(ITreeNodeRenderer treeNodeRenderer) Replaces the main node rendering with an external Node Renderer.
void	setNodeStates(java.lang.String states)
void	setOpenImgURL(java.lang.String url)
void	setParameter(java.lang.String name, java.lang.String value)
void	setPrefix(java.lang.String prefix)
void	setQuery(java.lang.String query)
void	setRenderRoot(boolean renderRoot)
void	setShowCounts(boolean showCounts)
void	setTarget(java.lang.String target)
void	setTreeState(TreeRoot tree, RaritanPageContext rpc)
void	setWindow(java.lang.String window)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExploreTreeRenderer

public ExploreTreeRenderer()

ExploreTreeRenderer

public ExploreTreeRenderer(TreeRoot root)

Method Detail

renderTree

public java.lang.String renderTree(TreeRoot tree,
                                   java.lang.String treeURL,
                                   RaritanPageContext rpc,
                                   java.lang.String initialState)

Specified by:

renderTree in interface ITreeRenderer

renderTree

public java.lang.String renderTree(TreeRoot tree,
                                   java.lang.String treeURL,
                                   RaritanPageContext rpc)

Specified by:

renderTree in interface ITreeRenderer

renderTree

public java.lang.String renderTree(TreeNode tree,
                                   java.lang.String treeURL)

Specified by:

renderTree in interface ITreeRenderer

renderTree

public java.lang.String renderTree(TreeNode tree,
                                   java.lang.String treeURL,
                                   RaritanPageContext rpc)

Specified by:

renderTree in interface ITreeRenderer

renderTree

public java.lang.String renderTree(TreeNode tree,
                                   java.lang.String treeURL,
                                   java.lang.String treeTarget)

Specified by:

renderTree in interface ITreeRenderer

renderTree

public java.lang.String renderTree(TreeNode tree,
                                   java.lang.String treeURL,
                                   java.lang.String treeTarget,
                                   RaritanPageContext rpc)

Specified by:

renderTree in interface ITreeRenderer

getHyperlink

public java.lang.String getHyperlink(java.lang.String treeName,
                                     TreeNode treeNode,
                                     java.lang.String treeURL,
                                     RaritanPageContext rpc)

Specified by:

getHyperlink in interface ITreeRenderer

setNodeHyperlinkRenderer

public void setNodeHyperlinkRenderer(java.lang.String rendererClass)

Sets the ITreeNodeHyperlinkRenderer class

Specified by:

setNodeHyperlinkRenderer in interface ITreeRenderer

setNodeHyperlinkRenderer

public void setNodeHyperlinkRenderer(ITreeNodeHyperlinkRenderer nodeRenderer)

Specified by:

setNodeHyperlinkRenderer in interface ITreeRenderer

setNodeHyperlinkParameters

public void setNodeHyperlinkParameters(OrderedMap nodeParameters)

Specified by:

setNodeHyperlinkParameters in interface ITreeRenderer

setNodeRenderer

public void setNodeRenderer(ITreeNodeRenderer treeNodeRenderer)

Description copied from interface: ITreeRenderer

Replaces the main node rendering with an external Node Renderer.

Specified by:

setNodeRenderer in interface ITreeRenderer

addNodeRenderer

public void addNodeRenderer(ITreeNodeRenderer nodeRenderer,
                            int position)

Description copied from interface: ITreeRenderer

Adds an auxilliary TreeNodeRenderer - at left or right position to main node renderer.

Specified by:

addNodeRenderer in interface ITreeRenderer

renderTree

public java.lang.String renderTree()

renderTree

public java.lang.String renderTree(TreeNode tree,
                                   RaritanPageContext rpc)

setExpandCurrentNode

public void setExpandCurrentNode(java.lang.String flag)

setField

public void setField(java.lang.String field)

setPrefix

public void setPrefix(java.lang.String prefix)

setCurrentPath

public void setCurrentPath(java.lang.String path)

setAction

public void setAction(java.lang.String action)

setWindow

public void setWindow(java.lang.String window)

setTarget

public void setTarget(java.lang.String target)

setQuery

public void setQuery(java.lang.String query)

setNodeStates

public void setNodeStates(java.lang.String states)

setCloseNodeStates

public void setCloseNodeStates(java.lang.String states)

setRenderRoot

public void setRenderRoot(boolean renderRoot)

setShowCounts

public void setShowCounts(boolean showCounts)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

setTreeState

public void setTreeState(TreeRoot tree,
                         RaritanPageContext rpc)

Specified by:

setTreeState in interface ITreeRenderer

setActiveNodeID

public void setActiveNodeID(java.lang.String activeNodeID)

Specified by:

setActiveNodeID in interface ITreeRenderer

closeNodes

public java.lang.String closeNodes(TreeNode node)

closeNodes

public java.lang.String closeNodes(int closeLevel,
                                   TreeNode node)

closeNodes

public java.lang.String closeNodes(int level,
                                   int closeLevel,
                                   TreeNode node)

setClosedImgURL

public void setClosedImgURL(java.lang.String url)

Specified by:

setClosedImgURL in interface ITreeRenderer

setOpenImgURL

public void setOpenImgURL(java.lang.String url)

Specified by:

setOpenImgURL in interface ITreeRenderer

setBlankImgURL

public void setBlankImgURL(java.lang.String url)

Specified by:

setBlankImgURL in interface ITreeRenderer

setLineImgURL

public void setLineImgURL(java.lang.String url)

Specified by:

setLineImgURL in interface ITreeRenderer

setLastImgURL

public void setLastImgURL(java.lang.String url)

Specified by:

setLastImgURL in interface ITreeRenderer

setLastImgOpenURL

public void setLastImgOpenURL(java.lang.String url)

Specified by:

setLastImgOpenURL in interface ITreeRenderer

setLastImgClosedURL

public void setLastImgClosedURL(java.lang.String url)

Specified by:

setLastImgClosedURL in interface ITreeRenderer

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

setActiveNodeParameter

public void setActiveNodeParameter(java.lang.String activeNodeParameter)