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

Package	ga.views
Interface	public interface IGuideView extends IList , IEventDispatcher
Implementors	DynamicSectionView, PanelListView, SectionListView, StaticSectionView, TreeView

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

The IGuideView interface provides a view to the guide sections and panels and can be used as a data provider. It also supports a selected item in the view. Aside from the selected item/index, this data provider is read only. Whenever the guide adds or removes sections or panels, a view will automatically be updated.

Several guide view instances can be created at a time, for example, one view can contain the list of sections, and another view can contain a list of panels. Changing the selected item in one view will cause a change to the selected item in all guide views.

For example, selecting a panel in a panel view will cause a section view to select that panel’s section. Selecting a section will cause the panel view to select the first panel in that section.

We can have hierarchical guide views where sections are the top most items and the leaves are panels. In this case, the selected index represents the index amongst the panels. In a tree structure like this, a section can never be the selected item. Any attempts to select a section will cause the first panel in that section to be the selected item.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		length : int [read-only] The number of items in this collection.	IList
		selectedIndex : int [bindable] The index of the selected item.	IGuideView
		selectedItem : Object [bindable] The selected item.	IGuideView

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	IEventDispatcher
		addItem(item:Object):void Adds the specified item to the end of the list.	IList
		addItemAt(item:Object, index:int):void Adds the item at the specified index.	IList
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		getItemAt(index:int, prefetch:int = 0):Object Gets the item at the specified index.	IList
		getItemIndex(item:Object):int Returns the index of the item if it is in the list such that getItemAt(index) == item.	IList
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Notifies the view that an item has been updated.	IList
		removeAll():void Removes all items from the list.	IList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		removeItemAt(index:int):Object Removes the item at the specified index and returns it.	IList
		setItemAt(item:Object, index:int):Object Places the item at the specified index.	IList
		toArray():Array Returns an Array that is populated in the same order as the IList implementation.	IList
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Property Detail

selectedIndex

property

selectedIndex:int

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

[bindable] The index of the selected item.

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 selectedIndex():int
public function set selectedIndex(value:int):void

selectedItem

property

selectedItem:Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

[bindable] The selected item.

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 selectedItem():Object
public function set selectedItem(value:Object):void

IGuideView - AS3 ADEP Guides

Classes x

selectedIndex

selectedItem

ga.views IGuideView - AS3 ADEP Guides		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples