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

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
 InheritedbindableDataGroup : DataGroup
[read-only]
CardList
 InheriteddataProvider : IList
[override] [write-only]
CardList
 InheriteddragStarted : Boolean = false
Boolean to indicate dragOperation is in progress
CardList
 InheritedenableIdle : Boolean
CardList
  navPreview : NavPreview
CardContainer
 InheriteduseDragDropOnFolders : Boolean = false
To enable dragDrop on folders during drag
CardList
 InheriteduseDragDropReordering : Boolean = false
To use advanced reordering
CardList
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
CardList
 InheritedautoWatch : AutoWatch
CardList
 InheritedcardLayout : ICardLayout
CardList
 InheritedcardLayoutHelper : CardLayoutHelper
CardList
  cardSize : String
CardContainer
 InheritedfocusCardDelta : int
CardList
Public Methods
 MethodDefined By
  
CardContainer
 Inherited
addDragData(dragSource:DragSource):void
[override] Take the data set by the list for ordered items and add it to the attachments data format.
CardList
  
[override]
CardContainer
 Inherited
calculateDropLocation(event:DragEvent):DropLocation
Calculate the dropLocation of the dragEvent.
CardList
 Inherited
cardFromAttachment(_dataGroup:DataGroup, attachment:Object):ISimpleCard
[static]
CardList
 Inherited
collectionDropEnabled(event:DragEvent):Boolean
Helper function that determines whether drag drop is supported
CardList
 Inherited
createDropIndicator():DisplayObject
[override]
CardList
 Inherited
[static]
CardList
 Inherited
[static]
CardList
 Inherited
CardList
 Inherited
getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Gets the folder item at the drop location
CardList
 Inherited
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
CardList
 Inherited
setSelectedIndicesWithChangeDispatch(value:Vector.<int>):void
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] Overriding the dragStartHandler to set a boolean to indicate that drag has started
CardList
  
[override] Returns the current state of this instance, since its skins should have a matching set of states.
CardContainer
 Inherited
handleDragDropReordering(event:DragEvent):void
Handles the actual dragDrop.
CardList
 Inherited
handleDropOnFolder(folder:IAttachment, event:DragEvent):IList
Handles drop on a folder
CardList
 Inherited
CardList
 Inherited
Updates the host 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, dragInitiator:IUIComponent):IList
Creates an ordered list of items after the drop.
CardList
  
modifiersActive(event:MouseEvent, shiftKeyOK:Boolean = false, ctrlKeyOK:Boolean = false):Boolean
CardContainer
 Inherited
onChildrenCollectionChange(event:CollectionEvent):void
Once the att's parent has been changed and it has been added to this collection, send the reorder command
CardList
 Inherited
onCollectionChange(e:CollectionEvent):void
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
CardList
  
CardContainer
  
CardContainer
  
CardContainer
  
CardContainer
 Inherited
CardList
  
onNavPreviewCurrentState(value:String):void
CardContainer
 Inherited
onOpenFolderTimeComplete(evt:TimerEvent):void
CardList
 Inherited
onResize(event:ResizeEvent):void
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
Send the reorder command once all the attachments are found in the given list
CardList
  
CardContainer
 Inherited
CardList
 Inherited
CardList
  
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 rect (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]
CardContainer
  STATE_INTRO : String = intro
[static] String literals used to represent the states of CardContainer and its skins.
CardContainer
  STATE_NORMAL : String = normal
[static]
CardContainer
Property Detail
cardSizeproperty
protected var cardSize:String

navPreviewproperty 
navPreview:NavPreview

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()



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

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
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:NavLayoutEvent):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:NavLayoutEvent

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

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

Parameters

stateName:String
 
playTransition:Boolean (default = true)

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

Parameters

indices:Vector.<int>

Constant Detail
STATE_DISABLEDConstant
public static const STATE_DISABLED:String = disabled

STATE_INTROConstant 
public static const STATE_INTRO:String = intro

String literals used to represent the states of CardContainer and its skins.

STATE_NORMALConstant 
public static const STATE_NORMAL:String = normal