com.flexive.faces.javascript.tree

Class TreeNodeWriter

java.lang.Object

com.flexive.faces.javascript.tree.TreeNodeWriter

public class TreeNodeWriter
extends java.lang.Object

A basic writer for tree nodes for the Dojo tree (V3).

Version:

$Rev: 2919 $

Author:

Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeNodeWriter.Node A single tree node.
static interface	TreeNodeWriter.NodeFormatter Formats the label of a given tree node, e.g.

Field Summary

Fields

Modifier and Type	Field and Description
static TreeNodeWriter.NodeFormatter	FORMAT_ADMINTREE Format the node using the default style for the admin backend trees.
static TreeNodeWriter.NodeFormatter	FORMAT_CONTENTTREE
static TreeNodeWriter.NodeFormatter	FORMAT_PLAIN Plain node formatter.

Constructor Summary

Constructors

Constructor and Description
TreeNodeWriter(com.flexive.war.JsonWriter out, RelativeUriMapper uriMapper, TreeNodeWriter.NodeFormatter formatter) Create a new TreeNodeWriter using an existing JsonWriter.
TreeNodeWriter(java.io.Writer out, RelativeUriMapper uriMapper, TreeNodeWriter.NodeFormatter formatter) Create a new TreeNodeWriter for the given output writer.

Method Summary

Modifier and Type	Method and Description
void	closeChildren() Close the child nodes array previously created with startChildren().
void	closeNode() Close a node previously opened with startNode(com.flexive.faces.javascript.tree.TreeNodeWriter.Node).
void	finishResponse() Closes the tree structure.
void	startChildren() Prepare the current node (created with startNode(com.flexive.faces.javascript.tree.TreeNodeWriter.Node) for appending of nested child nodes.
void	startNode(TreeNodeWriter.Node node) Start a new node without closing it.
void	writeNode(TreeNodeWriter.Node node) Render a leaf node.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_PLAIN

public static final TreeNodeWriter.NodeFormatter FORMAT_PLAIN

Plain node formatter. Icons may be rendered using the TreeDocIconExtension and specifying matching CSS classes. Preferred to FORMAT_ADMINTREE if inline node editing is required.

FORMAT_ADMINTREE

public static final TreeNodeWriter.NodeFormatter FORMAT_ADMINTREE

Format the node using the default style for the admin backend trees.

FORMAT_CONTENTTREE

public static final TreeNodeWriter.NodeFormatter FORMAT_CONTENTTREE

Constructor Detail

TreeNodeWriter

public TreeNodeWriter(com.flexive.war.JsonWriter out,
                      RelativeUriMapper uriMapper,
                      TreeNodeWriter.NodeFormatter formatter)
               throws java.io.IOException

Create a new TreeNodeWriter using an existing JsonWriter.

Parameters:

out - the JsonWriter instance to be used

uriMapper - URI Mapper to use

formatter - the default formatter to be used

Throws:

java.io.IOException - if the output could not be written

TreeNodeWriter

public TreeNodeWriter(java.io.Writer out,
                      RelativeUriMapper uriMapper,
                      TreeNodeWriter.NodeFormatter formatter)
               throws java.io.IOException

Create a new TreeNodeWriter for the given output writer.

Parameters:

out - an output writer.

uriMapper - URI Mapper to use

formatter - the default node formatter to be used

Throws:

java.io.IOException - if the output could not be written

Method Detail

finishResponse

public void finishResponse()
                    throws java.io.IOException

Closes the tree structure. No nodes can be appended to the generated tree afterwards.

Throws:

java.io.IOException - if the output could not be written

startNode

public void startNode(TreeNodeWriter.Node node)
               throws java.io.IOException

Start a new node without closing it. Additional parameters and nested child nodes may be appended in subsequent calls. The node must be closed with a call to closeNode().

Parameters:

node - the node to be written

Throws:

java.io.IOException - if the output could not be written

closeNode

public void closeNode()
               throws java.io.IOException

Close a node previously opened with startNode(com.flexive.faces.javascript.tree.TreeNodeWriter.Node).

Throws:

java.io.IOException - if the output could not be written

writeNode

public void writeNode(TreeNodeWriter.Node node)
               throws java.io.IOException

Render a leaf node.

Parameters:

node - the node to be rendered

Throws:

java.io.IOException - if the output could not be written

startChildren

public void startChildren()
                   throws java.io.IOException

Prepare the current node (created with startNode(com.flexive.faces.javascript.tree.TreeNodeWriter.Node) for appending of nested child nodes.

Throws:

java.io.IOException - if the output could not be written

closeChildren

public void closeChildren()
                   throws java.io.IOException

Close the child nodes array previously created with startChildren().

Throws:

java.io.IOException - if the output could not be written