Packagecom.adobe.portfolio.components
Classpublic class NavPreview
InheritanceNavPreview Inheritance CardContainer 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 NavPreview class extends CardContainer to preview the current focus card, scroll to next and previous cards, and to view the contents of folders.

Default MXML PropertydataProvider


Public Properties
 PropertyDefined By
 InheritedbindableDataGroup : DataGroup
[read-only]
CardList
  cardZoomFrom : Rect
[read-only]
NavPreview
  dataProvider : IList
[override]
NavPreview
 InheriteddragStarted : Boolean = false
Boolean to indicate dragOperation is in progress
CardList
  enableDataProvider : Boolean
NavPreview
 InheritedenableIdle : Boolean
CardList
  focusAttachment : IAttachment
NavPreview
 InheritednavPreview : NavPreview
CardContainer
  previewCardSize : Point
NavPreview
  previewFolderSize : Point
NavPreview
  rootDataGroup : DataGroup
NavPreview
  showCardPreviewAtRoot : Boolean
[read-only]
NavPreview
 InheriteduseDragDropOnFolders : Boolean = false
To enable dragDrop on folders during drag
CardList
 InheriteduseDragDropReordering : Boolean = false
To use advanced reordering
CardList
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
CardList
 InheritedautoWatch : AutoWatch
CardList
 InheritedcardLayout : ICardLayout
CardList
 InheritedcardLayoutHelper : CardLayoutHelper
CardList
 InheritedcardSize : String
CardContainer
 InheritedfocusCardDelta : int
CardList
  focusChangeEffect : Effect
NavPreview
  isInPreviewState : Boolean
[read-only]
NavPreview
  isSkinEffectPlaying : Boolean
[read-only]
NavPreview
  nextCardPreviewEffect : Effect
[read-only]
NavPreview
  prevCardPreviewEffect : Effect
[read-only]
NavPreview
  previewCardInvalid : Boolean
NavPreview
  thumbnailManager : ThumbnailManager
NavPreview
Public Methods
 MethodDefined By
  
NavPreview()
NavPreview
 Inherited
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]
NavPreview
 Inherited
calculateDropLocation(event:DragEvent):DropLocation
Calculate the dropLocation of the dragEvent.
CardList
 Inherited
cardFromAttachment(_dataGroup:DataGroup, attachment:Object):ISimpleCard
[static]
CardList
 Inherited
collectionDropEnabled(event:DragEvent):Boolean
Helper function that determines whether drag drop is supported
CardList
 Inherited
createDropIndicator():DisplayObject
[override]
CardList
 Inherited
disableDragAndDrop():void
[static]
CardList
 Inherited
enableDragAndDrop():void
[static]
CardList
 Inherited
findCardWithAttachmentFocus():SimpleCard
CardList
 Inherited
getFolderItemAtDragLocation(dropLocation:DropLocation):IAttachment
Gets the folder item at the drop location
CardList
 Inherited
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.
NavPreview
  
setPreviewTo(force:Boolean = false):void
NavPreview
 Inherited
setSelectedIndexWithChangeDispatch(value:int):void
CardList
 Inherited
setSelectedIndicesWithChangeDispatch(value:Vector.<int>):void
CardList
  
transitionCurrentState(metaState:String):void
NavPreview
 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
  
commitProperties():void
[override]
NavPreview
  
currentStateIsCardPreview():Boolean
NavPreview
  
dataProvider_collectionChangeHandler(event:Event):void
[override]
NavPreview
 Inherited
dataProviderIsCurrent():Boolean
Returns true if the dataProvider for this list matches the CollectionMgr's currentItems.
CardList
 Inherited
dragCompleteHandler(event:DragEvent):void
[override]
CardList
 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] Overriding the dragStartHandler to set a boolean to indicate that drag has started
CardList
  
focusChanged(newFocusAttachment:IAttachment):void
NavPreview
  
focusChangedInPreview(newFocusAttachment:IAttachment):void
NavPreview
  
getCurrentSkinState():String
[override] Returns the current state of this instance, since its skins should have a matching set of states.
NavPreview
  
getFocusPreview():IPreview
NavPreview
 Inherited
handleDragDropReordering(event:DragEvent):void
Handles the actual dragDrop.
CardList
 Inherited
handleDropOnFolder(folder:IAttachment, event:DragEvent):IList
Handles drop on a folder
CardList
 Inherited
handleFocusChange(event:NavHostEvent):void
CardList
 Inherited
handleSelectionChanged():void
Updates the host selection based on the current list selection.
CardList
 Inherited
initializeSelectionFromHost():Boolean
CardList
 Inherited
initStates():void
CardContainer
  
invalidatePreviewCard():void
NavPreview
 Inherited
keyDownHandler(event:KeyboardEvent):void
[override]
CardList
 Inherited
makeNewOrderedList(dropIndex:int, droppingItems:ArrayCollection, dragInitiator:IUIComponent):IList
Creates an ordered list of items after the drop.
CardList
 Inherited
modifiersActive(event:MouseEvent, shiftKeyOK:Boolean = false, ctrlKeyOK:Boolean = false):Boolean
CardContainer
  
onAspectRatioChanged(event:PropertyChangeEvent):void
NavPreview
  
onButtonDragExit(event:DragEvent):void
Close button is in the child hierarchy of the NavPreview.
NavPreview
 Inherited
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
  
onCloseButton(event:MouseEvent):void
NavPreview
 Inherited
onCollectionChange(e:CollectionEvent):void
CardList
 Inherited
onCreationComplete(event:FlexEvent):void
CardList
  
onDragOver(event:DragEvent):void
NavPreview
  
onFieldValueChanged(e:FieldValueChangedEvent):void
NavPreview
 Inherited
onHandledFocus(event:NavLayoutEvent):void
onHandledFocus is used to ensure that the layout has successfully handled the layout of its initial focused attachment before transitioning in the remaining pieces of UI.
CardContainer
 Inherited
onIndexChangeEvent(event:IndexChangeEvent):void
CardList
  
onKeyDown(event:KeyboardEvent):void
NavPreview
 Inherited
onMarqueeSelectionBegin(event:MarqueeSelectionEvent):void
CardContainer
 Inherited
onMarqueeSelectionCancelled(event:MarqueeSelectionEvent):void
CardContainer
 Inherited
onMarqueeSelectionEnd(event:MarqueeSelectionEvent):void
CardContainer
 Inherited
onMarqueeSelectionMove(event:MarqueeSelectionEvent):void
CardContainer
  
onMouseClick(event:MouseEvent):void
NavPreview
  
onNavHostEvent(event:NavHostEvent):void
[override]
NavPreview
 Inherited
onNavPreviewCurrentState(value:String):void
CardContainer
  
onOpenFile(event:MouseEvent):void
NavPreview
 Inherited
onOpenFolderTimeComplete(evt:TimerEvent):void
CardList
  
onPreviewCardClose(event:Event):void
NavPreview
  
onPreviewCardDataChanged(val:Object):void
NavPreview
  
onPreviewCardEffectEnd(event:EffectEvent):void
NavPreview
  
onPreviewCardResize(event:ResizeEvent):void
NavPreview
  
onResize(event:ResizeEvent):void
[override]
NavPreview
  
onTimerComplete(event:TimerEvent):void
NavPreview
  
partAdded(partName:String, instance:Object):void
[override]
NavPreview
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
CardContainer
 Inherited
removeListener(listener:IEventDispatcher, type:String = null):void
CardList
 Inherited
reorderAttachments(source:IList):Boolean
Send the reorder command once all the attachments are found in the given list
CardList
 Inherited
resetCardSizes():void
CardContainer
  
resizeCachedThumbs():void
[override]
NavPreview
  
setElementBounds(element:IVisualElement, elementSize:Point):void
NavPreview
 Inherited
setFocusOnIndexChange(attachment:IAttachment):void
CardList
  
stopPlayback():void
NavPreview
 Inherited
updateMultiSelection(indices:Vector.<int>):void
CardContainer
 Inherited
updateSelection():void
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
  
cardShield:spark.components.Group
Required: false Part Type: Static

NavPreview
  
closeButton:spark.components.Button
Required: false Part Type: Static

NavPreview
  
fileNameLabel:spark.components.Label
Required: false Part Type: Static

NavPreview
  
folderShield:spark.components.Group
Required: false Part Type: Static

NavPreview
 Inherited
marqueeSelection:MarqueeSelection
Required: false Part Type: Static
A rect (with frame and shaded center) used to highlight the area of a marquee select.
CardContainer
  
nextButton:spark.components.Button
Required: false Part Type: Static

NavPreview
  
openFileButton:spark.components.Button
Required: false Part Type: Static

NavPreview
  
prevButton:spark.components.Button
Required: false Part Type: Static

NavPreview
  
previewCard:IPreviewCard
Required: false Part Type: Static

NavPreview
  
previewFolder:spark.components.Group
Required: false Part Type: Static

NavPreview
  
previewFolderCard:FolderCard
Required: false Part Type: Static

NavPreview
  
previewHUD:PreviewHUD
Required: false Part Type: Static

NavPreview
  
tempPreviewCard:IPreviewCard
Required: false Part Type: Static

NavPreview
  
tempPreviewFolderCard:FolderCard
Required: false Part Type: Static

NavPreview
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
  
cardPreview
NavPreview
  
disabled
NavPreview
  
folderCardPreview
NavPreview
  
folderPreview
NavPreview
 Inherited
intro
CardContainer
 Inherited
normal
CardContainer
Public Constants
 ConstantDefined By
 InheritedcollectionMgr : CollectionManager
The navigator's CollectionManager instance.
CardList
  DRAG_DROP_ATTACHMENTS : String = attachments
[static] Format that defines the set of Acrobat drag and drop attachments.
NavPreview
 InheritedDRAG_DROP_ITEMS : String = itemsByIndex
[static] Format that defines the default set of List drag and drop items.
CardList
  NON_DYNAMIC_THUMBSIZE : int = 512
[static]
NavPreview
  STATE_CARD_PREVIEW : String = cardPreview
[static]
NavPreview
  STATE_DISABLED : String = disabled
[static]
NavPreview
  STATE_FOLDER_CARD_PREVIEW : String = folderCardPreview
[static]
NavPreview
  STATE_FOLDER_PREVIEW : String = folderPreview
[static]
NavPreview
 InheritedSTATE_INTRO : String = intro
[static] String literals used to represent the states of CardContainer and its skins.
CardContainer
 InheritedSTATE_NORMAL : String = normal
[static]
CardContainer
Protected Constants
 ConstantDefined By
  logger : ILogger
[static]
NavPreview
Property Detail
cardZoomFromproperty
cardZoomFrom:Rect  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get cardZoomFrom():Rect
dataProviderproperty 
dataProvider:IList[override]

This property can be used as the source for data binding.


Implementation
    public function get dataProvider():IList
    public function set dataProvider(value:IList):void
enableDataProviderproperty 
enableDataProvider:Boolean


Implementation
    public function get enableDataProvider():Boolean
    public function set enableDataProvider(value:Boolean):void
focusAttachmentproperty 
focusAttachment:IAttachment

This property can be used as the source for data binding.


Implementation
    public function get focusAttachment():IAttachment
    public function set focusAttachment(value:IAttachment):void
focusChangeEffectproperty 
protected var focusChangeEffect:Effect

isInPreviewStateproperty 
isInPreviewState:Boolean  [read-only]


Implementation
    protected function get isInPreviewState():Boolean
isSkinEffectPlayingproperty 
isSkinEffectPlaying:Boolean  [read-only]


Implementation
    protected function get isSkinEffectPlaying():Boolean
nextCardPreviewEffectproperty 
nextCardPreviewEffect:Effect  [read-only]


Implementation
    protected function get nextCardPreviewEffect():Effect
prevCardPreviewEffectproperty 
prevCardPreviewEffect:Effect  [read-only]


Implementation
    protected function get prevCardPreviewEffect():Effect
previewCardInvalidproperty 
protected var previewCardInvalid:Boolean

previewCardSizeproperty 
previewCardSize:Point

This property can be used as the source for data binding.


Implementation
    public function get previewCardSize():Point
    public function set previewCardSize(value:Point):void
previewFolderSizeproperty 
previewFolderSize:Point

This property can be used as the source for data binding.


Implementation
    public function get previewFolderSize():Point
    public function set previewFolderSize(value:Point):void
rootDataGroupproperty 
rootDataGroup:DataGroup


Implementation
    public function get rootDataGroup():DataGroup
    public function set rootDataGroup(value:DataGroup):void
showCardPreviewAtRootproperty 
showCardPreviewAtRoot:Boolean  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get showCardPreviewAtRoot():Boolean
thumbnailManagerproperty 
protected var thumbnailManager:ThumbnailManager

Constructor Detail
NavPreview()Constructor
public function NavPreview()



Method Detail
addListenAndWatch()method
override public function addListenAndWatch():void

commitProperties()method 
override protected function commitProperties():void

currentStateIsCardPreview()method 
protected function currentStateIsCardPreview():Boolean

Returns
Boolean
dataProvider_collectionChangeHandler()method 
override protected function dataProvider_collectionChangeHandler(event:Event):void

Parameters

event:Event

focusChanged()method 
protected function focusChanged(newFocusAttachment:IAttachment):void

Parameters

newFocusAttachment:IAttachment

focusChangedInPreview()method 
protected function focusChangedInPreview(newFocusAttachment:IAttachment):void

Parameters

newFocusAttachment:IAttachment

getCurrentSkinState()method 
override protected function getCurrentSkinState():String

Returns the current state of this instance, since its skins should have a matching set of states.

Returns
String
getFocusPreview()method 
protected function getFocusPreview():IPreview

Returns
IPreview
invalidatePreviewCard()method 
protected function invalidatePreviewCard():void

onAspectRatioChanged()method 
protected function onAspectRatioChanged(event:PropertyChangeEvent):void

Parameters

event:PropertyChangeEvent

onButtonDragExit()method 
protected function onButtonDragExit(event:DragEvent):void

Close button is in the child hierarchy of the NavPreview. It does not receive a dragExit until we exit from NavPreview. The only way we can know if we exited from the close button is when we didnt receive a dragOver event on the button, but received a dragOverEvent on NavPreview. Use the below logic to reset the timer

Parameters

event:DragEvent

onCloseButton()method 
protected function onCloseButton(event:MouseEvent):void

Parameters

event:MouseEvent

onDragOver()method 
protected function onDragOver(event:DragEvent):void

Parameters

event:DragEvent

onFieldValueChanged()method 
protected function onFieldValueChanged(e:FieldValueChangedEvent):void

Parameters

e:FieldValueChangedEvent

onKeyDown()method 
protected function onKeyDown(event:KeyboardEvent):void

Parameters

event:KeyboardEvent

onMouseClick()method 
protected function onMouseClick(event:MouseEvent):void

Parameters

event:MouseEvent

onNavHostEvent()method 
override protected function onNavHostEvent(event:NavHostEvent):void

Parameters

event:NavHostEvent

onOpenFile()method 
protected function onOpenFile(event:MouseEvent):void

Parameters

event:MouseEvent

onPreviewCardClose()method 
protected function onPreviewCardClose(event:Event):void

Parameters

event:Event

onPreviewCardDataChanged()method 
protected function onPreviewCardDataChanged(val:Object):void

Parameters

val:Object

onPreviewCardEffectEnd()method 
protected function onPreviewCardEffectEnd(event:EffectEvent):void

Parameters

event:EffectEvent

onPreviewCardResize()method 
protected function onPreviewCardResize(event:ResizeEvent):void

Parameters

event:ResizeEvent

onResize()method 
override protected function onResize(event:ResizeEvent):void

Parameters

event:ResizeEvent

onTimerComplete()method 
protected function onTimerComplete(event:TimerEvent):void

Parameters

event:TimerEvent

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

resizeCachedThumbs()method 
override protected function resizeCachedThumbs():void

setCurrentState()method 
override public function setCurrentState(stateName:String, playTransition:Boolean = true):void

Sets the state of the skin as well as the state of this instance.

Parameters

stateName:String
 
playTransition:Boolean (default = true)

setElementBounds()method 
protected function setElementBounds(element:IVisualElement, elementSize:Point):void

Parameters

element:IVisualElement
 
elementSize:Point

setPreviewTo()method 
public function setPreviewTo(force:Boolean = false):void

Parameters

force:Boolean (default = false)

stopPlayback()method 
protected function stopPlayback():void

transitionCurrentState()method 
public function transitionCurrentState(metaState:String):void

Parameters

metaState:String

Constant Detail
DRAG_DROP_ATTACHMENTSConstant
public static const DRAG_DROP_ATTACHMENTS:String = attachments

Format that defines the set of Acrobat drag and drop attachments.

loggerConstant 
protected static const logger:ILogger

NON_DYNAMIC_THUMBSIZEConstant 
public static const NON_DYNAMIC_THUMBSIZE:int = 512

STATE_CARD_PREVIEWConstant 
public static const STATE_CARD_PREVIEW:String = cardPreview

STATE_DISABLEDConstant 
public static const STATE_DISABLED:String = disabled

STATE_FOLDER_CARD_PREVIEWConstant 
public static const STATE_FOLDER_CARD_PREVIEW:String = folderCardPreview

STATE_FOLDER_PREVIEWConstant 
public static const STATE_FOLDER_PREVIEW:String = folderPreview




Copyright Adobe Systems Incorporated, all rights reserved, for internal use only

Thu Oct 14 2010, 03:29 PM -07:00