Packageardisia.components.packedList
Classpublic class PackedList
InheritancePackedList Inheritance spark.components.List

List designed to use the PackedLayout layout class. Also supports throwing and dragging layout elements via mouse interaction.

Useful to create interactive distributive lists like tag clouds.

View the technical documentation on the Ardisia Labs website for more information.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined By
  autoMaxSpeed : Number = 3
Maximum throw speed.
PackedList
  autoMinSpeed : Number = 0
Minimum throw speed.
PackedList
  autoThrowSpeedFudge : Number = 0.1
A fudge factor to speed up/slow down throws if throwVelocity is auto, throwVelocity = 0.
PackedList
  enableThrowing : Boolean
Enables renderer throwing.
PackedList
  layoutMode : String
Layout modes available.
PackedList
  noiseFactor : Number
A random noise to add to the distribution, expressed as a percentage of the total width.
PackedList
  peak : Number
The location of the peak of the distribution function, from 0 to 1.
PackedList
  resolution : int
The maximum number of passes allowed to minimize renderer overlap.
PackedList
  throwAngleOffset : Number = 0
The angle at which to offset the throw direction from the mouse movement direction when the user mouses out of an item.
PackedList
  throwDecay : Number = 1
The rate at which thrown renderer movement decays.
PackedList
  throwVelocity : Number = 0
The speed at which renderers are thrown on item roll out.
PackedList
  useVirtualLayout : Boolean
[override] [write-only] PackedLayout does not support virtualization.
PackedList
Public Methods
 MethodDefined By
  
Call to refresh the positions of the layout elements.
PackedList
Protected Methods
 MethodDefined By
  
eventHandler(event:Event):void
Handles the events on the control.
PackedList
Property Detail
autoMaxSpeedproperty
public var autoMaxSpeed:Number = 3

Maximum throw speed. Only relevant if throwVelocity is 0 ("auto").

Only applicable if "enableThrowing" is true.

The default value is 3.

autoMinSpeedproperty 
public var autoMinSpeed:Number = 0

Minimum throw speed. Only relevant if throwVelocity is 0 ("auto").

Only applicable if "enableThrowing" is true.

The default value is 0.

autoThrowSpeedFudgeproperty 
public var autoThrowSpeedFudge:Number = 0.1

A fudge factor to speed up/slow down throws if throwVelocity is auto, throwVelocity = 0.

Only applicable if "enableThrowing" is true.

The default value is 0.1.

enableThrowingproperty 
enableThrowing:Boolean

Enables renderer throwing.

The default value is true.


Implementation
    public function get enableThrowing():Boolean
    public function set enableThrowing(value:Boolean):void
layoutModeproperty 
layoutMode:String

Layout modes available.

Delegated to the PackedLayout.

The default value is "random".


Implementation
    public function get layoutMode():String
    public function set layoutMode(value:String):void
noiseFactorproperty 
noiseFactor:Number

A random noise to add to the distribution, expressed as a percentage of the total width. Set to a non-zero value for layout elements to be positioned off their exact position on the normal distribution.

Delegated to the PackedLayout.

The default value is 0.25.


Implementation
    public function get noiseFactor():Number
    public function set noiseFactor(value:Number):void
peakproperty 
peak:Number

The location of the peak of the distribution function, from 0 to 1.

Delegated to the PackedLayout.

The default value is 0.35.


Implementation
    public function get peak():Number
    public function set peak(value:Number):void
resolutionproperty 
resolution:int

The maximum number of passes allowed to minimize renderer overlap. Higher numbers will reduce potential renderer overlapping, but processing will take longer.

Each pass is pure arithmetic so each pass is very fast.

Delegated to the PackedLayout.

The default value is 100.


Implementation
    public function get resolution():int
    public function set resolution(value:int):void
throwAngleOffsetproperty 
public var throwAngleOffset:Number = 0

The angle at which to offset the throw direction from the mouse movement direction when the user mouses out of an item.

Expressed in degrees.

Only applicable if "enableThrowing" is true.

The default value is 0.

throwDecayproperty 
public var throwDecay:Number = 1

The rate at which thrown renderer movement decays.

Pixels per second.

Only applicable if "enableThrowing" is true.

The default value is 1.

throwVelocityproperty 
public var throwVelocity:Number = 0

The speed at which renderers are thrown on item roll out.

Set to 0 and the class will automatically calculate the speed based on how fast the user is moving the mouse.

Pixels per second.

Only applicable if "enableThrowing" is true.

The default value is 0.

useVirtualLayoutproperty 
useVirtualLayout:Boolean  [write-only] [override]

PackedLayout does not support virtualization.

The default value is false.


Implementation
    public function set useVirtualLayout(value:Boolean):void
Method Detail
eventHandler()method
protected function eventHandler(event:Event):void

Handles the events on the control.

Parameters

event:Event — The Event that triggered the handler

refreshPositions()method 
public function refreshPositions():void

Call to refresh the positions of the layout elements.