Packagega.views
Classpublic class TreeView
Implements IGuideView

Provides the form guide sections and panels in a tree structure that mimics the form guide hierarchy created in Guide Builder.



Public Properties
 PropertyDefined By
  includeNestedSections : Boolean
Indicates if nested sections should appear in the tree.
TreeView
  instance : TreeView
[static] [read-only] The common instance of this class.
TreeView
  selectedIndex : int
[-only] The leaf section index of the selected item
TreeView
  selectedItem : Object
[-only] Returns the page manager pages
TreeView
Public Methods
 MethodDefined By
  
Sets up the event listeners and initializes the tree structure.
TreeView
  
Forwards events that can cause panel changes to the event listeners.
TreeView
Events
 Event Summary Defined By
   Dispatched when a repeating panel is added to a form guide.TreeView
   Dispatched when a repeating panel is removed from a form guide.TreeView
   Dispatched when a panel is selected. Dispatched when a form guide initializes.TreeView
Property Detail
includeNestedSectionsproperty
includeNestedSections:Boolean  [read-write]

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):void
instanceproperty 
instance:TreeView  [read-only]

The common instance of this class.


Implementation
    public static function get instance():TreeView
selectedIndexproperty 
public var selectedIndex:int

The leaf section index of the selected item

This property can be used as the source for data binding.

selectedItemproperty 
public var selectedItem:Object

Returns the page manager pages

This property can be used as the source for data binding.

Constructor Detail
TreeView()Constructor
public function TreeView()

Sets up the event listeners and initializes the tree structure.

Method Detail
pageChange()method
public function pageChange(event:GAEvent):void

Forwards events that can cause panel changes to the event listeners.

Parameters

event:GAEvent

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

Dispatched when a repeating panel is added to a form 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
GAEvent.type property = ga.model.GAEvent.PAGE_REMOVE

Dispatched when a repeating panel is removed from a form 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
GAEvent.type property = ga.model.GAEvent.PAGE_SELECTION_CHANGE

Dispatched when a panel is selected. Dispatched when a form guide initializes.

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.




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/ga/views/TreeView.html