Packagecom.yahoo.astra.layout.modes
Classpublic class BaseLayoutMode
InheritanceBaseLayoutMode Inheritance flash.events.EventDispatcher
ImplementsIAdvancedLayoutMode
SubclassesBorderLayout, BoxLayout, FlowLayout, TileLayout

Some basic properties shared by multiple ILayoutMode implementations. Should be treated as an abstract class that is meant to be subclassed.

See also

ILayoutMode
com.yahoo.astra.layout.ILayoutContainer

Public Properties
 PropertyDefined by
  paddingBottom : Number
The number of pixels displayed at the bottom of the target's children.
BaseLayoutMode
  paddingLeft : Number
The number of pixels displayed at the left of the target's children.
BaseLayoutMode
  paddingRight : Number
The number of pixels displayed at the right of the target's children.
BaseLayoutMode
  paddingTop : Number
The number of pixels displayed at the top of the target's children.
BaseLayoutMode
Public Methods
 MethodDefined by
  
BaseLayoutMode()
Constructor.
BaseLayoutMode
  
addClient(target:DisplayObject, configuration:Object = null):void
Registers a specific display object with the layout algorithm.
BaseLayoutMode
  
hasClient(target:DisplayObject):Boolean
Returns true if a display object has been registered as a client.
BaseLayoutMode
  
layoutObjects(displayObjects:Array, bounds:Rectangle):Rectangle
The DisplayObjects in the input parameter will be positioned and sized based on a specified rectangle.
BaseLayoutMode
  
removeClient(target:DisplayObject):void
Unregisters a specific display object from the layout algorithm.
BaseLayoutMode
Property detail
paddingBottomproperty
paddingBottom:Number  [read-write]

The number of pixels displayed at the bottom of the target's children.

Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
paddingLeft:Number  [read-write]

The number of pixels displayed at the left of the target's children.

Implementation
    public function get paddingLeft():Number
    public function set paddingLeft(value:Number):void
paddingRightproperty 
paddingRight:Number  [read-write]

The number of pixels displayed at the right of the target's children.

Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
paddingTop:Number  [read-write]

The number of pixels displayed at the top of the target's children.

Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
Constructor detail
BaseLayoutMode()constructor
public function BaseLayoutMode()

Constructor.

Method detail
addClient()method
public function addClient(target:DisplayObject, configuration:Object = null):void

Registers a specific display object with the layout algorithm. If certain settings need to be specified for individual display objects, they should be passed to the layout algorithm here.

Parameters
target:DisplayObject — The client to add
 
configuration:Object (default = null) — An optional set of name-value pairs for the client's configuration.
hasClient()method 
public function hasClient(target:DisplayObject):Boolean

Returns true if a display object has been registered as a client.

Parameters
target:DisplayObject — The display object that may be registered

Returns
Boolean
layoutObjects()method 
public function layoutObjects(displayObjects:Array, bounds:Rectangle):Rectangle

The DisplayObjects in the input parameter will be positioned and sized based on a specified rectangle. There is no requirement that the display objects remain entirely within the rectangle.

Returns the actual rectangular region in which the laid out children will appear. This may be larger or smaller than the suggested rectangle. This returned value is expected to be used by container components to determine if scrollbars or other navigation controls are needed.

Parameters
displayObjects:Array — An Array of DisplayObjects to be laid out.
 
bounds:Rectangle — The rectangular region in which the display objects should be placed.

Returns
Rectangle — The actual region in which the display objects are contained.
removeClient()method 
public function removeClient(target:DisplayObject):void

Unregisters a specific display object from the layout algorithm.

Parameters
target:DisplayObject — The client to remove