Packagecom.adobe.portfolio.lists
Classpublic class MiniNavList
InheritanceMiniNavList 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 MiniNavList class extends CardList to provide functionality specific to the MiniNav component. This component is used to aid with navigation between files. It is usually added as an additional component to a navigator.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
 InheritedbindableDataGroup : DataGroup
[read-only]
CardList
 InheriteddataProvider : IList
[override] [write-only] Sets the dataProvider for this list.
CardList
 InheriteddragStarted : Boolean = false
A boolean to indicate that a drag operation is in progress
CardList
 InheritedenableIdle : Boolean
CardList
  heightIfPresent : Number
MiniNavList
  showSlammer : Boolean
A boolean used by the component's skin to determine the visibility of the slammer
MiniNavList
 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
  
Constructor
MiniNavList
 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
  
[override] Adds listeners and watchers that are automatically unwatched and unlistened.
MiniNavList
 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
  
ensureIndexIsVisible(index:int):void
[override] Overriding to prevent the scrolling of items according to the default list behavior.
MiniNavList
 Inherited
Finds the card corresponding to the attachment in focus.
CardList
 Inherited
getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Finds the folder at a given dropLocation
CardList
  
[override] Function to cleanup the event listeners required by miniNav list.
MiniNavList
 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
  
dragCompleteHandler(event:DragEvent):void
[override]
MiniNavList
 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] 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
 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
  
item_mouseDownHandler(event:MouseEvent):void
[override]
MiniNavList
 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(event:CollectionEvent):void
[override]
MiniNavList
 Inherited
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
 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
  
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
  
This function performs any pending updates that were deferred due to a drag and mouse down occuring at the same time.
MiniNavList
 Inherited
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
  
[override]
MiniNavList
 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
  
slammer:spark.components.ToggleButton
Required: false Part Type: Static
The actual skin part, "slammer", a toggle button, that is used to hide and show the miniNav.
MiniNavList
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
  
hidden
MiniNavList
  
normal
MiniNavList
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_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
Property Detail
heightIfPresentproperty
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.


Implementation
    public function get heightIfPresent():Number
    public function set heightIfPresent(value:Number):void
showSlammerproperty 
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.


Implementation
    public function get showSlammer():Boolean
    public function set showSlammer(value:Boolean):void
Constructor Detail
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

Method Detail
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.

Returns
String
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.

Returns
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

Constant Detail
PART_SLAMMERConstant
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_DISABLEDConstant 
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_HIDDENConstant 
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_NORMALConstant 
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.