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

Package	ga.model
Class	public class Section
Inheritance	Section Node ArrayCollection ListCollectionView Proxy
Implements	ISection
Subclasses	GuidedActivity

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 9

Runtime Versions:

AIR 1.0, Flash Player 10.2

A Guide section that can contain several panels.

MXML Syntax expanded

Hide MXML Syntax

      <ga:Section
        Properties
        label=""
        sectionId=""
        >
        <ga:panels>
          <ga:Panel...>
          ...
        </ga:panels>

Default MXML Propertysource

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		dataRef : String	Section
		designIndex : int	Section
		filterFunction : Function A function that the view will use to eliminate items that do not match the function's criteria.	ListCollectionView
		_itemInstance : Object	Section
		length : int [read-only] The number of items in this view.	ListCollectionView
		list : IList The IList that this collection view wraps.	ListCollectionView
		sectionId : String	Section
		sectionIndex : *	Section
		sectionManager : Boolean	Section
		sectionManagers : Array	Section
		sort : ISort The ISort that will be applied to the ICollectionView.	ListCollectionView
		source : Array The source of data in the ArrayCollection.	ArrayCollection

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		localIndex : 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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		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
		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
		addItem(item:Object):void Adds the specified item to the end of the list.	ListCollectionView
		addItemAt(item:Object, index:int):void Adds the item at the specified index.	ListCollectionView
		contains(item:Object):Boolean Returns whether the view contains the specified object.	ListCollectionView
		createCursor():IViewCursor Creates a new IViewCursor that works with this view.	ListCollectionView
		disableAutoUpdate():void Prevents changes to the collection itself and items within the collection from being dispatched by the view.	ListCollectionView
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ListCollectionView
		enableAutoUpdate():void Enables auto-updating.	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object Gets the item at the specified index.	ListCollectionView
		getItemIndex(item:Object):int Returns the index of the item if it is in the list such that getItemAt(index) == item.	ListCollectionView
		getQualifiedDataRef(object:Object):String Returns a fully qualified data reference for the current section's instance.	Section
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ListCollectionView
		initDataProvider():void Sets the instance manager and the data provider for this repeating panel	Section
		initialized(document:Object, id:String):void 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
		refresh():Boolean Applies the sort and filter to the view.	ListCollectionView
		removeAll():void Remove all items from the list.	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ListCollectionView
		removeItemAt(index:int):Object Removes the item at the specified index and returns it.	ListCollectionView
		setItemAt(item:Object, index:int):Object Places the item at the specified index.	ListCollectionView
		toArray():Array Returns an Array that is populated in the same order as the IList implementation.	ListCollectionView
		toString():String Prints the contents of this view to a string and returns it.	ListCollectionView
		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.	ListCollectionView

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		collectionChange	Dispatched when the ICollectionView has been updated in some way.	ListCollectionView

Property Detail

_itemInstance

property

_itemInstance:Object

Implementation
public function get _itemInstance():Object
public function set _itemInstance(value:Object):void

dataRef

property

dataRef:String

Implementation
public function get dataRef():String
public function set dataRef(value:String):void

designIndex

property

designIndex:int

Implementation
public function get designIndex():int
public function set designIndex(value:int):void

sectionId

property

sectionId:String

Implementation
public function get sectionId():String
public function set sectionId(value:String):void

sectionIndex

property

sectionIndex:*

Implementation
public function get sectionIndex():*
public function set sectionIndex(value:any):void

sectionManager

property

sectionManager:Boolean

Implementation
public function get sectionManager():Boolean
public function set sectionManager(value:Boolean):void

sectionManagers

property

sectionManagers:Array

Implementation
public function get sectionManagers():Array
public function set sectionManagers(value:Array):void

Method Detail

getQualifiedDataRef

()

method

public function getQualifiedDataRef(object:Object):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Guides 10

Runtime Versions:

AIR 1.0, Flash Player 10.2

Returns a fully qualified data reference for the current section's instance.

Parameters

object:Object — the data instance whose qualified data reference is returned

Returns

String — String representing the qualified data ref of the data instance.

initDataProvider

()

method

public function initDataProvider():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

Sets the instance manager and the data provider for this repeating panel

Section - AS3 ADEP Guides

Classes x

_itemInstance

dataRef

designIndex

sectionId

sectionIndex

sectionManager

sectionManagers

getQualifiedDataRef

initDataProvider

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