| Package | com.adobe.portfolio.components |
| Class | public class OneUpList |
| Inheritance | OneUpList CardList spark.components.List |
| 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] | OneUpList | ||
![]() | dragStarted : Boolean = false Boolean to indicate dragOperation is in progress
| CardList | |
![]() | enableIdle : Boolean | CardList | |
![]() | useDragDropOnFolders : Boolean = false To enable dragDrop on folders during drag
| CardList | |
![]() | useDragDropReordering : Boolean = false To use advanced reordering
| CardList | |
| Method | Defined By | ||
|---|---|---|---|
| OneUpList | |||
![]() | 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 | CardList | |
![]() | 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. | OneUpList | ||
![]() | 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. | OneUpList | ||
![]() | 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 | |
itemSelected(index:int, selected:Boolean):void [override] | OneUpList | ||
![]() | keyDownHandler(event:KeyboardEvent):void [override] | CardList | |
![]() | makeNewOrderedList(dropIndex:int, droppingItems:ArrayCollection, dragInitiator:IUIComponent):IList
Creates an ordered list of items after the drop. | CardList | |
![]() | 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 | ||
![]() | onCreationComplete(event:FlexEvent):void | CardList | |
![]() | onIndexChangeEvent(event:IndexChangeEvent):void | CardList | |
![]() | onNavHostEvent(event:NavHostEvent):void | CardList | |
![]() | onOpenFolderTimeComplete(evt:TimerEvent):void | CardList | |
![]() | 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 | ||
![]() | 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 | |
![]() | resizeCachedThumbs():void | CardList | |
![]() | setFocusOnIndexChange(attachment:IAttachment):void | CardList | |
![]() | 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.
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 | |||
| 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 | |
| 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 | ||
| dataProvider | property |
dataProvider:IList [write-only] [override] public function set dataProvider(value:IList):void| OneUpList | () | Constructor |
public function OneUpList()| getCurrentSkinState | () | method |
override protected function getCurrentSkinState():StringReturns the current state of this instance, since its skins should have a matching set of states.
ReturnsString |
| itemSelected | () | method |
override protected function itemSelected(index:int, selected:Boolean):voidParameters
index:int | |
selected:Boolean |
| onCollectionChange | () | method |
override protected function onCollectionChange(e:CollectionEvent):voidParameters
e:CollectionEvent |
| partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):voidCalled 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):voidCalled 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):voidSets the state of the skin as well as the state of this instance.
Parameters
stateName:String | |
playTransition:Boolean (default = true) |
| PART_NEXT_BUTTON | Constant |
public static const PART_NEXT_BUTTON:String = nextButton| PART_PREV_BUTTON | Constant |
public static const PART_PREV_BUTTON:String = prevButtonString 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_EMPTY | Constant |
public static const SKIN_STATE_EMPTY:String = empty| SKIN_STATE_NORMAL | Constant |
public static const SKIN_STATE_NORMAL:String = normal| SKIN_STATE_PREVIEW | Constant |
public static const SKIN_STATE_PREVIEW:String = preview| STATE_NORMAL | Constant |
public static const STATE_NORMAL:String = normalString literals used to represent the states of OneUp and its skins. XXX They should match the SkinState references above.
| STATE_PREVIEW | Constant |
public static const STATE_PREVIEW:String = preview