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

Package	com.adobe.guides.control
Interface	public interface IGuideNavigation

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 IGuideNaviagation interface provides access to properties and methods to set, report current (Panel, Item), and provide some state information to assist with external navigation state.

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
		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
		rootNode : IGuideNode [read-only] rootNode is the top level GuideNode representing the current Guide instance's structure.	IGuideNavigation

Public Methods

	Method		Defined By
		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

Property Detail

currentItem

property

currentItem:IGuideNode [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

currentItem is the GuideNode that represents the currently selected item on the current panel in the Guide.

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 currentItem():IGuideNode

currentPanel

property

currentPanel:IGuideNode [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

currentPanel is the GuideNode that represents the currently selected panel in the Guide.

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 currentPanel():IGuideNode

hasNextPanel

property

hasNextPanel:Boolean [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

hasNextPanel returns whether there is a next panel currenly available.

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 hasNextPanel():Boolean

hasPreviousPanel

property

hasPreviousPanel:Boolean [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

hasPreviousPanel returns whether there is a previous panel currenly available.

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 hasPreviousPanel():Boolean

rootNode

property

rootNode:IGuideNode [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

rootNode is the top level GuideNode representing the current Guide instance's structure.

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 rootNode():IGuideNode

Method Detail

select

()

method

public function select(node:IGuideNode):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

select will change the Guide view and focus to the provided GuideNode. It set First Panel and Item found from the given GuideNode.

Parameters

node:IGuideNode — the guide item to navigate to, can be a node type of one of: guide, section, panel, item.

Returns

Boolean — Boolean

selectFirst

()

method

public function selectFirst(type:String = "panel"):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

selectFirst changes the guide to the first GuideNode instance of the type requested.

Parameters

type:String (default = "panel") — the guide item type of the first of its kind to navigate to. - default is PANEL, other options avaliable are GUIDE, SECTION, ITEM.

Returns

Boolean — Boolean

selectLast

()

method

public function selectLast(type:String = "panel"):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

selectLast changes the guide to the last GuideNode instance of the type requested.

Parameters

type:String (default = "panel") — the guide item type of the last of its kind to navigate to. - default is PANEL, other options avaliable are GUIDE, SECTION, ITEM.

Returns

Boolean — Boolean

selectNext

()

method

public function selectNext(type:String = "panel"):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

selectNext changes the guide to the next GuideNode instance of the type requested.

Parameters

type:String (default = "panel") — the guide item type of the next of its kind to navigate to. - default is PANEL, other options avaliable are GUIDE, SECTION, ITEM.

Returns

Boolean — Boolean

selectPrevious

()

method

public function selectPrevious(type:String = "panel"):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

selectPrevious changes the guide to the previous GuideNode instance of the type requested.

Parameters

type:String (default = "panel") — the guide item type of the previous of its kind to navigate to. - default is PANEL, other options avaliable are GUIDE, SECTION, ITEM.

Returns

Boolean — Boolean

IGuideNavigation - AS3 ADEP Guides

Classes x

currentItem

currentPanel

hasNextPanel

hasPreviousPanel

rootNode

select

selectFirst

selectLast

selectNext

selectPrevious

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