|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.util.JSONEncoder
public class JSONEncoder
Class for encoding objects as JSON strings.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
JSONEncoder()
|
|
JSONEncoder(JavaScriptObject jsObj)
|
Method Summary | |
---|---|
String |
encode(Object object)
Serialize an object as a JSON string. |
String |
encodeDate(Date theDate)
Encode a JavaScript Date value. |
String |
getCircularReferenceMarker()
The string marker used to represent circular references. |
JSONCircularReferenceMode |
getCircularReferenceMode()
What the JSONEncoder should do if it encounters a circular reference. |
JSONDateFormat |
getDateFormat()
Format for encoding JavaScript Date values in JSON. |
static JSONEncoder |
getOrCreateRef(JavaScriptObject jsObj)
|
Boolean |
getPrettyPrint()
Whether to add indentation to the returned JSON string. |
Boolean |
getStrictQuoting()
Whether all property names should be quoted, or only those property names that are not valid identifiers or are JavaScript reserved words (such as "true"). |
void |
setCircularReferenceMarker(String circularReferenceMarker)
The string marker used to represent circular references. |
void |
setCircularReferenceMode(JSONCircularReferenceMode circularReferenceMode)
What the JSONEncoder should do if it encounters a circular reference. |
void |
setDateFormat(JSONDateFormat dateFormat)
Format for encoding JavaScript Date values in JSON. |
void |
setPrettyPrint(Boolean prettyPrint)
Whether to add indentation to the returned JSON string. |
void |
setStrictQuoting(Boolean strictQuoting)
Whether all property names should be quoted, or only those property names that are not valid identifiers or are JavaScript reserved words (such as "true"). |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JSONEncoder()
public JSONEncoder(JavaScriptObject jsObj)
Method Detail |
---|
public static JSONEncoder getOrCreateRef(JavaScriptObject jsObj)
public void setDateFormat(JSONDateFormat dateFormat)
JSONDateFormat
for valid
options, or override encodeDate(java.util.Date)
to do something custom.
dateFormat
- dateFormat Default value is "xmlSchema"public JSONDateFormat getDateFormat()
JSONDateFormat
for valid
options, or override encodeDate(java.util.Date)
to do something custom.
public void setStrictQuoting(Boolean strictQuoting)
Encoding only where required produces slightly shorter, more readable output which is still compatible with JavaScript's eval():
{ someProp : "someValue", "true" : "otherValue", otherProp : "otherValue" }.. but is not understood by many server-side JSON parser implementations.
strictQuoting
- strictQuoting Default value is truepublic Boolean getStrictQuoting()
Encoding only where required produces slightly shorter, more readable output which is still compatible with JavaScript's eval():
{ someProp : "someValue", "true" : "otherValue", otherProp : "otherValue" }.. but is not understood by many server-side JSON parser implementations.
public void setCircularReferenceMode(JSONCircularReferenceMode circularReferenceMode)
circularReferenceMode
- circularReferenceMode Default value is "path"public JSONCircularReferenceMode getCircularReferenceMode()
public void setCircularReferenceMarker(String circularReferenceMarker)
circularReferenceMode
.
circularReferenceMarker
- circularReferenceMarker Default value is "$$BACKREF$$"public String getCircularReferenceMarker()
circularReferenceMode
.
public void setPrettyPrint(Boolean prettyPrint)
prettyPrint
- prettyPrint Default value is truepublic Boolean getPrettyPrint()
public String encode(Object object)
object
- object to serialize
public String encodeDate(Date theDate)
By default, follows the dateFormat
setting. Override to do custom encoding.
theDate
- JavaScript date object to be serialized
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |