Packagecom.adobe.portfolio.lists
Classpublic class CardContainer
InheritanceCardContainer Inheritance CardList Inheritance spark.components.List
Implements IListenAndWatch
Subclasses FreeFormList, NavPreview, WaveContainer

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

The CardContainer class extends CardList to provide marquee support and other utility functions useful for Navigators that display cards of different sizes.

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
  navPreview : 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
  cardSize : String
CardContainer
 InheritedfocusCardDelta : int
CardList
 InheritedisDragAndDropDisabled : Boolean
[static] [read-only] True if drag and drop has been temporarily disabled for card lists.
CardList
Public Methods
 MethodDefined By
  
Constructor
CardContainer
 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 that are automatically unwatched and unlistened.
CardContainer
 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
  
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
 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
  
[override] Returns the current state of this instance, since its skins should have a matching set of states.
CardContainer
  
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
  
initStates():void
CardContainer
 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
  
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
 Inherited
onCreationComplete(event:FlexEvent):void
CardList
  
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
  
CardContainer
  
CardContainer
  
CardContainer
  
CardContainer
 Inherited
Listener to handle events from the Collection Manager.
CardList
  
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
  
partAdded(partName:String, instance:Object):void
[override]
CardContainer
  
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
  
CardContainer
 Inherited
CardList
 Inherited
CardList
  
CardContainer
  
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
  
marqueeSelection:MarqueeSelection
Required: 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
  
disabled
CardContainer
  
intro
CardContainer
  
normal
CardContainer
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
  STATE_DISABLED : String = disabled
[static] The "disabled" state of both the CardContainer and its skin.
CardContainer
  STATE_INTRO : String = intro
[static] The "intro" state of both the CardContainer and its skin.
CardContainer
  STATE_NORMAL : String = normal
[static] The "normal" state of both the CardContainer and its skin.
CardContainer
Property Detail
cardSizeproperty
protected var cardSize:String

navPreviewproperty 
navPreview:NavPreview

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

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


Implementation
    public function get navPreview():NavPreview
    public function set navPreview(value:NavPreview):void
Constructor Detail
CardContainer()Constructor
public function CardContainer()

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 that are automatically unwatched and unlistened.

getCurrentSkinState()method 
override protected function getCurrentSkinState():String

Returns the current state of this instance, since its skins should have a matching set of states.

Returns
String
growOrShrinkSelection()method 
protected function growOrShrinkSelection(event:MarqueeSelectionEvent, indices:Vector.<int>):Vector.<int>

Parameters

event:MarqueeSelectionEvent
 
indices:Vector.<int>

Returns
Vector.<int>
initStates()method 
protected function initStates():void

modifiersActive()method 
protected function modifiersActive(event:MouseEvent, shiftKeyOK:Boolean = false, ctrlKeyOK:Boolean = false):Boolean

Parameters

event:MouseEvent
 
shiftKeyOK:Boolean (default = false)
 
ctrlKeyOK:Boolean (default = false)

Returns
Boolean
onHandledFocus()method 
protected function onHandledFocus(event:LayoutEvent):void

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.

Parameters

event:LayoutEvent

onMarqueeSelectionBegin()method 
protected function onMarqueeSelectionBegin(event:MarqueeSelectionEvent):void

Parameters

event:MarqueeSelectionEvent

onMarqueeSelectionCancelled()method 
protected function onMarqueeSelectionCancelled(event:MarqueeSelectionEvent):void

Parameters

event:MarqueeSelectionEvent

onMarqueeSelectionEnd()method 
protected function onMarqueeSelectionEnd(event:MarqueeSelectionEvent):void

Parameters

event:MarqueeSelectionEvent

onMarqueeSelectionMove()method 
protected function onMarqueeSelectionMove(event:MarqueeSelectionEvent):void

Parameters

event:MarqueeSelectionEvent

onNavPreviewCurrentState()method 
protected function onNavPreviewCurrentState(value:String):void

Parameters

value:String

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

partRemoved()method 
override protected function partRemoved(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

resetCardSizes()method 
protected function resetCardSizes():void

setCurrentState()method 
override public function setCurrentState(stateName:String, playTransition:Boolean = true):void

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

Sets the state of the skin as well as the state of this instance.

Parameters

stateName:String
 
playTransition:Boolean (default = true)

shiftOrCtrlDownButNotBoth()method 
protected function shiftOrCtrlDownButNotBoth(event:MarqueeSelectionEvent):Boolean

Parameters

event:MarqueeSelectionEvent

Returns
Boolean
updateMultiSelection()method 
protected function updateMultiSelection(indices:Vector.<int>):void

Parameters

indices:Vector.<int>

Constant Detail
STATE_DISABLEDConstant
public static const STATE_DISABLED:String = disabled

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

The "disabled" state of both the CardContainer and its skin.

STATE_INTROConstant 
public static const STATE_INTRO:String = intro

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

The "intro" state of both the CardContainer and its skin.

STATE_NORMALConstant 
public static const STATE_NORMAL:String = normal

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

The "normal" state of both the CardContainer and its skin.