Packagetwaver
Classpublic class SerializationSettings
InheritanceSerializationSettings Inheritance Object

This is a class wrapps all setting parameters for XML serialization. Class XMLSerializer use this setting class to store all serializable parameters for convenience.



Public Properties
 PropertyDefined By
  clientSerializable : Boolean
Value indicates whether client properties of all data contains in the connected data box are serializable.
SerializationSettings
  dataBoxSerializable : Boolean
Value indicates whether the connected data box is serializable.
SerializationSettings
  globalClientSerializable : Boolean = true
[static] Static value defination for the global setting that indicates whether all client properties of data are serializable in TWaver Flex.
SerializationSettings
  globalDataBoxSerializable : Boolean = true
[static] Static value defination for the global setting that indicates whether all data boxes are serializable in TWaver Flex.
SerializationSettings
  globalLayerBoxSerializable : Boolean = true
[static] Static value defination for the global setting that indicates whether all layer box are serializable in TWaver Flex.
SerializationSettings
  globalStyleSerializable : Boolean = true
[static] Static value defination for the global setting that indicates whether all style properties of data are serializable in TWaver Flex.
SerializationSettings
  layerBoxSerializable : Boolean
Value indicates whether layer box of the connected data box is serializable.
SerializationSettings
  styleSerializable : Boolean
Value indicates whether style properties of all data contains in the connected data box are serializable.
SerializationSettings
Public Methods
 MethodDefined By
  
getClientType(clientProp:String):String
Get specified client property's class type.
SerializationSettings
  
getGlobalClientType(clientProp:String):String
[static] Get specified global registered user client prperty's class type.
SerializationSettings
  
getGlobalPropertyType(property:String):String
[static] Get the specified registered global property's class type.
SerializationSettings
  
getGlobalStyleType(styleProp:String):String
[static] Get the global stype's class type.
SerializationSettings
  
getPropertyType(property:String):String
Get class type for the specified property.
SerializationSettings
  
getStyleType(styleProp:String):String
Get style property's class type.
SerializationSettings
  
isClientCdata(property:String):Boolean
Check whether specified client property is CDATA XML style.
SerializationSettings
  
isGlobalClientCdata(property:String):Boolean
[static] Check whether specified client property is a global defined CDATA XML style.
SerializationSettings
  
isGlobalPropertyCdata(property:String):Boolean
[static] Check whether specified property is a global defined CDATA XML style property.
SerializationSettings
  
isGlobalStyleCdata(property:String):Boolean
[static] Check whether specified property is a global defined CDATA XML style.
SerializationSettings
  
isPropertyCdata(property:String):Boolean
Check whether specified property is CDATA XML style.
SerializationSettings
  
isStyleCdata(property:String):Boolean
Check whether specified style property is CDATA XML style.
SerializationSettings
  
registerClient(clientProp:String, type:String, cdata:Boolean = false):void
Register a client property into this settings.
SerializationSettings
  
registerGlobalClient(clientProp:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void
[static] Register a global client property into TWaver Flex.
SerializationSettings
  
registerGlobalProperty(property:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void
[static] Register a global property.
SerializationSettings
  
registerGlobalStyle(styleProp:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void
[static] Register a global style into TWaver Flex to use in XML serialzation.
SerializationSettings
  
registerProperty(property:String, type:String, cdata:Boolean = false):void
Register a property into this settings.
SerializationSettings
  
registerStyle(styleProp:String, type:String, cdata:Boolean = false):void
Register a style property into this settings.
SerializationSettings
Property Detail
clientSerializableproperty
public var clientSerializable:Boolean

Value indicates whether client properties of all data contains in the connected data box are serializable.

dataBoxSerializableproperty 
public var dataBoxSerializable:Boolean

Value indicates whether the connected data box is serializable.

globalClientSerializableproperty 
public static var globalClientSerializable:Boolean = true

Static value defination for the global setting that indicates whether all client properties of data are serializable in TWaver Flex.

globalDataBoxSerializableproperty 
public static var globalDataBoxSerializable:Boolean = true

Static value defination for the global setting that indicates whether all data boxes are serializable in TWaver Flex.

globalLayerBoxSerializableproperty 
public static var globalLayerBoxSerializable:Boolean = true

Static value defination for the global setting that indicates whether all layer box are serializable in TWaver Flex.

globalStyleSerializableproperty 
public static var globalStyleSerializable:Boolean = true

Static value defination for the global setting that indicates whether all style properties of data are serializable in TWaver Flex.

layerBoxSerializableproperty 
public var layerBoxSerializable:Boolean

Value indicates whether layer box of the connected data box is serializable.

styleSerializableproperty 
public var styleSerializable:Boolean

Value indicates whether style properties of all data contains in the connected data box are serializable.

Method Detail
getClientType()method
public function getClientType(clientProp:String):String

Get specified client property's class type.

Parameters

clientProp:String — the client property name to be checked

Returns
String — the class type of this client property.
getGlobalClientType()method 
public static function getGlobalClientType(clientProp:String):String

Get specified global registered user client prperty's class type.

Parameters

clientProp:String — the client property name to be checked.

Returns
String — the class type of this client property.
getGlobalPropertyType()method 
public static function getGlobalPropertyType(property:String):String

Get the specified registered global property's class type.

Parameters

property:String — the property name need to get.

Returns
String — the class type of this property.
getGlobalStyleType()method 
public static function getGlobalStyleType(styleProp:String):String

Get the global stype's class type.

Parameters

styleProp:String — the style property

Returns
String — the class type of thespecified style property.
getPropertyType()method 
public function getPropertyType(property:String):String

Get class type for the specified property.

Parameters

property:String — the property name to be checked.

Returns
String — the class type of this property.
getStyleType()method 
public function getStyleType(styleProp:String):String

Get style property's class type.

Parameters

styleProp:String — the style property name.

Returns
String — the class type of this style property.
isClientCdata()method 
public function isClientCdata(property:String):Boolean

Check whether specified client property is CDATA XML style.

Parameters

property:String — the client property name to be checked.

Returns
Boolean — true if CDATA XML style, false otherwise.
isGlobalClientCdata()method 
public static function isGlobalClientCdata(property:String):Boolean

Check whether specified client property is a global defined CDATA XML style.

Parameters

property:String — the client property name to be checked.

Returns
Boolean — true if this is a global defined CDATA XML style client property, false otherwise.
isGlobalPropertyCdata()method 
public static function isGlobalPropertyCdata(property:String):Boolean

Check whether specified property is a global defined CDATA XML style property.

Parameters

property:String — the property name need to check.

Returns
Boolean — true if this property is CDATA XML style type, false otherwise.
isGlobalStyleCdata()method 
public static function isGlobalStyleCdata(property:String):Boolean

Check whether specified property is a global defined CDATA XML style.

Parameters

property:String — the style property name to be checked.

Returns
Boolean — true if this is a global defined CDATA XML style, false otherwise
isPropertyCdata()method 
public function isPropertyCdata(property:String):Boolean

Check whether specified property is CDATA XML style.

Parameters

property:String — property name to be checked.

Returns
Boolean — true if CDATA XML style, false otherwise.
isStyleCdata()method 
public function isStyleCdata(property:String):Boolean

Check whether specified style property is CDATA XML style.

Parameters

property:String — the style property to be checked.

Returns
Boolean — true if CDATA XML style, false otherwise.
registerClient()method 
public function registerClient(clientProp:String, type:String, cdata:Boolean = false):void

Register a client property into this settings.

Parameters

clientProp:String — the client property name to be registered.
 
type:String — the class type of this client property.
 
cdata:Boolean (default = false) — whether this client property is CDATA XML style.

registerGlobalClient()method 
public static function registerGlobalClient(clientProp:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void

Register a global client property into TWaver Flex.

Parameters

clientProp:String — the client property name to be registered.
 
type:String — the class type of this client property.
 
cdata:Boolean (default = false) — whether this client property is CDATA XML style.
 
overrideExist:Boolean (default = true) — whether this registration will overwrite the old one if has.

registerGlobalProperty()method 
public static function registerGlobalProperty(property:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void

Register a global property.

Parameters

property:String — the property name to be registered.
 
type:String — the class type of the property.
 
cdata:Boolean (default = false) — whether this property is a CDATA XML style.
 
overrideExist:Boolean (default = true) — whether this registration will override the old one if has.

registerGlobalStyle()method 
public static function registerGlobalStyle(styleProp:String, type:String, cdata:Boolean = false, overrideExist:Boolean = true):void

Register a global style into TWaver Flex to use in XML serialzation.

Parameters

styleProp:String — the style property name.
 
type:String — the class type of this style property.
 
cdata:Boolean (default = false) — whether this style property is XML cdata.
 
overrideExist:Boolean (default = true) — whether this registration will overwrite the old one if has.

registerProperty()method 
public function registerProperty(property:String, type:String, cdata:Boolean = false):void

Register a property into this settings.

Parameters

property:String — the property to be registered.
 
type:String — the class type of this property.
 
cdata:Boolean (default = false) — whether this property is CDATA XML style.

registerStyle()method 
public function registerStyle(styleProp:String, type:String, cdata:Boolean = false):void

Register a style property into this settings.

Parameters

styleProp:String — the style property name to be registered.
 
type:String — the class type of this style property.
 
cdata:Boolean (default = false) — whether this style property is CDATA XML style.