IGuide - Adobe ActionScript® 3 (AS3 ADEP Guides) API Reference

Package	com.adobe.guides.control
Interface	public interface IGuide extends IGuideData , IGuideDisplay , IGuideErrors , IGuideNavigation , IGuideSource , 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 IGuide interface is used to load, control and interact with a Guide definition.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		currentItem : IGuideNode [read-only] currentItem is the GuideNode that represents the currently selected item on the current panel in the Guide.	IGuideNavigation
		currentPanel : IGuideNode [read-only] currentPanel is the GuideNode that represents the currently selected panel in the Guide.	IGuideNavigation
		dataSource : Object Returns the dataSource object provided.	IGuideData
		errors : IList [read-only] errors is an IList of GuideNodes that currently contain validation errors.	IGuideErrors
		hasNextPanel : Boolean [read-only] hasNextPanel returns whether there is a next panel currenly available.	IGuideNavigation
		hasPreviousPanel : Boolean [read-only] hasPreviousPanel returns whether there is a previous panel currenly available.	IGuideNavigation
		resizeToContent : Boolean When set to true, the Guide will size it self to the content of the Guide.	IGuideDisplay
		resourceModule : IGuideResourceModule A IGuideResourceModule identified the the locale and resource modules that support the Guide's resource strings.	IGuideSource
		rootNode : IGuideNode [read-only] rootNode is the top level GuideNode representing the current Guide instance's structure.	IGuideNavigation
		source : String The url to the Guide file which to load.	IGuideSource
		stylePath : String The path to the style asset which will be loaded by the Guide.	IGuideDisplay
		submitRequestTimestamp : Date [read-only] Returns the timestamp of the most recent submit request.	IGuideData
		systemConfig : String The System Configuration which must be a valid xml string defines the systems component mapping.	IGuideDisplay
		variablesSource : Object Returns the variablesSource provided by the guide as an object map.	IGuideVariables

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		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
		select(node:IGuideNode):Boolean select will change the Guide view and focus to the provided GuideNode.	IGuideNavigation
		selectFirst(type:String = "panel"):Boolean selectFirst changes the guide to the first GuideNode instance of the type requested.	IGuideNavigation
		selectLast(type:String = "panel"):Boolean selectLast changes the guide to the last GuideNode instance of the type requested.	IGuideNavigation
		selectNext(type:String = "panel"):Boolean selectNext changes the guide to the next GuideNode instance of the type requested.	IGuideNavigation
		selectPrevious(type:String = "panel"):Boolean selectPrevious changes the guide to the previous GuideNode instance of the type requested.	IGuideNavigation
		setValue(dataReference:String, value:*):void The setValue(dataReference, value) method updates the model item data referenced with the provided value.	IGuideData
		setVariable(name:String, value:Object):void Sets the guide variable.	IGuideVariables
		validate(node:IGuideNode = null):Boolean validate will validate the GuideNode provided, the whole Guide if nothing provided, a single Panel if a Panel Node is provided.	IGuideErrors

IGuide - AS3 ADEP Guides

Classes x

com.adobe.guides.control IGuide - AS3 ADEP Guides		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples