Packagecom.adobe.portfolio.components
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]
OneUpList
 InheriteddragStarted : Boolean = false
Boolean to indicate dragOperation is in progress
CardList
 InheritedenableIdle : Boolean
CardList
 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
 InheritedfocusCardDelta : int
CardList
Public Methods
 MethodDefined By
  
OneUpList
 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
 Inherited
CardList
 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.
OneUpList
 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.
OneUpList
 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
  
itemSelected(index:int, selected:Boolean):void
[override]
OneUpList
 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
 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
  
onCollectionChange(e:CollectionEvent):void
[override]
OneUpList
 Inherited
onCreationComplete(event:FlexEvent):void
CardList
 Inherited
onIndexChangeEvent(event:IndexChangeEvent):void
CardList
 Inherited
CardList
 Inherited
onOpenFolderTimeComplete(evt:TimerEvent):void
CardList
 Inherited
onResize(event:ResizeEvent):void
CardList
  
partAdded(partName:String, instance:Object):void
[override] Called when a skin has added a skin part for this instance.
OneUpList
  
partRemoved(partName:String, instance:Object):void
[override] Called when a skin has removed a skin part for this instance.
OneUpList
 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
 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]
OneUpList
  PART_PREV_BUTTON : String = prevButton
[static] String literals used to represent the skin parts exposed by OneUp to its skins.
OneUpList
  SKIN_STATE_EMPTY : String = empty
[static]
OneUpList
  SKIN_STATE_NORMAL : String = normal
[static]
OneUpList
  SKIN_STATE_PREVIEW : String = preview
[static]
OneUpList
  STATE_NORMAL : String = normal
[static] String literals used to represent the states of OneUp and its skins.
OneUpList
  STATE_PREVIEW : String = preview
[static]
OneUpList
Property Detail
dataProviderproperty
dataProvider:IList  [write-only] [override]


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



Method Detail
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
itemSelected()method 
override protected function itemSelected(index:int, selected:Boolean):void

Parameters

index:int
 
selected:Boolean

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

Parameters

e:CollectionEvent

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

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)

Constant Detail
PART_NEXT_BUTTONConstant
public static const PART_NEXT_BUTTON:String = nextButton

PART_PREV_BUTTONConstant 
public static const PART_PREV_BUTTON:String = prevButton

String literals used to represent the skin parts exposed by OneUp to its skins. XXX They should match the names of the SkinPart vars below.

SKIN_STATE_EMPTYConstant 
public static const SKIN_STATE_EMPTY:String = empty

SKIN_STATE_NORMALConstant 
public static const SKIN_STATE_NORMAL:String = normal

SKIN_STATE_PREVIEWConstant 
public static const SKIN_STATE_PREVIEW:String = preview

STATE_NORMALConstant 
public static const STATE_NORMAL:String = normal

String literals used to represent the states of OneUp and its skins. XXX They should match the SkinState references above.

STATE_PREVIEWConstant 
public static const STATE_PREVIEW:String = preview