| Package | ga.views |
| Class | public class TreeView |
| Inheritance | TreeView  Node ArrayCollection ListCollectionView 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 |
TreeListView class provides the Guide sections and panels in a
tree structure that mimics the Guide tree created in the Guide Design perspective
within Adobe Digital Enterprise Platform Document Services - Workbench 10.0.
Default MXML Propertysource
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | filterFunction : Function
A function that the view will use to eliminate items that do not
match the function's criteria. | ListCollectionView | |
| includeNestedSections : Boolean
Indicates if nested sections should appear in the tree. | TreeView | ||
| instance : ga.views:TreeView [static] [read-only]
The common instance of this class. | TreeView | ||
| length : int [read-only]
The number of items in this view. | ListCollectionView | |
| list : IList
The IList that this collection view wraps. | ListCollectionView | |
| selectedIndex : int
Not implemented for this view. | TreeView | ||
| selectedItem : Object
[bindable] The selected panel. | TreeView | ||
| sort : ISort
The ISort that will be applied to the ICollectionView. | ListCollectionView | |
| source : Array
The source of data in the ArrayCollection. | ArrayCollection | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
TreeView()
Sets up the event listeners and initializes the tree structure. | TreeView | ||
|
Adds a list of items to the current list, placing them at the end of
the list in the order they are passed. | ListCollectionView | |
|
Adds a list of items to the current list, placing them at the position
index passed in to the function. | ListCollectionView | |
| 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 | |
|
Adds the specified item to the end of the list. | ListCollectionView | |
|
Adds the item at the specified index. | ListCollectionView | |
|
Returns whether the view contains the specified object. | ListCollectionView | |
|
Creates a new IViewCursor that works with this view. | ListCollectionView | |
|
Prevents changes to the collection itself and items within the
collection from being dispatched by the view. | ListCollectionView | |
|
Dispatches an event into the event flow. | ListCollectionView | |
|
Enables auto-updating. | ListCollectionView | |
|
Gets the item at the specified index. | ListCollectionView | |
|
Returns the index of the item if it is in the list such that
getItemAt(index) == item. | ListCollectionView | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | ListCollectionView | |
|
Called automatically by the MXML compiler when the ListCollectionView
is created using an MXML tag. | ListCollectionView | |
| itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated. | ListCollectionView | |
Forwards events that can cause panel changes to the event listeners. | TreeView | ||
|
Applies the sort and filter to the view. | ListCollectionView | |
|
Remove all items from the list. | ListCollectionView | |
|
Removes a listener from the EventDispatcher object. | ListCollectionView | |
|
Removes the item at the specified index and returns it. | ListCollectionView | |
|
Places the item at the specified index. | ListCollectionView | |
|
Returns an Array that is populated in the same order as the IList
implementation. | ListCollectionView | |
|
Prints the contents of this view to a string and returns it. | ListCollectionView | |
|
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 | ||
|---|---|---|---|---|
| Dispatched when the ICollectionView has been updated in some way. | ListCollectionView | ||
| Dispatched when a repeating panel is added to a Guide. | TreeView | |||
| Dispatched when a repeating panel is removed from a Guide. | TreeView | |||
| Dispatched when a panel is selected. | TreeView | |||
Property Detail
includeNestedSections | property |
includeNestedSections:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates if nested sections should appear in the tree. The default value is True.
Implementation
public function get includeNestedSections():Boolean public function set includeNestedSections(value:Boolean):voidinstance | property |
instance:ga.views:TreeView [read-only] | 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():ga.views:TreeViewselectedIndex | 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 |
Not implemented for this view. This method always returns -1.
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):voidselectedItem | 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):voidConstructor Detail
TreeView | () | Constructor |
public function 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 |
Sets up the event listeners and initializes the tree structure.
Method Detail
pageChange | () | method |
public function pageChange(event:GAEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Forwards events that can cause panel changes to the event listeners.
Parameters
event:GAEvent — the GAEvent that triggered the call
|
Event Detail
pageAdd | Event |
Event Object Type:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
page | The page that was added. |
section | The section that contains the added page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
page | The page that was removed. |
section | The section that contained the removed page. |
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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:
property GAEvent.type =
ga.model.GAEventproperty 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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
target | The 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. |
Mon Apr 10 2017, 12:28 PM -07:00