| Package | com.adobe.guides.control |
| Interface | public 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 |
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| variablesSource : Object
Returns the variablesSource provided by the guide as an object map. | IGuideVariables | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Returns the value of the variable in the guide. | IGuideVariables | ||
Returns the variablesSource provided by the guide by default as an object map. | IGuideVariables | ||
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):voidMethod 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
|
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") |
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
|
Mon Nov 28 2011, 06:48 AM -08:00