|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmAnchorTree
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 |
protected java.util.List rootNodes
protected java.lang.String selectedID
protected boolean honorCollapsed
Constructor Detail |
public WcmAnchorTree()
Method Detail |
public void initialize() throws java.lang.Exception
WcmModuleInterface
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
public boolean setHonorCollapsed(boolean newValue)
newValue
-
public void addRootNode(WcmTreeNode a)
a
- A new WcmTreeNode node to be added to the WcmAnchorTree root node.public void addRootNodes(java.util.List newRootNodes)
public void setSelectedNode(java.lang.String id)
id
- The node id of a WcmTreeNode to be selected.public void setSelectedNode(WcmTreeNode a)
a
- The WcmTreeNode that is going to be selected.public java.lang.String getSelectedNode()
public java.util.List getRootNodes()
public WcmTreeNode addChildNode(java.lang.String parentId, WcmString label, java.lang.String url, java.lang.String id)
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.
public void addSpacer()
public WcmTreeNode addRootNode(WcmString label)
label
- The label of the new root node.
public WcmTreeNode addRootNode(java.lang.String url, WcmString label)
url
- The URL value of the new root node.label
- The label of new root node.
public WcmTreeNode addRootNode(java.lang.String url, WcmString label, java.lang.String id)
url
- The URL value of the new root node.label
- The label of new root node.id
- The id of new root node.
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
render
in class WcmUiModule
w
- Writer object to write the output to.
java.lang.Exception
- All errors.protected abstract void renderOpeningHTML(java.io.Writer w) throws java.lang.Exception
w
- Writer object to write the output to.
java.lang.Exception
- All errors.protected abstract void renderClosingHTML(java.io.Writer w) throws java.lang.Exception
w
- Writer object to write the output to.
java.lang.Exception
- All errors.protected abstract void renderNode(java.io.Writer w, WcmTreeNode node, int depth) throws java.lang.Exception
w
- Writer object to write the output to.node
- The WcmTreeNode to be rendered.depth
- The depth of the selected node in the WcmAnchorTree.
java.lang.Exception
- All errors.public WcmTreeNode findNode(java.lang.String id)
id
- The node id.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |