org.itsnat.core.script

Interface ScriptExpr

public interface ScriptExpr

Encapsulates a JavaScript expression used to generate JavaScript code to send the client.

If the expression have properties or methods this interface provides methods to generate JavaScript code to access or call them.

See Also:

ScriptUtil.createScriptExpr(Object)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCallMethodCode(java.lang.String methodName, java.lang.Object[] params) Generates the JavaScript code to call the specified method of the result of this expression.
java.lang.String	getCallMethodCode(java.lang.String methodName, java.lang.Object[] params, boolean endSentence) Generates the JavaScript code to call the specified method of the result of this expression.
java.lang.String	getCode() Returns the JavaScript code of this expression.
java.lang.String	getGetPropertyCode(java.lang.String propName) Generates the JavaScript code to get the value of the specified property of the result of this expression.
java.lang.String	getGetPropertyCode(java.lang.String propName, boolean endSentence) Generates the JavaScript code to get the value of the specified property of the result of this expression.
java.lang.String	getSetPropertyCode(java.lang.String propName, java.lang.Object value) Generates the JavaScript code to set a value to the specified property of the result of this expression.
java.lang.String	getSetPropertyCode(java.lang.String propName, java.lang.Object value, boolean endSentence) Generates the JavaScript code to set a value to the specified property of the result of this expression.

Method Detail

getCode

java.lang.String getCode()

Returns the JavaScript code of this expression.

The specified object is converted to JavaScript following the rules of ScriptUtil.toScript(Object) with an exception: if a String the content is not converted to a JavaScript string literal.

Returns:

the JavaScript code.

getSetPropertyCode

java.lang.String getSetPropertyCode(java.lang.String propName,
                                  java.lang.Object value,
                                  boolean endSentence)

Generates the JavaScript code to set a value to the specified property of the result of this expression.

Parameters:

propName - property name.

value - the value to set. Is converted to JavaScript calling ScriptUtil.toScript(Object).

endSentence - if true adds a ; at the end.

Returns:

the JavaScript code.

See Also:

ScriptUtil.getSetPropertyCode(Object,String,Object,boolean)

getSetPropertyCode

java.lang.String getSetPropertyCode(java.lang.String propName,
                                  java.lang.Object value)

Generates the JavaScript code to set a value to the specified property of the result of this expression.

Parameters:

propName - property name.

value - the value to set. Is converted to JavaScript calling ScriptUtil.toScript(Object).

Returns:

the JavaScript code.

See Also:

ScriptUtil.getSetPropertyCode(Object,String,Object)

getGetPropertyCode

java.lang.String getGetPropertyCode(java.lang.String propName,
                                  boolean endSentence)

Generates the JavaScript code to get the value of the specified property of the result of this expression.

Parameters:

propName - property name.

endSentence - if true adds a ; at the end.

Returns:

the JavaScript code.

See Also:

ScriptUtil.getGetPropertyCode(Object,String,boolean)

getGetPropertyCode

java.lang.String getGetPropertyCode(java.lang.String propName)

Generates the JavaScript code to get the value of the specified property of the result of this expression.

Parameters:

propName - property name.

Returns:

the JavaScript code.

See Also:

ScriptUtil.getGetPropertyCode(Object,String)

getCallMethodCode

java.lang.String getCallMethodCode(java.lang.String methodName,
                                 java.lang.Object[] params,
                                 boolean endSentence)

Generates the JavaScript code to call the specified method of the result of this expression.

Parameters:

methodName - method name.

params - the parameter list. Are converted to JavaScript calling ScriptUtil.toScript(Object).

endSentence - if true adds a ; at the end.

Returns:

the JavaScript code.

See Also:

ScriptUtil.getCallMethodCode(Object,String,Object[],boolean)

getCallMethodCode

java.lang.String getCallMethodCode(java.lang.String methodName,
                                 java.lang.Object[] params)

Generates the JavaScript code to call the specified method of the result of this expression.

Parameters:

methodName - method name.

params - the parameter list. Are converted to JavaScript calling ScriptUtil.toScript(Object).

Returns:

the JavaScript code.

See Also:

ScriptUtil.getCallMethodCode(Object,String,Object[])