Package | com.adobe.portfolio.lists |
Class | public class MiniNavList |
Inheritance | MiniNavList ![]() ![]() |
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. | CardList | |
![]() | dragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
| CardList | |
![]() | enableIdle : Boolean | CardList | |
heightIfPresent : Number | MiniNavList | ||
showSlammer : Boolean
A boolean used by the component's skin to determine the visibility of the slammer
| MiniNavList | ||
![]() | 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 | ||
---|---|---|---|
Constructor
| MiniNavList | ||
![]() | 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 [override]
Adds listeners and watchers that are automatically unwatched and unlistened. | MiniNavList | ||
![]() | 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 | |
ensureIndexIsVisible(index:int):void [override]
Overriding to prevent the scrolling of items according to the default list behavior. | MiniNavList | ||
![]() |
Finds the card corresponding to the attachment in focus. | CardList | |
![]() | getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Finds the folder at a given dropLocation
| CardList | |
removeListenAndWatch():void [override]
Function to cleanup the event listeners required by miniNav list. | MiniNavList | ||
![]() | 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]
| MiniNavList | ||
![]() | 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]
Returns the current state of this instance, which is a variant
of the component state depending on
whether or not the component is selected. | MiniNavList | ||
![]() | 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 | |
item_mouseDownHandler(event:MouseEvent):void [override]
| MiniNavList | ||
![]() | 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(event:CollectionEvent):void [override] | MiniNavList | ||
![]() | onCreationComplete(event:FlexEvent):void | CardList | |
onIndexChangeEvent(event:IndexChangeEvent):void [override]
This function moves focus to the item with the new index and then calls the super's onIndexChangeEvent. | MiniNavList | ||
onMouseUp(evt:MouseEvent = null):void
Event handler to handle mouse up events on miniNav. | MiniNavList | ||
![]() | 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 | |
onSlammerClick(evt:Event):void
Listener to handle the click of the slammer. | MiniNavList | ||
partAdded(partName:String, instance:Object):void [override]
| MiniNavList | ||
partRemoved(partName:String, instance:Object):void [override]
| MiniNavList | ||
performPendingUpdate():void
This function performs any pending updates that were deferred due to a drag and mouse down occuring at the same time. | MiniNavList | ||
![]() | removeListener(listener:IEventDispatcher, type:String = null):void | CardList | |
reorderAttachments(source:IList):Boolean [override]
Calls the super function in CardList to reorder the given list of attachments. | MiniNavList | ||
resizeCachedThumbs():void [override]
| MiniNavList | ||
![]() | 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 | ||
---|---|---|---|---|
hidden | MiniNavList | |||
normal | MiniNavList |
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_SLAMMER : String = slammer [static]
String literal used to represent the skin part for slammer exposed by MiniNavList
to its skins. | MiniNavList | ||
SKIN_STATE_DISABLED : String = disabled [static]
The "disabled" state of both the miniNav and its skin. | MiniNavList | ||
SKIN_STATE_HIDDEN : String = hidden [static]
The "hidden" state of both the miniNav and its skin. | MiniNavList | ||
SKIN_STATE_NORMAL : String = normal [static]
The "normal" state of both the miniNav and its skin. | MiniNavList |
heightIfPresent | property |
heightIfPresent:Number
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
This property can be used as the source for data binding.
public function get heightIfPresent():Number
public function set heightIfPresent(value:Number):void
showSlammer | property |
showSlammer:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
A boolean used by the component's skin to determine the visibility of the slammer
This property can be used as the source for data binding.
public function get showSlammer():Boolean
public function set showSlammer(value:Boolean):void
MiniNavList | () | Constructor |
public function MiniNavList()
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Constructor
addListenAndWatch | () | method |
override public function addListenAndWatch():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Adds listeners and watchers that are automatically unwatched and unlistened.
dragCompleteHandler | () | method |
override protected function dragCompleteHandler(event:DragEvent):void
Parameters
event:DragEvent |
ensureIndexIsVisible | () | method |
override public function ensureIndexIsVisible(index:int):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Overriding to prevent the scrolling of items according to the default list behavior.
Parameters
index:int |
getCurrentSkinState | () | method |
override protected function getCurrentSkinState():String
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Returns the current state of this instance, which is a variant of the component state depending on whether or not the component is selected.
ReturnsString |
item_mouseDownHandler | () | method |
override protected function item_mouseDownHandler(event:MouseEvent):void
Parameters
event:MouseEvent |
onCollectionChange | () | method |
override protected function onCollectionChange(event:CollectionEvent):void
Parameters
event:CollectionEvent |
onIndexChangeEvent | () | method |
override protected function onIndexChangeEvent(event:IndexChangeEvent):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
This function moves focus to the item with the new index and then calls the super's onIndexChangeEvent.
If mouse is down, or drag has started, index change is delayed until mouse is up and drag is complete.
This listener is called when the selection changes based on user interaction, or
when setSelectedIndexWithChangeDispatch
or setSelectedIndicesWithChangeDispatch
is used
to set the selection.
Parameters
event:IndexChangeEvent |
onMouseUp | () | method |
protected function onMouseUp(evt:MouseEvent = null):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Event handler to handle mouse up events on miniNav. Calls for pending updates deferred by a drag.
Parameters
evt:MouseEvent (default = null )
|
onSlammerClick | () | method |
protected function onSlammerClick(evt:Event):void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Listener to handle the click of the slammer. It hides or shows the mini Nav.
Parameters
evt:Event |
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 |
performPendingUpdate | () | method |
protected function performPendingUpdate():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
This function performs any pending updates that were deferred due to a drag and mouse down occuring at the same time. Drag and drop gesture is completed first.
removeListenAndWatch | () | method |
override public function removeListenAndWatch():void
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Function to cleanup the event listeners required by miniNav list. This should be called when the component is no longer needed, to prevent memory leaks.
reorderAttachments | () | method |
override protected function reorderAttachments(source:IList):Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Calls the super function in CardList
to reorder the given list of attachments.
Also, performs pending update after reordering has completed successfully.
Sends the reorder command once all the attachments are found in the given list. If items were moved between
lists, this function may have to be called repetitively until it returns true to ensure all items
have been successfully moved and the reorder command has been sent.
Parameters
source:IList — An ordered list of items in the dataProvider.
|
Boolean — True if all items are found in the given list and the reorder command was sent successfully.
|
resizeCachedThumbs | () | method |
override protected function resizeCachedThumbs():void
PART_SLAMMER | Constant |
public static const PART_SLAMMER:String = slammer
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
String literal used to represent the skin part for slammer exposed by MiniNavList to its skins.
SKIN_STATE_DISABLED | Constant |
public static const SKIN_STATE_DISABLED:String = disabled
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The "disabled" state of both the miniNav and its skin.
SKIN_STATE_HIDDEN | Constant |
public static const SKIN_STATE_HIDDEN:String = hidden
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The "hidden" state of both the miniNav and its skin. The miniNav can be hidden using the slammer.
SKIN_STATE_NORMAL | Constant |
public static const SKIN_STATE_NORMAL:String = normal
Language Version : | ActionScript 3.0 |
Product Version : | Portfolio 10.0 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
The "normal" state of both the miniNav and its skin.