Packagecom.adobe.portfolio.layouts
Classpublic class BasicTileLayout
InheritanceBasicTileLayout Inheritance spark.layouts.TileLayout
Implements ICardLayout

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

The BasicTileLayout class extends TileLayout to implement a tile-based layout that centers the group of tiles in the layout container.



Public Properties
 PropertyDefined By
  cardLayoutHelper : CardLayoutHelper
[read-only] The CardLayoutHelper property.
BasicTileLayout
  computedColumnWidth : Number
The computed column width for each column in the tile layout
BasicTileLayout
  computedRowHeight : Number
The computed row height for each row in the tile layout
BasicTileLayout
  dropIndicator : DisplayObject
[override] [write-only]
BasicTileLayout
  target : GroupBase
[override] The target component
BasicTileLayout
  thumbFitSize : Point
The fit size to use for thumbnail images in the layout
BasicTileLayout
  verticalScrollPosition : Number
[override] [write-only]
BasicTileLayout
Protected Properties
 PropertyDefined By
  autoListen : AutoListen
BasicTileLayout
  autoWatch : AutoWatch
BasicTileLayout
  fadeDelay : Number
BasicTileLayout
  justifiedColumnCount : int
[read-only] The number of columns that will fit in the layout
BasicTileLayout
Public Methods
 MethodDefined By
  
Constructor
BasicTileLayout
  
customizeDropIndicator(dropIndicator:DisplayObject):void
Customize the dropIndicator icon to look like an I-beam.
BasicTileLayout
  
elementAdded(index:int):void
[override]
BasicTileLayout
  
findCardsThatIntersect(rect:Rectangle):Vector.<int>
Find the list of cards that overlap the specified rectangle
BasicTileLayout
  
generateFocusEffect(oldIndex:int, newIndex:int, duration:Number):Effect
Generate a focus change effect
BasicTileLayout
  
getDropIndicatorPosition(w:Number, h:Number, x:Number, y:Number, end:Boolean):Rectangle
Given a location, width, and height for the dropIndicator icon, return the drawing rectangle for the dropIndicator icon.
BasicTileLayout
  
measure():void
[override]
BasicTileLayout
  
setFocusAttachment(attachment:Object, oldFocus:Object = null):void
Set the focus attachment
BasicTileLayout
  
showDropIndicator(dropLocation:DropLocation):void
[override]
BasicTileLayout
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
BasicTileLayout
Protected Methods
 MethodDefined By
  
calculateDropIndex(x:Number, y:Number):int
[override]
BasicTileLayout
  
calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle
[override]
BasicTileLayout
  
cardSizeChanged(value:Number):void
Call this function when the card size has changed to set the proper computedColumnWidth and computedRowHeight for the layout
BasicTileLayout
  
BasicTileLayout
  
onResize(event:ResizeEvent):void
Set pending fade to true on a resize
BasicTileLayout
Events
 Event Summary Defined By
  This event is dispatched after the layout has set its focus to a valid attachment.BasicTileLayout
Protected Constants
 ConstantDefined By
  collectionManager : CollectionManager
BasicTileLayout
  IBEAM_PADDING : Number = 30
[static]
BasicTileLayout
  IBEAM_SIZE : Number = 2
[static]
BasicTileLayout
  logger : ILogger
BasicTileLayout
Property Detail
autoListenproperty
protected var autoListen:AutoListen

autoWatchproperty 
protected var autoWatch:AutoWatch

cardLayoutHelperproperty 
cardLayoutHelper:CardLayoutHelper  [read-only]

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

The CardLayoutHelper property.


Implementation
    public function get cardLayoutHelper():CardLayoutHelper
computedColumnWidthproperty 
computedColumnWidth:Number

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

The computed column width for each column in the tile layout

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


Implementation
    public function get computedColumnWidth():Number
    public function set computedColumnWidth(value:Number):void
computedRowHeightproperty 
computedRowHeight:Number

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

The computed row height for each row in the tile layout

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


Implementation
    public function get computedRowHeight():Number
    public function set computedRowHeight(value:Number):void
dropIndicatorproperty 
dropIndicator:DisplayObject  [write-only] [override]

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


Implementation
    public function set dropIndicator(value:DisplayObject):void
fadeDelayproperty 
protected var fadeDelay:Number

justifiedColumnCountproperty 
justifiedColumnCount:int  [read-only]

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

The number of columns that will fit in the layout


Implementation
    protected function get justifiedColumnCount():int
targetproperty 
target:GroupBase[override]

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

The target component


Implementation
    public function get target():GroupBase
    public function set target(value:GroupBase):void
thumbFitSizeproperty 
thumbFitSize:Point

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

The fit size to use for thumbnail images in the layout


Implementation
    public function get thumbFitSize():Point
    public function set thumbFitSize(value:Point):void
verticalScrollPositionproperty 
verticalScrollPosition:Number  [write-only] [override]

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


Implementation
    public function set verticalScrollPosition(value:Number):void
Constructor Detail
BasicTileLayout()Constructor
public function BasicTileLayout()

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

Constructor

Method Detail
calculateDropIndex()method
override protected function calculateDropIndex(x:Number, y:Number):int

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

Parameters

x:Number
 
y:Number

Returns
int
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

Parameters

dropLocation:DropLocation — The drop location where the dropIndicator will be drawn.

Returns
Rectangle
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

Call this function when the card size has changed to set the proper computedColumnWidth and computedRowHeight for the layout

Parameters

value:Number — the new width and height of the tile layout, in pixels

customizeDropIndicator()method 
public function customizeDropIndicator(dropIndicator:DisplayObject):void

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

Customize the dropIndicator icon to look like an I-beam.

Parameters

dropIndicator:DisplayObject — The displayObject instance to use as the dropIndicator icon

elementAdded()method 
override public function elementAdded(index:int):void

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

Parameters

index:int

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 region for which you want to find cards that intersect it.

Returns
Vector.<int> — Vector A vector of integers that represent the indexes of the cards in the layout that intersect the specified rectangle.
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

Generate 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
getDropIndicatorPosition()method 
public function getDropIndicatorPosition(w:Number, h:Number, x:Number, y:Number, end:Boolean):Rectangle

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

Given a location, width, and height for the dropIndicator icon, return the drawing rectangle for the dropIndicator icon.

Parameters

w:Number — The width, in pixels of the drop indicator icon
 
h:Number — The height, in pixels of the drop indicator icon
 
x:Number — The horizontal position of the drop indicator, in pixels
 
y:Number — The vertical position of the drop indicator, in pixels
 
end:Boolean — If this is the last element

Returns
Rectangle — A Rectangle that is the bounding box of the dropIndicator icon as it will be drawn.
justifyCards()method 
protected function justifyCards():void

measure()method 
override public function measure():void

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

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

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

Set pending fade to true on a resize

Parameters

event:ResizeEvent — The resize event to handle

setFocusAttachment()method 
public function setFocusAttachment(attachment:Object, oldFocus:Object = null):void

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

Set the focus attachment

Parameters

attachment:Object — The IAttachment that is to be the new focus
 
oldFocus:Object (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

Parameters

dropLocation:DropLocation

updateDisplayList()method 
override public function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

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

Parameters

unscaledWidth:Number
 
unscaledHeight:Number

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

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

This event is dispatched after the layout has set its focus to a valid attachment.

Constant Detail
collectionManagerConstant
protected const collectionManager:CollectionManager

IBEAM_PADDINGConstant 
protected static const IBEAM_PADDING:Number = 30

IBEAM_SIZEConstant 
protected static const IBEAM_SIZE:Number = 2

loggerConstant 
protected const logger:ILogger