[read-only]
These correspond to field names in the pdf file and are
used to get and set the x position, y position, depth and
rotation of the card when it is used in the FreeForm navigator.
[override]
Find the index value of the card that is the destination, based on the navigationUnit
supplied (UP, DOWN, LEFT, RIGHT, PAGE_UP, PAGE_DOWN, HOME).
These correspond to field names in the pdf file and are
used to get and set the x position, y position, depth and
rotation of the card when it is used in the FreeForm navigator.
Implementation public function get freeFormFields():FreeFormFields
This is the card that the user is currently hovering over
invalidCardDepths
property
protected var invalidCardDepths:Boolean
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
A Boolean flag that indicates whether the currently specified card depths are
valid or not.
invalidCardSize
property
protected var invalidCardSize:Boolean
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
A Boolean flag that indicates whether the currently specified card size is
a valid size for the current target or not.
invalidCardStates
property
protected var invalidCardStates:Boolean
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
A Boolean flag that indicates whether the currently specified card states are
valid or not.
isDragging
property
isDragging:Boolean
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
A Boolean indicating whether a drag operation is occuring or not.
Implementation public function get isDragging():Boolean public function set isDragging(value:Boolean):void
showCardsAngled
property
protected var showCardsAngled:Boolean = true
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
A Boolean flag that indicates whether the cards should be displayed
at an angle.
target
property
target:GroupBase[override]
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the target host for this navigator
Implementation public function get target():GroupBase public function set target(value:GroupBase):void
thumbFitSize
property
thumbFitSize:Point
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
The size, represented as a width and height ordered pair, to use for thumbnails
Implementation public function get thumbFitSize():Point public function set thumbFitSize(value:Point):void
Constructor Detail
FreeFormLayout
()
Constructor
public function FreeFormLayout()
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Constructor
Method Detail
addListenAndWatch
()
method
public function addListenAndWatch():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Add event listeners and change watchers to the navigator.
adjustAngleOfCards
()
method
public function adjustAngleOfCards(indices:Vector.<int>, navigationUnit:uint):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Adjusts the display angle for all the cards with an index
in the indices vector by the specified navigationUnit
Parameters
indices:Vector.<int> — A vector of card indices
navigationUnit:uint — The amount, in degrees, to adjust the angle of each card
adjustCardAngle
()
method
protected function adjustCardAngle(attachment:IAttachment, navigationUnit:uint):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Adjust the display angle of the card for the card displayed for the specified attachment
Parameters
attachment:IAttachment — The attachment for which its card's display angle is to be changed.
navigationUnit:uint — A NavigationUnit enum value corresponding to a keyCode, such as UP, DOWN, LEFT, RIGHT, etc.
calculateDropIndicatorBounds
()
method
override protected function calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Calculates the bounding rectangle defined by the dragStartPoint and the dropLocation.
This method returns null for drags initiated from the platform,
since we do not want to show the drag image in that situation.
Parameters
dropLocation:DropLocation — The drop location for a drag and drop operation.
Returns
Rectangle — A rectangle defined by the dragStartPoint and the dropLocation.
cardSizeChanged
()
method
protected function cardSizeChanged(value:Number):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Let the navigator know that the card size has been changed.
This will resize the cards in the display.
Parameters
value:Number — The card size to use, in pixels, if the card size is not AUTO_CARD_SIZE
commitProperties
()
method
protected function commitProperties():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the layout properties: best card size, card states, card bounds, and card depths.
compareAttachmentDepths
()
method
protected function compareAttachmentDepths(attach1:IAttachment, attach2:IAttachment):int
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Compare the depth in the visual stack of two attachments,
so that you can tell which is on top of the other.
Parameters
attach1:IAttachment — The first attachment to compare
attach2:IAttachment — The second attachment to compare
Returns
int — Returns 0 if the two attachments are at the same depth.
Returns 1 if the first attachment has a greater depth than (i.e., is on top of) the second attachment.
Returns -1 if the first attachment has a lesser depth than (i.e., is below) the second attachment.
elementWasAdded
()
method
public function elementWasAdded(visualElement:IVisualElement):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Handles adding a visual element: it gets the related IAttachment and sets the
appropriate event listeners.
Parameters
visualElement:IVisualElement — The visual element that has been added
elementWasRemoved
()
method
public function elementWasRemoved(visualElement:IVisualElement):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Handles removing a visual element: it gets the related IAttachment and removes the
appropriate event listeners.
Parameters
visualElement:IVisualElement — The visual element that has been removed
fadeInCards
()
method
protected function fadeInCards():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Run a fade-in animation effect for the cards.
findBestCardSize
()
method
protected function findBestCardSize():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Determine the best card size to use based on the number of cards and the
window size. This method is called if auto-sizing was requested and either
the window was resized or the number of cards changed.
findCardsThatIntersect
()
method
public function findCardsThatIntersect(rect: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
rect:Rectangle — A bounding rectangle
Returns
Vector.<int> — A vector of integers that represent the indexes
of the cards in the layout that intersect the specified rectangle.
findCardsThatIntersectRectangles
()
method
protected function findCardsThatIntersectRectangles(rects:Array):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 any of the rectangles in the specified array.
Parameters
rects:Array — An array of bounding rectangle
Returns
Vector.<int> — A vector of integers that represent the indexes
of the cards in the layout that intersect the specified rectangles.
getAttachmentFromVisualElement
()
method
protected function getAttachmentFromVisualElement(visualElement:IVisualElement):IAttachment
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Get the attachment that is associated with the specified visual element.
Parameters
visualElement:IVisualElement — The visual element for which you want the associated attachment
Returns
IAttachment — The attachment associated with the visual element
getAttachments
()
method
protected function getAttachments():Array
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Get all the attachments in the portfolio.
Returns
Array — An array of attachments.
getDepthForCard
()
method
protected function getDepthForCard(card:BasicCard):Number
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Get the depth in the visual stack of the specified card.
Parameters
card:BasicCard — A BasicCard for which you want to get its depth.
Returns
Number — A number indicating where the card is in the visual stack. The card on top will have the highest depth number.
getExtendedSelection
()
method
public function getExtendedSelection(anchorIndex:int, destIndex:int):Vector.<int>
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Find all cards that intersect the region between the anchor index and destination index.
This is used to implement shift-select to extend the selection.
Parameters
anchorIndex:int — The index of the anchor point when doing shift-selection
destIndex:int — The index of the destination or final point when doing shift-selection
Returns
Vector.<int>
getNavigationDestinationIndex
()
method
override public function getNavigationDestinationIndex(currentIndex:int, navigationUnit:uint, arrowKeysWrapFocus:Boolean):int
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Find the index value of the card that is the destination, based on the navigationUnit
supplied (UP, DOWN, LEFT, RIGHT, PAGE_UP, PAGE_DOWN, HOME).
Parameters
currentIndex:int — The index of the currently selected card
navigationUnit:uint — A NavigationUnit enum value corresponding to a keyCode, such as UP, DOWN, LEFT, RIGHT, etc.
arrowKeysWrapFocus:Boolean
Returns
int — The index value of the destination card.
Returns -1 if no destination index can be found.
getVisualElementAt
()
method
protected function getVisualElementAt(index:int):IVisualElement
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Get the visual element that has the specified index value.
This is the compliment of getVisualElementIndex()
Parameters
index:int — The index value for the visual element in which you are interested
Returns
IVisualElement — The visual element with the specified index value
getVisualElementIndex
()
method
public function getVisualElementIndex(visualElement:IVisualElement):int
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Get the index of the specified visual element.
This is the compliment of getVisualElementAt()
Parameters
visualElement:IVisualElement — The visual element in which you are interested
Returns
int — The index value for the visual element specified
hoveringOverElement
()
method
public function hoveringOverElement(visualElement:IVisualElement, hoveredOver:Boolean):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Sets the attachment for the specified visual element as the hoveredCard
if hoveredOver is true.
Parameters
visualElement:IVisualElement — The visual element that is being hovered over
hoveredOver:Boolean — If true then visualElement's related attachment
will be the hovered card.
Remove all event listeners and change watchers from the navigator
resizeHandler
()
method
protected function resizeHandler(event:ResizeEvent):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
This is the event handler for target resize events.
Parameters
event:ResizeEvent — A target resize event that needs to be handled.
selectionChanged
()
method
public function selectionChanged(selectedItems:Vector.<Object>):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Resets the depth for each card in the vector of selectedItems.
Parameters
selectedItems:Vector.<Object> — A vector of IAttachements
setAllCardBounds
()
method
protected function setAllCardBounds():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the card boundaries for all cards in the portfolio.
setCardBounds
()
method
protected function setCardBounds(card:IVisualElement):Rectangle
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the card boundary for the specified card
Parameters
card:IVisualElement — The card for which you want to find its bounding box
Returns
Rectangle — A rectangle the specifies the position and size of the card's bounding box.
This is the unrotated rectangle that contains the card.
setCardSize
()
method
protected function setCardSize(value:Number):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the card size explicitly.
Parameters
value:Number — The width and height, in pixels, to use for the card size.
setCardStates
()
method
protected function setCardStates():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the appropriate states for all cards used in the free form layout.
These are the states used with BasicCards.
setDepthsOfCards
()
method
protected function setDepthsOfCards():void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the card depths in the visual stack for all the cards in the portfolio.
setRotationForCard
()
method
protected function setRotationForCard(card:BasicCard):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the appropriate degree of rotation for the specified card
based on the "adobe:FreeForm:angle" field value in the PDF file.
Parameters
card:BasicCard — A BasicCard for which you want to set the rotation.
setStateForCard
()
method
protected function setStateForCard(card:BasicCard):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Set the appropriate states for the specified card.
This is normally called from setCardStates().
Parameters
card:BasicCard — A BasicCard for which you want to set the valid states.
showCardsAngledChanged
()
method
protected function showCardsAngledChanged(value:Boolean):void
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
Let the navigator know that the showCardsAngled Boolean indicator has been changed.
This will set showCardsAngled to the value specified.
Parameters
value:Boolean — Set this to true if you want the cards to be displayed at
various angles (this is the default for free form layout; set this to false
if you want to cards to be displayed straight up.
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
Update the display List
Parameters
width:Number — The new width of the target, in pixels, in the targets's coordinates.
height:Number — The new height of the target, in pixels, in the targets's coordinates.
Constant Detail
AUTO_CARD_SIZE
Constant
public static const AUTO_CARD_SIZE:String = auto
Language Version :
ActionScript 3.0
Product Version :
Portfolio 10.0
Runtime Versions :
Flash Player 10.1, AIR 2.0
The string constant used to specify automatic card size