Packagecom.adobe.portfolio.layouts
Classpublic class MiniNavLayout
InheritanceMiniNavLayout Inheritance spark.layouts.HorizontalLayout
Implements ICardLayout

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The MiniNavLayout class extends HorizontalLayout to implement the layout of the MiniNav component.



Public Properties
 PropertyDefined By
  cardLayoutHelper : CardLayoutHelper
The current card layout helper
MiniNavLayout
  thumbFitSize : Point
The width and height for small thumbnail images to fit in the MiniNavLayout.
MiniNavLayout
Protected Properties
 PropertyDefined By
  focusAttachment : IAttachment = null
MiniNavLayout
  focusEffect : Effect
MiniNavLayout
  lastFocus : IAttachment = null
[static] The attachment which was last in focus.
MiniNavLayout
  pendingDuration : Number
MiniNavLayout
  pendingFocus : IAttachment = null
MiniNavLayout
Public Methods
 MethodDefined By
  
Constructor
MiniNavLayout
  
createPanAnimation(delta:Number, duration:Number, applyEaser:Boolean = true):Animate
Create a pan animation effect
MiniNavLayout
  
Make sure the display is centered on the last focus item.
MiniNavLayout
  
findCardsThatIntersect(marqueeRect:Rectangle):Vector.<int>
Find the list of cards that overlap the specified rectangle
MiniNavLayout
  
generateFocusEffect(oldIndex:int, newIndex:int, duration:Number):Effect
Create a focus change effect
MiniNavLayout
  
generatePanEffect(index:int, dur:Number):Parallel
Generate the appropriate pan effect to center on the sepcified element in the element list.
MiniNavLayout
  
generateScrollEffect(dropIndex:int):void
Generate the scrolling effect needed when dragging an item beyond the visible elements in the MiniNavLayout so that the hidden items come to view.
MiniNavLayout
  
[override] Find the x and y distances needed to scroll to reach the specified element.
MiniNavLayout
  
setFocusAttachment(newFocus:IAttachment, oldFocus:IAttachment = null):void
Set the focus to a new element in the Portfolio
MiniNavLayout
  
showDropIndicator(dropLocation:DropLocation):void
[override] Sizes, positions and parents the drop indicator based on the specified drop location.
MiniNavLayout
  
updateDisplayList(width:Number, height:Number):void
[override] Updates the MiniNavLayouts display list.
MiniNavLayout
Protected Methods
 MethodDefined By
  
Get the index value of the pending focus item from the collection manager
MiniNavLayout
  
onEffectEnd(evt:EffectEvent):void
Cleans up after an effect has finished playing.
MiniNavLayout
  
Listener that responds to events from the Collection Manager.
MiniNavLayout
Events
 Event Summary Defined By
  Dispatched after the layout has set its focus to a valid attachment.MiniNavLayout
Protected Constants
 ConstantDefined By
  collectionMgr : CollectionManager
The navigator's CollectionManager instance.
MiniNavLayout
  FOCUS_DURATION : Number = 150
[static] The time duration, in milliseconds, for a focus effect to last
MiniNavLayout
  ITEM_MAX_HEIGHT : Number = 170
[static] The maxmum height for a thumbnail image in the MiniNavLayout
MiniNavLayout
  PADDING : Number = 10
[static] The padding amount around images in the MiniNavLayout
MiniNavLayout
Property Detail
cardLayoutHelperproperty
cardLayoutHelper:CardLayoutHelper

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current card layout helper


Implementation
    public function get cardLayoutHelper():CardLayoutHelper
    public function set cardLayoutHelper(value:CardLayoutHelper):void
focusAttachmentproperty 
protected var focusAttachment:IAttachment = null

focusEffectproperty 
protected var focusEffect:Effect

lastFocusproperty 
protected static var lastFocus:IAttachment = null

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The attachment which was last in focus.

pendingDurationproperty 
protected var pendingDuration:Number

pendingFocusproperty 
protected var pendingFocus:IAttachment = null

thumbFitSizeproperty 
thumbFitSize:Point

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The width and height for small thumbnail images to fit in the MiniNavLayout. This is given as an ordered pair of numbers: (width, height)


Implementation
    public function get thumbFitSize():Point
    public function set thumbFitSize(value:Point):void
Constructor Detail
MiniNavLayout()Constructor
public function MiniNavLayout()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor

Method Detail
createPanAnimation()method
public function createPanAnimation(delta:Number, duration:Number, applyEaser:Boolean = true):Animate

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Create a pan animation effect

Parameters

delta:Number — The distance to pan; this may be either positive or negative.
 
duration:Number (default = NaN) — The time duration, in milliseconds of the pan animation effect.
 
applyEaser:Boolean (default = true) — If true apply easing beahvior for this effect. This will convert the elapsed fraction of the animation into an eased fraction, which is then used to calculate the value at that eased elapsed fraction.

Returns
Animate — The animation effect object
ensureFocusCentered()method 
public function ensureFocusCentered(focus:IAttachment):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Make sure the display is centered on the last focus item. If needed, a pan animation is created to center the display.

Parameters

focus:IAttachment

findCardsThatIntersect()method 
public function findCardsThatIntersect(marqueeRect:Rectangle):Vector.<int>

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Find the list of cards that overlap the specified rectangle

Parameters

marqueeRect:Rectangle — The bounding rectangle for the marquee

Returns
Vector.<int> — A vector of integers that represent the indexes of the cards in the layout that intersect the specified marqueeRect.
generateFocusEffect()method 
public function generateFocusEffect(oldIndex:int, newIndex:int, duration:Number):Effect

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Create a focus change effect

Parameters

oldIndex:int — The index value of the element that is the current (old) focus
 
newIndex:int — The index value of the element that is to be the new focus
 
duration:Number — The duration, in milliseconds, the effect should last

Returns
Effect — The focus effect object
generatePanEffect()method 
public function generatePanEffect(index:int, dur:Number):Parallel

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Generate the appropriate pan effect to center on the sepcified element in the element list.

Parameters

index:int — The index value of the element to which to pan
 
dur:Number — The duration, in milliseconds, the effect should last

Returns
Parallel — A parallel animation effect object
generateScrollEffect()method 
public function generateScrollEffect(dropIndex:int):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Generate the scrolling effect needed when dragging an item beyond the visible elements in the MiniNavLayout so that the hidden items come to view.

Parameters

dropIndex:int

getPendingFocusIndex()method 
protected function getPendingFocusIndex():int

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Get the index value of the pending focus item from the collection manager

Returns
int
getScrollPositionDeltaToElement()method 
override public function getScrollPositionDeltaToElement(index:int):Point

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Find the x and y distances needed to scroll to reach the specified element. The element is identified by its index number

Parameters

index:int — The index value of the element for which you want to know the distance to scroll.

Returns
Point — Returns the distance to the element as an ordered pair (delta_x, delta_y)
onEffectEnd()method 
protected function onEffectEnd(evt:EffectEvent):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Cleans up after an effect has finished playing.

Parameters

evt:EffectEvent — The NavLayout event effect that is to be handled

onHostEvent()method 
protected function onHostEvent(evt:CollectionManagerEvent):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Listener that responds to events from the Collection Manager.

Parameters

evt:CollectionManagerEvent — The Collection Manager event to be handled

setFocusAttachment()method 
public function setFocusAttachment(newFocus:IAttachment, oldFocus:IAttachment = null):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Set the focus to a new element in the Portfolio

Parameters

newFocus:IAttachment — The IAttachment that is to be the new focus
 
oldFocus:IAttachment (default = null) — The IAttachment that is the current (old) focus

showDropIndicator()method 
override public function showDropIndicator(dropLocation:DropLocation):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Sizes, positions and parents the drop indicator based on the specified drop location. Use the calculateDropLocation() method to obtain the DropLocation object. Display the visual drop indicator for drag and drop operations.

Parameters

dropLocation:DropLocation — Specifies the location to dispaly the drop indicator. Drop location is obtained through the computeDropLocation() method.

updateDisplayList()method 
override public function updateDisplayList(width:Number, height:Number):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Updates the MiniNavLayouts display list.

Parameters

width:Number — The width of the display list in pixels
 
height:Number — The height of the display list in pixels

Event Detail
HANDLED_ATTACHMENT_FOCUS Event
Event Object Type: com.adobe.portfolio.events.LayoutEvent
LayoutEvent.type property = com.adobe.portfolio.events.NavLayoutEvent.HANDLED_ATTACHMENT_FOCUS

Dispatched after the layout has set its focus to a valid attachment.

Constant Detail
collectionMgrConstant
protected const collectionMgr:CollectionManager

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The navigator's CollectionManager instance. All host interaction should go through this instance, rather than the INavigatorHost directly.

FOCUS_DURATIONConstant 
protected static const FOCUS_DURATION:Number = 150

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The time duration, in milliseconds, for a focus effect to last

ITEM_MAX_HEIGHTConstant 
protected static const ITEM_MAX_HEIGHT:Number = 170

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The maxmum height for a thumbnail image in the MiniNavLayout

PADDINGConstant 
protected static const PADDING:Number = 10

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The padding amount around images in the MiniNavLayout