Package org.primefaces.extensions.util

Class JavascriptVarBuilder

java.lang.Object

org.primefaces.extensions.util.JavascriptVarBuilder

public class JavascriptVarBuilder
extends java.lang.Object

Builds a JavaScript var object or array string. A simple way to generalized a lot of code used in renderers.

Since:

6.2

Author:

Mark Lassiter / Melloware

Constructor Summary

Constructors

Constructor	Description
JavascriptVarBuilder(java.lang.String varName, boolean isObject)	Constructs an instance of the builder.

Method Summary

Modifier and Type	Method	Description
JavascriptVarBuilder	appendArrayValue(java.lang.String value, boolean quoted)	Appends an array value.
JavascriptVarBuilder	appendProperty(java.lang.String propertyName, java.lang.String propertyValue, boolean quoted)	Appends an Object name/value pair to the object.
JavascriptVarBuilder	appendRowColProperty(int row, int col, java.lang.String propertyValue, boolean quoted)	appends a property with the name "rYY_cXX" where YY is the row and XX is he column.
JavascriptVarBuilder	appendText(java.lang.String value, boolean quoted)	Appends text to the var string
JavascriptVarBuilder	closeVar()	Closes the array or object.
java.lang.String	toString()	Returns the string for the var.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavascriptVarBuilder

public JavascriptVarBuilder(java.lang.String varName,
                            boolean isObject)

Constructs an instance of the builder.

Parameters:

varName - the variable name

isObject - true if build an Object, false if an array.

Method Detail

appendProperty

public JavascriptVarBuilder appendProperty(java.lang.String propertyName,
                                           java.lang.String propertyValue,
                                           boolean quoted)

Appends an Object name/value pair to the object.

Parameters:

propertyName - the property name

propertyValue - the property value

quoted - if true, the value is quoted and escaped.

Returns:

this builder

appendRowColProperty

public JavascriptVarBuilder appendRowColProperty(int row,
                                                 int col,
                                                 java.lang.String propertyValue,
                                                 boolean quoted)

appends a property with the name "rYY_cXX" where YY is the row and XX is he column.

Parameters:

row -

col -

propertyValue -

quoted -

Returns:

appendText

public JavascriptVarBuilder appendText(java.lang.String value,
                                       boolean quoted)

Appends text to the var string

Parameters:

value - the value to append

quoted - if true, the value is quoted and escaped.

Returns:

this builder

appendArrayValue

public JavascriptVarBuilder appendArrayValue(java.lang.String value,
                                             boolean quoted)

Appends an array value.

Parameters:

value -

quoted -

Returns:

closeVar

public JavascriptVarBuilder closeVar()

Closes the array or object.

Returns:

toString

public java.lang.String toString()

Returns the string for the var.

Overrides:

toString in class java.lang.Object