net.sourceforge.ajaxtags.xml
Class AjaxTreeXmlBuilder

java.lang.Object
  net.sourceforge.ajaxtags.xml.BaseXmlBuilder<TreeItem>
      net.sourceforge.ajaxtags.xml.AjaxTreeXmlBuilder

public final class AjaxTreeXmlBuilder
extends BaseXmlBuilder<TreeItem>

Helper class to build valid XML, for the AjaxTreeTag, typically returned in a response to the client.

Nested Class Summary

static interface

AjaxTreeXmlBuilder.PropertyReader This interface is for reading properties for an easy use with tree tag in ajax

Constructor Summary

AjaxTreeXmlBuilder()

Method Summary

AjaxTreeXmlBuilder	addItem(AjaxTreeXmlBuilder.PropertyReader element)
AjaxTreeXmlBuilder	addItem(String name, String value) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItem(String name, String value, boolean asCData, Map<?,String> attributes) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItem(String name, String value, boolean collapsed, String url) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItem(String name, String value, boolean collapsed, String url, boolean asCData) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItem(String name, String value, Map<String,String> attributes) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItem(String name, String value, String url, boolean asCData) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItemAsCData(String name, String value) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItemAsCData(String name, String value, boolean collapsed, String url) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItemAsCData(String name, String value, Map<String,String> attributes) Add tree item to XML builder.
AjaxTreeXmlBuilder	addItems(Collection<AjaxTreeXmlBuilder.PropertyReader> collection)
protected String	getXMLString() Build an XML body to describe TreeItem.

Methods inherited from class net.sourceforge.ajaxtags.xml.BaseXmlBuilder

add, clear, get, getEncoding, getItems, getList, isEmpty, setEncoding, setList, size, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AjaxTreeXmlBuilder

public AjaxTreeXmlBuilder()

Method Detail

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value)

Add tree item to XML builder.

Parameters:

name - name

value - value

Returns:

AjaxTreeXmlBuilder XML builder

addItemAsCData

public AjaxTreeXmlBuilder addItemAsCData(String name,
                                         String value)

Add tree item to XML builder.

Parameters:

name - name

value - value

Returns:

AjaxTreeXmlBuilder XML builder

addItemAsCData

public AjaxTreeXmlBuilder addItemAsCData(String name,
                                         String value,
                                         Map<String,String> attributes)

Add tree item to XML builder.

Parameters:

name - name

value - value

attributes - attributes

Returns:

AjaxTreeXmlBuilder XML builder

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value,
                                  Map<String,String> attributes)

Add tree item to XML builder.

Parameters:

name - name

value - value

attributes - attributes

Returns:

AjaxTreeXmlBuilder XML builder

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value,
                                  boolean asCData,
                                  Map<?,String> attributes)

Add tree item to XML builder.

Parameters:

name - name

value - value

asCData - true if item must be present as CDATA

attributes - item attributes

Returns:

AjaxTreeXmlBuilder XML builder

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value,
                                  String url,
                                  boolean asCData)

Add tree item to XML builder.

Parameters:

name - name

value - value

url - URL

asCData - true if item must be present as CDATA

Returns:

AjaxTreeXmlBuilder XML builder

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value,
                                  boolean collapsed,
                                  String url)

Add tree item to XML builder.

Parameters:

name - name

value - value

collapsed - true if subtree is initially collapsed

url - URL

Returns:

AjaxTreeXmlBuilder XML builder

addItem

public AjaxTreeXmlBuilder addItem(String name,
                                  String value,
                                  boolean collapsed,
                                  String url,
                                  boolean asCData)

Add tree item to XML builder.

Parameters:

name - name

value - value

collapsed - true if subtree is initially collapsed

url - URL

asCData - true if item must be present as CDATA

Returns:

AjaxTreeXmlBuilder XML builder

addItemAsCData

public AjaxTreeXmlBuilder addItemAsCData(String name,
                                         String value,
                                         boolean collapsed,
                                         String url)

Add tree item to XML builder.

Parameters:

name - name

value - value

collapsed - true if subtree is initially collapsed

url - URL

Returns:

AjaxTreeXmlBuilder XML builder

addItems

public AjaxTreeXmlBuilder addItems(Collection<AjaxTreeXmlBuilder.PropertyReader> collection)

addItem

public AjaxTreeXmlBuilder addItem(AjaxTreeXmlBuilder.PropertyReader element)

getXMLString

protected String getXMLString()

Build an XML body to describe TreeItem.

Specified by:

getXMLString in class BaseXmlBuilder<TreeItem>

Returns:

the XML body, XML encoding is added by BaseXmlBuilder.toString()

See Also:

BaseXmlBuilder.getXMLString()