ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.guides.control 

IGuideData  - AS3 ADEP Guides
Packagecom.adobe.guides.control
Interfacepublic 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

The IGuideData interface provides properties and methods which allow interaction with the guide's Data content. Setting (retieving) the guide's source for data, retrieving the guide's current data as xml or draft, or retieving a particular guide objects current value.


Public Properties
 PropertyDefined By
  dataSource : Object
Returns the dataSource object provided.
IGuideData
  submitRequestTimestamp : Date
[read-only] Returns the timestamp of the most recent submit request.
IGuideData
Public Methods
 MethodDefined By
  
getData(type:String = "xml"):Object
The getData(type) method returns the data as an XML Object(default), or an Entity object if given type='entity'.
IGuideData
  
getValue(dataReference:String):*
The getValue(dataReference) method returns the data value from the model item referenced as the model's object type.
IGuideData
  
setValue(dataReference:String, value:*):void
The setValue(dataReference, value) method updates the model item data referenced with the provided value.
IGuideData
Property Detail

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
Method Detail

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.

Returns
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"

Returns
* —

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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy