Package | com.adobe.portfolio.lists |
Class | public class CardContainer |
Inheritance | CardContainer ![]() ![]() |
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]
Sets the dataProvider for this list. | CardList | |
![]() | dragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
| CardList | |
![]() | enableIdle : Boolean | CardList | |
navPreview : NavPreview | CardContainer | ||
![]() | useDragDropOnFolders : Boolean = false
To enable dragDrop on folders during a drag operation. | CardList | |
![]() | useDragDropReordering : Boolean = false
To allow for reordering of items using simple drag and drop gestures. | CardList |
Property | Defined By | ||
---|---|---|---|
![]() | autoListen : AutoListen | CardList | |
![]() | autoWatch : AutoWatch | CardList | |
![]() | cardLayout : ICardLayout | CardList | |
![]() | cardLayoutHelper : CardLayoutHelper | CardList | |
cardSize : String | CardContainer | ||
![]() | focusCardDelta : int | CardList | |
![]() | isDragAndDropDisabled : Boolean [static] [read-only]
True if drag and drop has been temporarily disabled for card lists. | CardList |
Method | Defined By | ||
---|---|---|---|
Constructor
| CardContainer | ||
![]() | addDragData(dragSource:DragSource):void [override]
Takes the data set by the list for ordered items and adds it to the attachments
data format. | CardList | |
addListenAndWatch():void [override]
Adds listeners and watchers that are automatically unwatched and unlistened. | CardContainer | ||
![]() | calculateDropLocation(event:DragEvent):DropLocation
Calculate the dropLocation of the given dragEvent. | CardList | |
![]() | cardFromAttachment(_dataGroup:DataGroup, attachment:Object):ISimpleCard [static]
Finds the card associated with the given attachment
| CardList | |
![]() | collectionDropEnabled(event:DragEvent):Boolean
Helper function that determines whether drag drop is supported
| CardList | |
![]() | createDropIndicator():DisplayObject [override]
Creates a custom dropIndicator for the cardList. | CardList | |
![]() | disableDragAndDrop():void [static]
Functions used to disable and enable drag and drop. | CardList | |
![]() | enableDragAndDrop():void [static] | CardList | |
![]() |
Finds the card corresponding to the attachment in focus. | CardList | |
![]() | getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Finds the folder at a given dropLocation
| CardList | |
![]() | removeListenAndWatch():void
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 | ||
![]() | setSelectedIndexWithChangeDispatch(value:int):void
Force selection change. | CardList | |
![]() | setSelectedIndicesWithChangeDispatch(value:Vector.<int>):void
Force selection change. | 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]
Does not start drag if some other component has disabled it. | CardList | |
getCurrentSkinState():String [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 | ||
![]() | handleDragDropReordering(event:DragEvent):void
Handles the reordering of items after a dragDrop. | CardList | |
![]() | handleDropOnFolder(folder:IAttachment, event:DragEvent):IList
Handles drop on a folder. | CardList | |
![]() | handleFocusChange(event:CollectionManagerEvent):void
Triggers generation of thumbnails around the new focus card. | CardList | |
![]() | handleSelectionChanged():void
Updates the host's 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):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 | ||
![]() | onChildrenCollectionChange(event:CollectionEvent):void
This function is used when attachments are moved across folders. | CardList | |
![]() | onCollectionChange(e:CollectionEvent):void
Listener to handle collection change events. | CardList | |
![]() | onCreationComplete(event:FlexEvent):void | CardList | |
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. | CardContainer | ||
![]() | 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 | |
onMarqueeSelectionBegin(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionCancelled(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionEnd(event:MarqueeSelectionEvent):void | CardContainer | ||
onMarqueeSelectionMove(event:MarqueeSelectionEvent):void | CardContainer | ||
![]() | onNavHostEvent(event:CollectionManagerEvent):void
Listener to handle events from the Collection Manager. | CardList | |
onNavPreviewCurrentState(value:String):void | CardContainer | ||
![]() | onOpenFolderTimeComplete(evt:TimerEvent):void
Called when the openFolderTimer completes. | CardList | |
![]() | onResize(event:ResizeEvent):void | CardList | |
![]() | 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 | ||
![]() | removeListener(listener:IEventDispatcher, type:String = null):void | CardList | |
![]() | reorderAttachments(source:IList):Boolean
Sends 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 | |
shiftOrCtrlDownButNotBoth(event:MarqueeSelectionEvent):Boolean | CardContainer | ||
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 MarqueeSelection (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]
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 |
cardSize | property |
protected var cardSize:String
navPreview | property |
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.
public function get navPreview():NavPreview
public function set navPreview(value:NavPreview):void
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
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.
ReturnsString |
growOrShrinkSelection | () | method |
protected function growOrShrinkSelection(event:MarqueeSelectionEvent, indices:Vector.<int>):Vector.<int>
Parameters
event:MarqueeSelectionEvent | |
indices:Vector.<int> |
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 )
|
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 |
Boolean |
updateMultiSelection | () | method |
protected function updateMultiSelection(indices:Vector.<int>):void
Parameters
indices:Vector.<int> |
STATE_DISABLED | Constant |
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_INTRO | Constant |
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_NORMAL | Constant |
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.