ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
ga.views 

PanelListView  - AS3 ADEP Guides

Packagega.views
Classpublic class PanelListView
InheritancePanelListView Inheritance Node Inheritance ArrayCollection Inheritance ListCollectionView Inheritance Proxy
Implements IGuideView

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 PanelListView class provides a dynamic list of visible panels within a Guide. For example, using the following example Guide tree:
Guide  
 Section A 
  Panel A-1
  Panel A-2
 Section B  
  Panel B-1
This class provides the following panels:
  • Panel A-1
  • Panel A-2
  • Panel B-1

Default MXML Propertysource

Related API Elements



Public Properties
 PropertyDefined By
 InheritedfilterFunction : Function
A function that the view will use to eliminate items that do not match the function's criteria.
ListCollectionView
  instance : PanelListView
[static] The common instance of this class.
PanelListView
 Inheritedlength : int
[read-only] The number of items in this view.
ListCollectionView
 Inheritedlist : IList
The IList that this collection view wraps.
ListCollectionView
  selectedIndex : int
[bindable] The index of selected panel.
PanelListView
  selectedItem : Object
[bindable] The selected panel.
PanelListView
 Inheritedsort : ISort
The ISort that will be applied to the ICollectionView.
ListCollectionView
 Inheritedsource : Array
The source of data in the ArrayCollection.
ArrayCollection
Protected Properties
 PropertyDefined By
 InheritedlocalIndex : Array
When the view is sorted or filtered the localIndex property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order.
ListCollectionView
Public Methods
 MethodDefined By
  
Constructor
PanelListView
 Inherited
addAll(addList:IList):void
Adds a list of items to the current list, placing them at the end of the list in the order they are passed.
ListCollectionView
 Inherited
addAllAt(addList:IList, index:int):void
Adds a list of items to the current list, placing them at the position index passed in to the function.
ListCollectionView
 Inherited
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.
ListCollectionView
 Inherited
Adds the specified item to the end of the list.
ListCollectionView
 Inherited
addItemAt(item:Object, index:int):void
Adds the item at the specified index.
ListCollectionView
 Inherited
Returns whether the view contains the specified object.
ListCollectionView
 Inherited
Creates a new IViewCursor that works with this view.
ListCollectionView
 Inherited
Prevents changes to the collection itself and items within the collection from being dispatched by the view.
ListCollectionView
 Inherited
Dispatches an event into the event flow.
ListCollectionView
 Inherited
Enables auto-updating.
ListCollectionView
 Inherited
getItemAt(index:int, prefetch:int = 0):Object
Gets the item at the specified index.
ListCollectionView
 Inherited
Returns the index of the item if it is in the list such that getItemAt(index) == item.
ListCollectionView
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ListCollectionView
 Inherited
Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.
ListCollectionView
 Inherited
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated.
ListCollectionView
 Inherited
Applies the sort and filter to the view.
ListCollectionView
 Inherited
Remove all items from the list.
ListCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
ListCollectionView
 Inherited
Removes the item at the specified index and returns it.
ListCollectionView
 Inherited
setItemAt(item:Object, index:int):Object
Places the item at the specified index.
ListCollectionView
 Inherited
Returns an Array that is populated in the same order as the IList implementation.
ListCollectionView
 Inherited
Prints the contents of this view to a string and returns it.
ListCollectionView
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ListCollectionView
Events
 Event Summary Defined By
 InheritedDispatched when the ICollectionView has been updated in some way.ListCollectionView
   Dispatched when a repeating panel is added to a Guide.PanelListView
   Dispatched when a repeating panel is removed from a Guide.PanelListView
   Dispatched when a panel is selected.PanelListView
Property Detail

instance

property
instance:PanelListView

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 common instance of this class.



Implementation
    public static function get instance():PanelListView
    public static function set instance(value:PanelListView):void

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 selected panel.

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 panel.

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
Constructor Detail

PanelListView

()Constructor
public function PanelListView()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Constructor

Event Detail

pageAdd

Event
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_ADD

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is added to a Guide.

The properties of the event object have the following values:

PropertyValue
pageThe page that was added.
sectionThe section that contains the added page.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

pageRemove

Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_REMOVE

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a repeating panel is removed from a Guide.

The properties of the event object have the following values:

PropertyValue
pageThe page that was removed.
sectionThe section that contained the removed page.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

pageSelectionChange

Event  
Event Object Type: ga.model.GAEvent
property GAEvent.type = ga.model.GAEvent.PAGE_SELECTION_CHANGE

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 9
Runtime Versions: AIR 1.0, Flash Player 10.2

Dispatched when a panel is selected.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.