Package | com.adobe.portfolio.lists |
Class | public class OneUpList |
Inheritance | OneUpList ![]() ![]() |
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. | OneUpList | ||
![]() | dragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
| CardList | |
![]() | enableIdle : Boolean | CardList | |
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
Default constructor
| OneUpList | ||
![]() | 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
Adds listeners and watchers that are automatically unwatched and unlistened. | CardList | |
![]() | 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]
| OneUpList | ||
![]() | 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]
| OneUpList | ||
![]() | 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 | |
itemSelected(index:int, selected:Boolean):void [override]
An empty implementation to prevent selected items from appear selected. | OneUpList | ||
![]() | 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 | |
![]() | 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 | ||
![]() | onCreationComplete(event:FlexEvent):void | CardList | |
![]() | 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 | |
![]() | onNavHostEvent(event:CollectionManagerEvent):void
Listener to handle events from the Collection Manager. | CardList | |
![]() | 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]
| OneUpList | ||
partRemoved(partName:String, instance:Object):void [override]
| OneUpList | ||
![]() | 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 | |
![]() | 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]
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 |
dataProvider | property |
dataProvider:IList
[write-only] [override] Sets the dataProvider for this list.
public function set dataProvider(value:IList):void
OneUpList | () | Constructor |
public function OneUpList()
Default constructor
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 )
|
PART_NEXT_BUTTON | Constant |
public static const PART_NEXT_BUTTON:String = nextButton
A string literal representing the name of the next button skin part.
PART_PREV_BUTTON | Constant |
public static const PART_PREV_BUTTON:String = prevButton
A string literal representing the name of the previous button skin part.
SKIN_STATE_EMPTY | Constant |
public static const SKIN_STATE_EMPTY:String = empty
A string literal representing the empty skin state.
SKIN_STATE_NORMAL | Constant |
public static const SKIN_STATE_NORMAL:String = normal
A string literal representing the normal skin state.
SKIN_STATE_PREVIEW | Constant |
public static const SKIN_STATE_PREVIEW:String = preview
A string literal representing the preview skin state.
STATE_NORMAL | Constant |
public static const STATE_NORMAL:String = normal
A string literal representing the normal state.
STATE_PREVIEW | Constant |
public static const STATE_PREVIEW:String = preview
A string literal representing the preview state.