Packagecom.adobe.portfolio.lists
Classpublic class FreeFormList
InheritanceFreeFormList 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 FreeFormList class extends CardContainer to provide functionality specific to the Freeform 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
  mouseDownPoint : Point
FreeFormList
  selectedItemLocations : Dictionary
FreeFormList
  selectionExtensionAnchorIndex : int = -1
FreeFormList
Public Methods
 MethodDefined By
  
Constructor.
FreeFormList
 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
 Inherited
[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
  
createDragIndicator():IFlexDisplayObject
[override]
FreeFormList
  
createDropIndicator():DisplayObject
[override] Creates a custom dropIndicator for the cardList.
FreeFormList
 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.
FreeFormList
 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
  
FreeFormList
 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
  
dragDropHandler(event:DragEvent):void
[override]
FreeFormList
 Inherited
dragEnterHandler(event:DragEvent):void
[override]
CardList
  
dragExitHandler(event:DragEvent):void
[override]
FreeFormList
 Inherited
dragOverHandler(event:DragEvent):void
[override]
CardList
  
dragStartHandler(event:DragEvent):void
[override]
FreeFormList
  
extendSelection(event:MouseEvent):void
FreeFormList
  
extendSelectionToHere(newIndex:int):void
FreeFormList
  
[override] Returns the current state of this instance, since its skins should have a matching set of states.
FreeFormList
 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]
FreeFormList
  
keyDownHandler(event:KeyboardEvent):void
[override]
FreeFormList
 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
  
moveSelectedItemLocations(event:MouseEvent):void
FreeFormList
 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
 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
  
onIndexChangeEvent(event:IndexChangeEvent):void
[override]
FreeFormList
  
[override]
FreeFormList
 Inherited
CardContainer
 Inherited
CardContainer
 Inherited
CardContainer
  
onMouseMove(event:MouseEvent):void
FreeFormList
  
onMouseRollOut(event:MouseEvent):void
FreeFormList
  
onMouseRollOver(event:MouseEvent):void
FreeFormList
  
onMouseUp(event:MouseEvent):void
FreeFormList
 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
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
FreeFormList
  
partRemoved(partName:String, instance:Object):void
[override] Called when a skin has removed a skin part for this instance.
FreeFormList
  
FreeFormList
 Inherited
removeListener(listener:IEventDispatcher, type:String = null):void
CardList
  
rendererWasAdded(visualElement:IVisualElement):void
FreeFormList
  
rendererWasRemoved(visualElement:IVisualElement):void
FreeFormList
 Inherited
reorderAttachments(source:IList):Boolean
Sends the reorder command once all the attachments are found in the given list.
CardList
  
[override]
FreeFormList
 Inherited
CardList
  
saveSelectedItemLocations(event:MouseEvent):void
FreeFormList
 Inherited
CardList
 Inherited
CardContainer
  
updateMultiSelection(selectedItems:Vector.<int>):void
[override]
FreeFormList
 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
Protected Constants
 ConstantDefined By
  logger : ILogger
[static]
FreeFormList
Property Detail
mouseDownPointproperty
protected var mouseDownPoint:Point

selectedItemLocationsproperty 
protected var selectedItemLocations:Dictionary

selectionExtensionAnchorIndexproperty 
protected var selectionExtensionAnchorIndex:int = -1

Constructor Detail
FreeFormList()Constructor
public function FreeFormList()

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

Constructor.

Method Detail
addDragListeners()method
protected function addDragListeners():void

createDragIndicator()method 
override public function createDragIndicator():IFlexDisplayObject

Returns
IFlexDisplayObject
createDropIndicator()method 
override public function createDropIndicator():DisplayObject

Creates a custom dropIndicator for the cardList.

Returns
DisplayObject
dragDropHandler()method 
override protected function dragDropHandler(event:DragEvent):void

Parameters

event:DragEvent

dragExitHandler()method 
override protected function dragExitHandler(event:DragEvent):void

Parameters

event:DragEvent

dragStartHandler()method 
override protected function dragStartHandler(event:DragEvent):void

Parameters

event:DragEvent

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

Parameters

event:MouseEvent

extendSelectionToHere()method 
protected function extendSelectionToHere(newIndex:int):void

Parameters

newIndex:int

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
item_mouseDownHandler()method 
override protected function item_mouseDownHandler(event:MouseEvent):void

Parameters

event:MouseEvent

keyDownHandler()method 
override protected function keyDownHandler(event:KeyboardEvent):void

Parameters

event:KeyboardEvent

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

Parameters

event:MouseEvent

onIndexChangeEvent()method 
override protected function onIndexChangeEvent(event:IndexChangeEvent):void

Parameters

event:IndexChangeEvent

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

Parameters

event:MarqueeSelectionEvent

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

Parameters

event:MouseEvent

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

Parameters

event:MouseEvent

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

Parameters

event:MouseEvent

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

Parameters

event:MouseEvent

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

Called when a skin has added a skin part for this instance.

Parameters

partName:String
 
instance:Object

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

Called when a skin has removed a skin part for this instance.

Parameters

partName:String
 
instance:Object

removeDragListeners()method 
protected function removeDragListeners():void

rendererWasAdded()method 
protected function rendererWasAdded(visualElement:IVisualElement):void

Parameters

visualElement:IVisualElement

rendererWasRemoved()method 
protected function rendererWasRemoved(visualElement:IVisualElement):void

Parameters

visualElement:IVisualElement

resetCardSizes()method 
override protected function resetCardSizes():void

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

Parameters

event:MouseEvent

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)

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

Parameters

selectedItems:Vector.<int>

Constant Detail
loggerConstant
protected static const logger:ILogger