Package | com.adobe.guides.control |
Interface | public interface IGuideData |
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Property | Defined By | ||
---|---|---|---|
dataSource : Object
Returns the dataSource object provided. | IGuideData | ||
submitRequestTimestamp : Date [read-only]
Returns the timestamp of the most recent submit request. | IGuideData |
Method | Defined By | ||
---|---|---|---|
The getData(type) method returns the data as an XML Object(default), or an Entity object if given type='entity'. | IGuideData | ||
The getValue(dataReference) method returns the data value from the model item referenced as the model's object type. | IGuideData | ||
The setValue(dataReference, value) method updates the model item data referenced with the provided value. | IGuideData |
dataSource | property |
dataSource:Object
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the dataSource object provided. Sets and loads the given data. Can be any of XML, xml String, url or Entity object.
Implementation
public function get dataSource():Object
public function set dataSource(value:Object):void
submitRequestTimestamp | property |
submitRequestTimestamp:Date
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns the timestamp of the most recent submit request.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
Implementation
public function get submitRequestTimestamp():Date
getData | () | method |
public function getData(type:String = "xml"):Object
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The getData(type) method returns the data as an XML Object(default), or an Entity object if given type='entity'. ("entity" returns Fiber or XFA instance actionscript class).
Parameters
type:String (default = "xml ") — the format to retreive the data in, default is "xml".
"draft" returns an XML file that includes state information. Loading that xml later will return the guide to the state at that time.
"entity" returns the DataModeler Entity valueObject.
|
Object — Object
|
getValue | () | method |
public function getValue(dataReference:String):*
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The getValue(dataReference) method returns the data value from the model item referenced as the model's object type. Throws an exception if dataRef does not exist.
Parameters
dataReference:String — the fully defined reference in dot notation of the DataModel object. eg. "Clients.Client.Address.State"
|
* —
|
setValue | () | method |
public function setValue(dataReference:String, value:*):void
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The setValue(dataReference, value) method updates the model item data referenced with the provided value. Throws an exception if dataRef does not exist or an incompatible value type is passed.
Parameters
dataReference:String — the fully defined reference in dot notation of the DataModel object. eg. "Clients.Client.Address.State"
| |
value:* — the data value to assign to the DataModel object.
|
Mon Nov 28 2011, 06:48 AM -08:00