com.adobe.granite.ui.components

Class AttrBuilder

java.lang.Object

com.adobe.granite.ui.components.AttrBuilder

public class AttrBuilder
extends Object

A builder to generate HTML attributes. This builder is designed to be secured using XSSAPI. It will encode the value automatically. If the value is null, it will be ignored.

Constructor Summary

Constructors

Constructor and Description
AttrBuilder(HttpServletRequest req, XSSAPI xssAPI)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String name, Boolean value) Adds attribute with the given name.
void	add(String name, Double value) Adds attribute with the given name.
void	add(String name, Integer value) Adds attribute with the given name.
void	add(String name, String value) Adds attribute with the given name.
void	addBoolean(String name, boolean value) Adds boolean attribute (behaves like disabled) for the given name.
void	addChecked(boolean checked) Adds checked attribute.
void	addClass(String value) Adds class attribute with the given value.
void	addDisabled(boolean disabled) Adds disabled attribute.
void	addHref(String name, String value) Adds an attribute that behave like href attribute.
void	addMultiple(boolean multiple) Adds multiple attribute.
void	addOther(String name, String value) Adds the given name as data-* attribute.
void	addOthers(Map<String,Object> data, String... exclusions) Adds the given data as data-* attributes.
void	addRel(String value) Adds relationship.
void	addSelected(boolean selected) Adds selected attribute.
String	build() Builds the attributes in the form of ( ='')*.
void	build(Writer out) Builds the attributes in the form of ( ='')*.
boolean	isEmpty() Returns true if there is no attribute in this builder; false otherwise.
void	set(String name, String value) Sets attribute with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttrBuilder

public AttrBuilder(HttpServletRequest req,
           XSSAPI xssAPI)

Method Detail

addRel

public void addRel(String value)

Adds relationship. Currently it is implemented as class attribute.

addClass

public void addClass(String value)

Adds class attribute with the given value.

addHref

public void addHref(String name,
           String value)

Adds an attribute that behave like href attribute. i.e. the value will be prepended with context path (if absolute path) and checked using XSSAPI#getValidHref(String).

addDisabled

public void addDisabled(boolean disabled)

Adds disabled attribute.

addChecked

public void addChecked(boolean checked)

Adds checked attribute.

addSelected

public void addSelected(boolean selected)

Adds selected attribute.

addMultiple

public void addMultiple(boolean multiple)

Adds multiple attribute.

addBoolean

public void addBoolean(String name,
              boolean value)

Adds boolean attribute (behaves like disabled) for the given name. When the given value is true, it will be printed as "disabled='disabled'", instead of "disabled='true'". When the given value is false, it will NOT be printed, instead of "disabled='false'".

addOther

public void addOther(String name,
            String value)

Adds the given name as data-* attribute.

addOthers

public void addOthers(Map<String,Object> data,
             String... exclusions)

Adds the given data as data-* attributes. Entries with keys specified in exclusions parameter or having namespace (e.g. jcr:primaryType) will be excluded.

add

public void add(String name,
       Boolean value)

Adds attribute with the given name. The value will be added to existing attribute using space-delimited convention. e.g. class="class1 class2"

add

public void add(String name,
       Integer value)

Adds attribute with the given name. The value will be added to existing attribute using space-delimited convention. e.g. class="class1 class2"

add

public void add(String name,
       Double value)

Adds attribute with the given name. The value will be added to existing attribute using space-delimited convention. e.g. class="class1 class2"

add

public void add(String name,
       String value)

Adds attribute with the given name. The value will be added to existing attribute using space-delimited convention. e.g. class="class1 class2"

set

public void set(String name,
       String value)

Sets attribute with the given name. Existing value previously set will be replaced by the given value.

isEmpty

public boolean isEmpty()

Returns true if there is no attribute in this builder; false otherwise.

build

public String build()

Builds the attributes in the form of ( ='')*.

build

public void build(Writer out)
           throws IOException

Builds the attributes in the form of ( ='')*.

Throws:

IOException