| 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 |
| 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 | ||
| Method | Defined By | ||
|---|---|---|---|
select will change the Guide view and focus to the provided GuideNode. | IGuideNavigation | ||
selectFirst changes the guide to the first GuideNode instance of the type requested. | IGuideNavigation | ||
selectLast changes the guide to the last GuideNode instance of the type requested. | IGuideNavigation | ||
selectNext changes the guide to the next GuideNode instance of the type requested. | IGuideNavigation | ||
selectPrevious changes the guide to the previous GuideNode instance of the type requested. | IGuideNavigation | ||
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():IGuideNodecurrentPanel | 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():IGuideNodehasNextPanel | 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():BooleanhasPreviousPanel | 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():BooleanrootNode | 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():IGuideNodeselect | () | 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.
|
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") |
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") |
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") |
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") |
Boolean — Boolean
|
Thu Dec 6 2018, 01:12 PM -08:00