com.filenet.wcm.toolkit.server.ui
Class WcmAnchorTree

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmAnchorTree
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface

public abstract class WcmAnchorTree
extends WcmUiModule

Primitive UI module that represents a tree structure of WcmAnchor objects.


Field Summary
protected  boolean honorCollapsed
           
protected  java.util.List rootNodes
           
protected  java.lang.String selectedID
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmAnchorTree()
           
 
Method Summary
 WcmTreeNode addChildNode(java.lang.String parentId, WcmString label, java.lang.String url, java.lang.String id)
          Adds a new child node to the selected parent node by creating a new WcmTreeNode node from the parameter values.
 WcmTreeNode addRootNode(java.lang.String url, WcmString label)
          Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the url and label parameters.
 WcmTreeNode addRootNode(java.lang.String url, WcmString label, java.lang.String id)
          Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the url, label and id parameters.
 WcmTreeNode addRootNode(WcmString label)
          Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the label parameter.
 void addRootNode(WcmTreeNode a)
          Adds a new WcmTreeNode node as a root node to the WcmAnchorTree.
 void addRootNodes(java.util.List newRootNodes)
           
 void addSpacer()
          Adds new spacer node as a root node to the WcmAnchorTree.
 WcmTreeNode findNode(java.lang.String id)
          Helper method to find the a WcmTreeNode in the WcmAnchorTree based on the node id.
 java.util.List getRootNodes()
          Returns the list of root nodes.
 java.lang.String getSelectedNode()
          Returns id of the selected WcmTreeNode node.
 void initialize()
          Called by WcmController when the module is registered, and has access to the data store.
 void render(java.io.Writer w)
          Renders the WcmAnchorTree HTML.
protected abstract  void renderClosingHTML(java.io.Writer w)
          This method may be defined in an implementation of WcmAnchorTree to render any HTML needed after the rendering of the WcmTreeNode node.
protected abstract  void renderNode(java.io.Writer w, WcmTreeNode node, int depth)
          This method may be defined in an implementation of WcmAnchorTree to render the HTML of the WcmTreeNode node in the WcmAnchorTree.
protected abstract  void renderOpeningHTML(java.io.Writer w)
          This method may be defined in an implementation of WcmAnchorTree to render any HTML needed before the rendering of the WcmTreeNode node.
 boolean setHonorCollapsed(boolean newValue)
          Controls the callback based rendering support.
 void setSelectedNode(java.lang.String id)
          Sets the selected WcmTreeNode node to the node with the specified id.
 void setSelectedNode(WcmTreeNode a)
          Sets the selected WcmTreeNode node to the specified WcmTreeNode node.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

rootNodes

protected java.util.List rootNodes

selectedID

protected java.lang.String selectedID

honorCollapsed

protected boolean honorCollapsed
Constructor Detail

WcmAnchorTree

public WcmAnchorTree()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Description copied from interface: WcmModuleInterface
Called by WcmController when the module is registered, and has access to the data store. Do "constructor" types of things here.

Specified by:
initialize in interface WcmModuleInterface
Overrides:
initialize in class WcmModule
Throws:
java.lang.Exception

setHonorCollapsed

public boolean setHonorCollapsed(boolean newValue)
Controls the callback based rendering support. When set to true, if a node's collapsed flag is set to true, rendering will not recurse to the next level. When set to false, the tree will be fully recursed regardless of any node's collapsed flag.

Parameters:
newValue -
Returns:
the previous value.

addRootNode

public void addRootNode(WcmTreeNode a)
Adds a new WcmTreeNode node as a root node to the WcmAnchorTree.

Parameters:
a - A new WcmTreeNode node to be added to the WcmAnchorTree root node.

addRootNodes

public void addRootNodes(java.util.List newRootNodes)

setSelectedNode

public void setSelectedNode(java.lang.String id)
Sets the selected WcmTreeNode node to the node with the specified id.

Parameters:
id - The node id of a WcmTreeNode to be selected.

setSelectedNode

public void setSelectedNode(WcmTreeNode a)
Sets the selected WcmTreeNode node to the specified WcmTreeNode node.

Parameters:
a - The WcmTreeNode that is going to be selected.

getSelectedNode

public java.lang.String getSelectedNode()
Returns id of the selected WcmTreeNode node.

Returns:
String The id of the selected WcmTreeNode node.

getRootNodes

public java.util.List getRootNodes()
Returns the list of root nodes.

Returns:
List The root node list.

addChildNode

public WcmTreeNode addChildNode(java.lang.String parentId,
                                WcmString label,
                                java.lang.String url,
                                java.lang.String id)
Adds a new child node to the selected parent node by creating a new WcmTreeNode node from the parameter values. If the parent node wasn't found, then the new child node will be added as a root node.

Parameters:
parentId - The id of the parent node.
label - The label of WcmTreeNode to create and add to parent tree.
url - The URL value of the new WcmTreeNode child node.
id - The id of the new WcmTreeNode child node.
Returns:
WcmTreeNode The newly created child node.

addSpacer

public void addSpacer()
Adds new spacer node as a root node to the WcmAnchorTree.


addRootNode

public WcmTreeNode addRootNode(WcmString label)
Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the label parameter.

Parameters:
label - The label of the new root node.
Returns:
WcmTreeNode The new root node.

addRootNode

public WcmTreeNode addRootNode(java.lang.String url,
                               WcmString label)
Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the url and label parameters.

Parameters:
url - The URL value of the new root node.
label - The label of new root node.
Returns:
WcmTreeNode The new root node.

addRootNode

public WcmTreeNode addRootNode(java.lang.String url,
                               WcmString label,
                               java.lang.String id)
Adds a new root node to the WcmAnchorTree by creating a new WcmTreeNode from the url, label and id parameters.

Parameters:
url - The URL value of the new root node.
label - The label of new root node.
id - The id of new root node.
Returns:
WcmTreeNode The new root node.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the WcmAnchorTree HTML.

Specified by:
render in interface WcmUiModuleInterface
Overrides:
render in class WcmUiModule
Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

renderOpeningHTML

protected abstract void renderOpeningHTML(java.io.Writer w)
                                   throws java.lang.Exception
This method may be defined in an implementation of WcmAnchorTree to render any HTML needed before the rendering of the WcmTreeNode node. The default implementation does nothing.

Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

renderClosingHTML

protected abstract void renderClosingHTML(java.io.Writer w)
                                   throws java.lang.Exception
This method may be defined in an implementation of WcmAnchorTree to render any HTML needed after the rendering of the WcmTreeNode node. The default implementation does nothing.

Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

renderNode

protected abstract void renderNode(java.io.Writer w,
                                   WcmTreeNode node,
                                   int depth)
                            throws java.lang.Exception
This method may be defined in an implementation of WcmAnchorTree to render the HTML of the WcmTreeNode node in the WcmAnchorTree. The default implementation does nothing.

Parameters:
w - Writer object to write the output to.
node - The WcmTreeNode to be rendered.
depth - The depth of the selected node in the WcmAnchorTree.
Throws:
java.lang.Exception - All errors.

findNode

public WcmTreeNode findNode(java.lang.String id)
Helper method to find the a WcmTreeNode in the WcmAnchorTree based on the node id.

Parameters:
id - The node id.
Returns:
WcmTreeNode The WcmTreeNode node thas has the specified id.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.