Packagecom.adobe.portfolio.lists
Classpublic class OneUpList
InheritanceOneUpList 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 OneUpList class extends CardList to implement functionality specific to the BasicClickThrough navigator.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
 InheritedbindableDataGroup : DataGroup
[read-only]
CardList
  dataProvider : IList
[override] [write-only] Sets the dataProvider for this list.
OneUpList
 InheriteddragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
CardList
 InheritedenableIdle : Boolean
CardList
 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
 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
  
Default constructor
OneUpList
 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
Adds listeners and watchers that are automatically unwatched and unlistened.
CardList
 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]
OneUpList
 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]
OneUpList
 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
  
itemSelected(index:int, selected:Boolean):void
[override] An empty implementation to prevent selected items from appear selected.
OneUpList
 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
 Inherited
onChildrenCollectionChange(event:CollectionEvent):void
This function is used when attachments are moved across folders.
CardList
  
onCollectionChange(e:CollectionEvent):void
[override] Listener to handle collection change events.
OneUpList
 Inherited
onCreationComplete(event:FlexEvent):void
CardList
 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
 Inherited
Listener to handle events from the Collection Manager.
CardList
 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]
OneUpList
  
partRemoved(partName:String, instance:Object):void
[override]
OneUpList
 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
 Inherited
CardList
 Inherited
CardList
 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
  
nextButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the next attachment, optionally provided by this instance's skin.
OneUpList
  
prevButton:mx.core.IButton
Required: false Part Type: Static
A button for navigating to the previous attachment, optionally provided by this instance's skin.
OneUpList
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
  
empty
OneUpList
  
normal
OneUpList
  
preview
OneUpList
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
  PART_NEXT_BUTTON : String = nextButton
[static] A string literal representing the name of the next button skin part.
OneUpList
  PART_PREV_BUTTON : String = prevButton
[static] A string literal representing the name of the previous button skin part.
OneUpList
  SKIN_STATE_EMPTY : String = empty
[static] A string literal representing the empty skin state.
OneUpList
  SKIN_STATE_NORMAL : String = normal
[static] A string literal representing the normal skin state.
OneUpList
  SKIN_STATE_PREVIEW : String = preview
[static] A string literal representing the preview skin state.
OneUpList
  STATE_NORMAL : String = normal
[static] A string literal representing the normal state.
OneUpList
  STATE_PREVIEW : String = preview
[static] A string literal representing the preview state.
OneUpList
Property Detail
dataProviderproperty
dataProvider:IList  [write-only] [override]

Sets the dataProvider for this list.


Implementation
    public function set dataProvider(value:IList):void
Constructor Detail
OneUpList()Constructor
public function OneUpList()

Default constructor

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

Returns
String
itemSelected()method 
override protected function itemSelected(index:int, selected:Boolean):void

An empty implementation to prevent selected items from appear selected.

Parameters

index:int
 
selected:Boolean

onCollectionChange()method 
override protected function onCollectionChange(e:CollectionEvent):void

Listener to handle collection change events.

Parameters

e:CollectionEvent

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

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

Parameters

stateName:String
 
playTransition:Boolean (default = true)

Constant Detail
PART_NEXT_BUTTONConstant
public static const PART_NEXT_BUTTON:String = nextButton

A string literal representing the name of the next button skin part.

PART_PREV_BUTTONConstant 
public static const PART_PREV_BUTTON:String = prevButton

A string literal representing the name of the previous button skin part.

SKIN_STATE_EMPTYConstant 
public static const SKIN_STATE_EMPTY:String = empty

A string literal representing the empty skin state.

SKIN_STATE_NORMALConstant 
public static const SKIN_STATE_NORMAL:String = normal

A string literal representing the normal skin state.

SKIN_STATE_PREVIEWConstant 
public static const SKIN_STATE_PREVIEW:String = preview

A string literal representing the preview skin state.

STATE_NORMALConstant 
public static const STATE_NORMAL:String = normal

A string literal representing the normal state.

STATE_PREVIEWConstant 
public static const STATE_PREVIEW:String = preview

A string literal representing the preview state.