Packagecom.adobe.portfolio.lists
Classpublic class WaveContainer
InheritanceWaveContainer Inheritance CardContainer Inheritance CardList Inheritance spark.components.List

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The WaveContainer class extends CardContainer to provide functionality specific to the Wave navigator.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
 InheritedbindableDataGroup : DataGroup
[read-only]
CardList
 InheriteddataProvider : IList
[override] [write-only] Sets the dataProvider for this list.
CardList
 InheriteddragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
CardList
 InheritedenableIdle : Boolean
CardList
 InheritednavPreview : NavPreview
CardContainer
 InheriteduseDragDropOnFolders : Boolean = false
To enable dragDrop on folders during a drag operation.
CardList
 InheriteduseDragDropReordering : Boolean = false
To allow for reordering of items using simple drag and drop gestures.
CardList
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
CardList
 InheritedautoWatch : AutoWatch
CardList
 InheritedcardLayout : ICardLayout
CardList
 InheritedcardLayoutHelper : CardLayoutHelper
CardList
 InheritedcardSize : String
CardContainer
 InheritedfocusCardDelta : int
CardList
 InheritedisDragAndDropDisabled : Boolean
[static] [read-only] True if drag and drop has been temporarily disabled for card lists.
CardList
  waveLayout : WaveLayout
WaveContainer
Public Methods
 MethodDefined By
  
Constructor.
WaveContainer
 Inherited
addDragData(dragSource:DragSource):void
[override] Takes the data set by the list for ordered items and adds it to the attachments data format.
CardList
  
[override] Adds listeners and watchers.
WaveContainer
 Inherited
calculateDropLocation(event:DragEvent):DropLocation
Calculate the dropLocation of the given dragEvent.
CardList
 Inherited
cardFromAttachment(_dataGroup:DataGroup, attachment:Object):ISimpleCard
[static] Finds the card associated with the given attachment
CardList
 Inherited
collectionDropEnabled(event:DragEvent):Boolean
Helper function that determines whether drag drop is supported
CardList
 Inherited
createDropIndicator():DisplayObject
[override] Creates a custom dropIndicator for the cardList.
CardList
 Inherited
[static] Functions used to disable and enable drag and drop.
CardList
 Inherited
[static]
CardList
 Inherited
Finds the card corresponding to the attachment in focus.
CardList
 Inherited
getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Finds the folder at a given dropLocation
CardList
 Inherited
Function to cleanup the event listeners required by miniNav list.
CardList
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the state of the skin as well as the state of this instance.
CardContainer
 Inherited
Force selection change.
CardList
 Inherited
setSelectedIndicesWithChangeDispatch(value:Vector.<int>):void
Force selection change.
CardList
 Inherited
updateRenderer(renderer:IVisualElement, itemIndex:int, data:Object):void
[override]
CardList
Protected Methods
 MethodDefined By
 Inherited
addListener(listener:IEventDispatcher, type:String, handler:Function):void
CardList
 Inherited
addWatcher(watcher:ChangeWatcher):void
CardList
  
caretChangeHandler(event:IndexChangeEvent):void
WaveContainer
 Inherited
Returns true if the dataProvider for this list matches the CollectionMgr's currentItems.
CardList
 Inherited
dragCompleteHandler(event:DragEvent):void
[override]
CardList
 Inherited
dragDropHandler(event:DragEvent):void
[override]
CardList
 Inherited
dragEnterHandler(event:DragEvent):void
[override]
CardList
 Inherited
dragExitHandler(event:DragEvent):void
[override]
CardList
 Inherited
dragOverHandler(event:DragEvent):void
[override]
CardList
 Inherited
dragStartHandler(event:DragEvent):void
[override] Does not start drag if some other component has disabled it.
CardList
 Inherited
[override] Returns the current state of this instance, since its skins should have a matching set of states.
CardContainer
  
getDeltaX(event:MouseEvent):Number
WaveContainer
 Inherited
growOrShrinkSelection(event:MarqueeSelectionEvent, indices:Vector.<int>):Vector.<int>
CardContainer
 Inherited
handleDragDropReordering(event:DragEvent):void
Handles the reordering of items after a dragDrop.
CardList
 Inherited
handleDropOnFolder(folder:IAttachment, event:DragEvent):IList
Handles drop on a folder.
CardList
 Inherited
Triggers generation of thumbnails around the new focus card.
CardList
 Inherited
Updates the host's selection based on the current list selection.
CardList
 Inherited
CardList
 Inherited
initStates():void
CardContainer
  
item_mouseDownHandler(event:MouseEvent):void
[override]
WaveContainer
  
itemSelected(index:int, selected:Boolean):void
[override]
WaveContainer
 Inherited
keyDownHandler(event:KeyboardEvent):void
[override]
CardList
 Inherited
makeNewOrderedList(dropIndex:int, droppingItems:ArrayCollection):IList
Creates an ordered list of items in the dataProvider after the drop.
CardList
 Inherited
modifiersActive(event:MouseEvent, shiftKeyOK:Boolean = false, ctrlKeyOK:Boolean = false):Boolean
CardContainer
 Inherited
onChildrenCollectionChange(event:CollectionEvent):void
This function is used when attachments are moved across folders.
CardList
 Inherited
onCollectionChange(e:CollectionEvent):void
Listener to handle collection change events.
CardList
  
onCreationComplete(event:FlexEvent):void
[override]
WaveContainer
 Inherited
onHandledFocus is used to ensure that the layout has successfully handled the layout of its initial focused attachment before transitioning in the remaining pieces of UI.
CardContainer
 Inherited
onIndexChangeEvent(event:IndexChangeEvent):void
This listener is called when the selection changes based on user interaction, or when setSelectedIndexWithChangeDispatch or setSelectedIndicesWithChangeDispatch is used to set the selection.
CardList
 Inherited
CardContainer
 Inherited
CardContainer
 Inherited
CardContainer
 Inherited
CardContainer
  
onMouseMove(event:MouseEvent):void
WaveContainer
  
onMouseUp(event:MouseEvent):void
WaveContainer
 Inherited
Listener to handle events from the Collection Manager.
CardList
 Inherited
onNavPreviewCurrentState(value:String):void
CardContainer
 Inherited
onOpenFolderTimeComplete(evt:TimerEvent):void
Called when the openFolderTimer completes.
CardList
 Inherited
onResize(event:ResizeEvent):void
CardList
 Inherited
onScroll(event:Event):void
Listener to handle scroll events of the scroller on cardLists.
CardList
 Inherited
partAdded(partName:String, instance:Object):void
[override]
CardContainer
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
CardContainer
 Inherited
removeListener(listener:IEventDispatcher, type:String = null):void
CardList
 Inherited
reorderAttachments(source:IList):Boolean
Sends the reorder command once all the attachments are found in the given list.
CardList
 Inherited
CardContainer
 Inherited
CardList
 Inherited
CardList
 Inherited
CardContainer
 Inherited
updateMultiSelection(indices:Vector.<int>):void
CardContainer
 Inherited
CardList
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
 InheritedRequired: false Part Type: Static
A MarqueeSelection (with frame and shaded center) used to highlight the area of a marquee select.
CardContainer
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 InheritedCardContainer
 InheritedCardContainer
 InheritedCardContainer
Public Constants
 ConstantDefined By
 InheritedcollectionMgr : CollectionManager
The navigator's CollectionManager instance.
CardList
 InheritedDRAG_DROP_ATTACHMENTS : String = attachments
[static] Format that defines the set of Acrobat drag and drop attachments.
CardList
 InheritedDRAG_DROP_ITEMS : String = itemsByIndex
[static] Format that defines the default set of List drag and drop items.
CardList
 InheritedSTATE_DISABLED : String = disabled
[static] The "disabled" state of both the CardContainer and its skin.
CardContainer
 InheritedSTATE_INTRO : String = intro
[static] The "intro" state of both the CardContainer and its skin.
CardContainer
 InheritedSTATE_NORMAL : String = normal
[static] The "normal" state of both the CardContainer and its skin.
CardContainer
Property Detail
waveLayoutproperty
protected var waveLayout:WaveLayout

Constructor Detail
WaveContainer()Constructor
public function WaveContainer()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor.

Method Detail
addListenAndWatch()method
override public function addListenAndWatch():void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Adds listeners and watchers.

caretChangeHandler()method 
protected function caretChangeHandler(event:IndexChangeEvent):void

Parameters

event:IndexChangeEvent

getDeltaX()method 
protected function getDeltaX(event:MouseEvent):Number

Parameters

event:MouseEvent

Returns
Number
item_mouseDownHandler()method 
override protected function item_mouseDownHandler(event:MouseEvent):void

Parameters

event:MouseEvent

itemSelected()method 
override protected function itemSelected(index:int, selected:Boolean):void

Parameters

index:int
 
selected:Boolean

onCreationComplete()method 
override protected function onCreationComplete(event:FlexEvent):void

Parameters

event:FlexEvent

onMouseMove()method 
protected function onMouseMove(event:MouseEvent):void

Parameters

event:MouseEvent

onMouseUp()method 
protected function onMouseUp(event:MouseEvent):void

Parameters

event:MouseEvent