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 

IGuideVariables  - AS3 ADEP Guides
Packagecom.adobe.guides.control
Interfacepublic interface IGuideVariables

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 IGuideVariables interface provides access to properties and methods to set/get a guide's Model and/or Inputs values directly.


Public Properties
 PropertyDefined By
  variablesSource : Object
Returns the variablesSource provided by the guide as an object map.
IGuideVariables
Public Methods
 MethodDefined By
  
getVariable(name:String):Object
Returns the value of the variable in the guide.
IGuideVariables
  
getVariables(type:String = "map"):Object
Returns the variablesSource provided by the guide by default as an object map.
IGuideVariables
  
setVariable(name:String, value:Object):void
Sets the guide variable.
IGuideVariables
Property Detail

variablesSource

property
variablesSource: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 variablesSource provided by the guide as an object map. This is not a bindable property. Setting parses and updates Guide variables for any matching variables provided in the source of name value pairs. source can be provided as an "Object map", or TBD...



Implementation
    public function get variablesSource():Object
    public function set variablesSource(value:Object):void
Method Detail

getVariable

()method
public function getVariable(name:String):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 value of the variable in the guide.

Parameters

name:String — the name of the variable to retrieve

Returns
Object — Object the value of the variable

getVariables

()method 
public function getVariables(type:String = "map"):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 variablesSource provided by the guide by default as an object map.

Parameters

type:String (default = "map") — the format to retreive the variables in, currently only "map" is supported.

Returns
Object — Object

setVariable

()method 
public function setVariable(name:String, value:Object):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

Sets the guide variable.

Parameters

name:String — the name of the variable to set
 
value:Object — the value of the variable to set



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

 

Legal Notices | Online Privacy Policy