| Package | com.adobe.portfolio.components |
| Class | public class MiniNavList |
| Inheritance | MiniNavList  CardList spark.components.List |
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
 | bindableDataGroup : DataGroup [read-only] | CardList | |
| dataProvider : IList [override] [write-only] | CardList | |
| dragStarted : Boolean = false Boolean to indicate dragOperation is in progress
| CardList | |
| enableIdle : Boolean | CardList | |
| heightIfPresent : Number | MiniNavList | ||
| showSlammer : Boolean [read-only] | MiniNavList | ||
| useDragDropOnFolders : Boolean = false To enable dragDrop on folders during drag
| CardList | |
| useDragDropReordering : Boolean = false To use advanced reordering
| CardList | |
| Method | Defined By | ||
|---|---|---|---|
| MiniNavList | |||
| 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 [override] | MiniNavList | ||
| 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 | |
ensureIndexIsVisible(index:int):void [override] Overriding ensureIndexIsVisible to prevent the items moving by default list behavior. | MiniNavList | ||
| CardList | ||
| getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment Gets the folder item at the drop location
| CardList | |
onMouseUp(evt:MouseEvent = null):void | MiniNavList | ||
performPendingUpdate():void | MiniNavList | ||
removeListenAndWatch():void [override] | MiniNavList | ||
| 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] | 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] 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. | MiniNavList | ||
| 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 | |
item_mouseDownHandler(event:MouseEvent):void [override] | MiniNavList | ||
| 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 | CardList | |
| onCreationComplete(event:FlexEvent):void | CardList | |
onIndexChangeEvent(event:IndexChangeEvent):void [override] Set Focus on index change. | MiniNavList | ||
| onNavHostEvent(event:NavHostEvent):void | CardList | |
| onOpenFolderTimeComplete(evt:TimerEvent):void | CardList | |
| onResize(event:ResizeEvent):void | CardList | |
onSlammerClick(evt:Event):void onSlammerClick is used to handle the click of the slammer. | MiniNavList | ||
partAdded(partName:String, instance:Object):void [override] Called when a skin has added a skin part for this instance. | MiniNavList | ||
partRemoved(partName:String, instance:Object):void [override] Called when a skin has removed a skin part for this instance. | MiniNavList | ||
| removeListener(listener:IEventDispatcher, type:String = null):void | CardList | |
reorderAttachments(source:IList):Boolean [override] | 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.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
slammer:spark.components.ToggleButton | Required: false Part Type: Static A button for hiding and showing the Mini Nav. | MiniNavList | ||
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] | MiniNavList | ||
| SKIN_STATE_DISABLED : String = disabled [static] | MiniNavList | ||
| SKIN_STATE_HIDDEN : String = hidden [static] | MiniNavList | ||
| SKIN_STATE_NORMAL : String = normal [static] | MiniNavList | ||
| heightIfPresent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesheightIfPresent:NumberThis 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 [read-only] This property can be used as the source for data binding.
public function get showSlammer():Boolean| MiniNavList | () | Constructor |
public function MiniNavList()| addListenAndWatch | () | method |
override public function addListenAndWatch():void| dragCompleteHandler | () | method |
override protected function dragCompleteHandler(event:DragEvent):voidParameters
event:DragEvent |
| ensureIndexIsVisible | () | method |
override public function ensureIndexIsVisible(index:int):voidOverriding ensureIndexIsVisible to prevent the items moving by default list behavior.
Parameters
index:int |
| getCurrentSkinState | () | method |
override protected function getCurrentSkinState():StringReturns the current state of this instance, since its skins should have a matching set of states.
ReturnsString |
| item_mouseDownHandler | () | method |
override protected function item_mouseDownHandler(event:MouseEvent):voidParameters
event:MouseEvent |
| onIndexChangeEvent | () | method |
override protected function onIndexChangeEvent(event:IndexChangeEvent):voidSet Focus on index change. Delay index change until mouse is up or drag is completed.
Parameters
event:IndexChangeEvent |
| onMouseUp | () | method |
public function onMouseUp(evt:MouseEvent = null):voidParameters
evt:MouseEvent (default = null) |
| onSlammerClick | () | method |
protected function onSlammerClick(evt:Event):voidonSlammerClick is used 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):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 |
| performPendingUpdate | () | method |
public function performPendingUpdate():void| removeListenAndWatch | () | method |
override public function removeListenAndWatch():void| reorderAttachments | () | method |
override protected function reorderAttachments(source:IList):BooleanParameters
source:IList |
Boolean |
| resizeCachedThumbs | () | method |
override protected function resizeCachedThumbs():void| PART_SLAMMER | Constant |
public static const PART_SLAMMER:String = slammer| SKIN_STATE_DISABLED | Constant |
public static const SKIN_STATE_DISABLED:String = disabled| SKIN_STATE_HIDDEN | Constant |
public static const SKIN_STATE_HIDDEN:String = hidden| SKIN_STATE_NORMAL | Constant |
public static const SKIN_STATE_NORMAL:String = normal