| Package | com.adobe.portfolio.components |
| Class | public class CardContainer |
| Inheritance | CardContainer CardList 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 |
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
![]() | bindableDataGroup : DataGroup [read-only] | CardList | |
![]() | dataProvider : IList [override] [write-only] | CardList | |
![]() | dragStarted : Boolean = false Boolean to indicate dragOperation is in progress
| CardList | |
![]() | enableIdle : Boolean | CardList | |
| navPreview : NavPreview | CardContainer | ||
![]() | useDragDropOnFolders : Boolean = false To enable dragDrop on folders during drag
| CardList | |
![]() | useDragDropReordering : Boolean = false To use advanced reordering
| CardList | |
| Property | Defined By | ||
|---|---|---|---|
![]() | autoListen : AutoListen | CardList | |
![]() | autoWatch : AutoWatch | CardList | |
![]() | cardLayout : ICardLayout | CardList | |
![]() | cardLayoutHelper : CardLayoutHelper | CardList | |
| cardSize : String | CardContainer | ||
![]() | focusCardDelta : int | CardList | |
| Method | Defined By | ||
|---|---|---|---|
| CardContainer | |||
![]() | addDragData(dragSource:DragSource):void [override]
Take the data set by the list for ordered items and add it to the attachments
data format. | CardList | |
addListenAndWatch():void [override] | CardContainer | ||
![]() | calculateDropLocation(event:DragEvent):DropLocation Calculate the dropLocation of the dragEvent. | CardList | |
![]() | cardFromAttachment(_dataGroup:DataGroup, attachment:Object):ISimpleCard [static] | CardList | |
![]() | collectionDropEnabled(event:DragEvent):Boolean
Helper function that determines whether drag drop is supported
| CardList | |
![]() | createDropIndicator():DisplayObject [override] | CardList | |
![]() | disableDragAndDrop():void [static] | CardList | |
![]() | enableDragAndDrop():void [static] | CardList | |
![]() | CardList | ||
![]() | getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment Gets the folder item at the drop location
| CardList | |
![]() | removeListenAndWatch():void | CardList | |
setCurrentState(stateName:String, playTransition:Boolean = true):void [override] Sets the state of the skin as well as the state of this instance. | CardContainer | ||
![]() | setSelectedIndexWithChangeDispatch(value:int):void | CardList | |
![]() | setSelectedIndicesWithChangeDispatch(value:Vector.<int>):void | CardList | |
![]() | updateRenderer(renderer:IVisualElement, itemIndex:int, data:Object):void [override] | CardList | |
| Method | Defined By | ||
|---|---|---|---|
![]() | addListener(listener:IEventDispatcher, type:String, handler:Function):void | CardList | |
![]() | addWatcher(watcher:ChangeWatcher):void | CardList | |
![]() | dataProviderIsCurrent():Boolean
Returns true if the dataProvider for this list matches the CollectionMgr's currentItems. | CardList | |
![]() | dragCompleteHandler(event:DragEvent):void [override] | CardList | |
![]() | dragDropHandler(event:DragEvent):void [override] | CardList | |
![]() | dragEnterHandler(event:DragEvent):void [override] | CardList | |
![]() | dragExitHandler(event:DragEvent):void [override] | CardList | |
![]() | dragOverHandler(event:DragEvent):void [override] | CardList | |
![]() | dragStartHandler(event:DragEvent):void [override] Overriding the dragStartHandler to set a boolean to indicate that drag has started
| CardList | |
getCurrentSkinState():String [override] Returns the current state of this instance, since its skins should have a matching
set of states. | CardContainer | ||
![]() | handleDragDropReordering(event:DragEvent):void Handles the actual dragDrop. | CardList | |
![]() | handleDropOnFolder(folder:IAttachment, event:DragEvent):IList Handles drop on a folder
| CardList | |
![]() | handleFocusChange(event:NavHostEvent):void | CardList | |
![]() | handleSelectionChanged():void
Updates the host selection based on the current list selection. | CardList | |
![]() | initializeSelectionFromHost():Boolean | CardList | |
initStates():void | CardContainer | ||
![]() | keyDownHandler(event:KeyboardEvent):void [override] | CardList | |
![]() | 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 | ||
![]() | 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 | |
![]() | onCollectionChange(e:CollectionEvent):void | CardList | |
![]() | onCreationComplete(event:FlexEvent):void | CardList | |
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. | CardContainer | ||
![]() | onIndexChangeEvent(event:IndexChangeEvent):void | CardList | |
onMarqueeSelectionBegin(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionCancelled(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionEnd(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionMove(event:MarqueeSelectionEvent):void | CardContainer | ||
![]() | onNavHostEvent(event:NavHostEvent):void | CardList | |
onNavPreviewCurrentState(value:String):void | CardContainer | ||
![]() | onOpenFolderTimeComplete(evt:TimerEvent):void | CardList | |
![]() | onResize(event:ResizeEvent):void | CardList | |
partAdded(partName:String, instance:Object):void [override] | CardContainer | ||
partRemoved(partName:String, instance:Object):void [override] | CardContainer | ||
![]() | removeListener(listener:IEventDispatcher, type:String = null):void | CardList | |
![]() | reorderAttachments(source:IList):Boolean Send the reorder command once all the attachments are found in the given list
| CardList | |
resetCardSizes():void | CardContainer | ||
![]() | resizeCachedThumbs():void | CardList | |
![]() | setFocusOnIndexChange(attachment:IAttachment):void | CardList | |
updateMultiSelection(indices:Vector.<int>):void | CardContainer | ||
![]() | updateSelection():void | CardList | |
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 | ||
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 | |||
| Constant | Defined By | ||
|---|---|---|---|
![]() | collectionMgr : CollectionManager The navigator's CollectionManager instance. | CardList | |
![]() | DRAG_DROP_ATTACHMENTS : String = attachments [static]
Format that defines the set of Acrobat drag and drop attachments. | CardList | |
![]() | DRAG_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 | ||
| cardSize | property |
protected var cardSize:String| navPreview | property |
navPreview:NavPreviewThis property can be used as the source for data binding.
public function get navPreview():NavPreview public function set navPreview(value:NavPreview):void| CardContainer | () | Constructor |
public function CardContainer()| addListenAndWatch | () | method |
override public function addListenAndWatch():void| getCurrentSkinState | () | method |
override protected function getCurrentSkinState():StringReturns the current state of this instance, since its skins should have a matching set of states.
ReturnsString |
| initStates | () | method |
protected function initStates():void| modifiersActive | () | method |
protected function modifiersActive(event:MouseEvent, shiftKeyOK:Boolean = false, ctrlKeyOK:Boolean = false):BooleanParameters
event:MouseEvent | |
shiftKeyOK:Boolean (default = false) | |
ctrlKeyOK:Boolean (default = false) |
Boolean |
| onHandledFocus | () | method |
protected function onHandledFocus(event:NavLayoutEvent):voidonHandledFocus 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):voidParameters
event:MarqueeSelectionEvent |
| onMarqueeSelectionCancelled | () | method |
protected function onMarqueeSelectionCancelled(event:MarqueeSelectionEvent):voidParameters
event:MarqueeSelectionEvent |
| onMarqueeSelectionEnd | () | method |
protected function onMarqueeSelectionEnd(event:MarqueeSelectionEvent):voidParameters
event:MarqueeSelectionEvent |
| onMarqueeSelectionMove | () | method |
protected function onMarqueeSelectionMove(event:MarqueeSelectionEvent):voidParameters
event:MarqueeSelectionEvent |
| onNavPreviewCurrentState | () | method |
protected function onNavPreviewCurrentState(value:String):voidParameters
value:String |
| partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |
| partRemoved | () | method |
override protected function partRemoved(partName:String, instance:Object):voidParameters
partName:String | |
instance:Object |
| resetCardSizes | () | method |
protected function resetCardSizes():void| setCurrentState | () | method |
override public function setCurrentState(stateName:String, playTransition:Boolean = true):voidSets 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>):voidParameters
indices:Vector.<int> |
| STATE_DISABLED | Constant |
public static const STATE_DISABLED:String = disabled| STATE_INTRO | Constant |
public static const STATE_INTRO:String = introString literals used to represent the states of CardContainer and its skins.
| STATE_NORMAL | Constant |
public static const STATE_NORMAL:String = normal