Packagefeathers.layout
Classpublic class AnchorLayoutData
InheritanceAnchorLayoutData Inheritance starling.events.EventDispatcher
Implements ILayoutData

Product Version : Feathers 1.1.0

Extra, optional data used by an AnchorLayout instance to position and size a display object.

See also

AnchorLayout
ILayoutDisplayObject


Public Properties
 PropertyDefined By
  bottom : Number
The position, in pixels, of the bottom edge relative to the bottom anchor, or, if there is no bottom anchor, then the position is relative to the bottom edge of the parent container.
AnchorLayoutData
  bottomAnchorDisplayObject : DisplayObject
The bottom edge of the layout object will be relative to this anchor.
AnchorLayoutData
  horizontalCenter : Number
The position, in pixels, of the horizontal center relative to the horizontal center anchor, or, if there is no horizontal center anchor, then the position is relative to the horizontal center of the parent container.
AnchorLayoutData
  horizontalCenterAnchorDisplayObject : DisplayObject
The horizontal center of the layout object will be relative to this anchor.
AnchorLayoutData
  left : Number
The position, in pixels, of the left edge relative to the left anchor, or, if there is no left anchor, then the position is relative to the left edge of the parent container.
AnchorLayoutData
  leftAnchorDisplayObject : DisplayObject
The left edge of the layout object will be relative to this anchor.
AnchorLayoutData
  percentHeight : Number
The height of the layout object, as a percentage of the container's height.
AnchorLayoutData
  percentWidth : Number
The width of the layout object, as a percentage of the container's width.
AnchorLayoutData
  right : Number
The position, in pixels, of the right edge relative to the right anchor, or, if there is no right anchor, then the position is relative to the right edge of the parent container.
AnchorLayoutData
  rightAnchorDisplayObject : DisplayObject
The right edge of the layout object will be relative to this anchor.
AnchorLayoutData
  top : Number
The position, in pixels, of the top edge relative to the top anchor, or, if there is no top anchor, then the position is relative to the top edge of the parent container.
AnchorLayoutData
  topAnchorDisplayObject : DisplayObject
The top edge of the layout object will be relative to this anchor.
AnchorLayoutData
  verticalCenter : Number
The position, in pixels, of the vertical center relative to the vertical center anchor, or, if there is no vertical center anchor, then the position is relative to the vertical center of the parent container.
AnchorLayoutData
  verticalCenterAnchorDisplayObject : DisplayObject
The vertical center of the layout object will be relative to this anchor.
AnchorLayoutData
Public Methods
 MethodDefined By
  
AnchorLayoutData(top:Number, right:Number, bottom:Number, left:Number, horizontalCenter:Number, verticalCenter:Number)
Constructor.
AnchorLayoutData
Events
 Event Summary Defined By
  AnchorLayoutData
Property Detail
bottomproperty
bottom:Number

The position, in pixels, of the bottom edge relative to the bottom anchor, or, if there is no bottom anchor, then the position is relative to the bottom edge of the parent container. If this value is NaN, the object's bottom edge will not be anchored.

The default value is NaN.


Implementation
    public function get bottom():Number
    public function set bottom(value:Number):void

See also

bottomAnchorDisplayObjectproperty 
bottomAnchorDisplayObject:DisplayObject

The bottom edge of the layout object will be relative to this anchor. If there is no anchor, the bottom edge of the parent container will be the anchor.

The default value is null.


Implementation
    public function get bottomAnchorDisplayObject():DisplayObject
    public function set bottomAnchorDisplayObject(value:DisplayObject):void

See also

horizontalCenterproperty 
horizontalCenter:Number

The position, in pixels, of the horizontal center relative to the horizontal center anchor, or, if there is no horizontal center anchor, then the position is relative to the horizontal center of the parent container. If this value is NaN, the object's horizontal center will not be anchored.

The default value is NaN.


Implementation
    public function get horizontalCenter():Number
    public function set horizontalCenter(value:Number):void

See also

horizontalCenterAnchorDisplayObjectproperty 
horizontalCenterAnchorDisplayObject:DisplayObject

The horizontal center of the layout object will be relative to this anchor. If there is no anchor, the horizontal center of the parent container will be the anchor.

The default value is null.


Implementation
    public function get horizontalCenterAnchorDisplayObject():DisplayObject
    public function set horizontalCenterAnchorDisplayObject(value:DisplayObject):void

See also

leftproperty 
left:Number

The position, in pixels, of the left edge relative to the left anchor, or, if there is no left anchor, then the position is relative to the left edge of the parent container. If this value is NaN, the object's left edge will not be anchored.

The default value is NaN.


Implementation
    public function get left():Number
    public function set left(value:Number):void

See also

leftAnchorDisplayObjectproperty 
leftAnchorDisplayObject:DisplayObject

The left edge of the layout object will be relative to this anchor. If there is no anchor, the left edge of the parent container will be the anchor.

The default value is null.


Implementation
    public function get leftAnchorDisplayObject():DisplayObject
    public function set leftAnchorDisplayObject(value:DisplayObject):void

See also

percentHeightproperty 
percentHeight:Number

The height of the layout object, as a percentage of the container's height.

A percentage may be specified in the range from 0 to 100. If the value is set to NaN, this property is ignored.

The default value is NaN.


Implementation
    public function get percentHeight():Number
    public function set percentHeight(value:Number):void
percentWidthproperty 
percentWidth:Number

The width of the layout object, as a percentage of the container's width.

A percentage may be specified in the range from 0 to 100. If the value is set to NaN, this property is ignored.

The default value is NaN.


Implementation
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void
rightproperty 
right:Number

The position, in pixels, of the right edge relative to the right anchor, or, if there is no right anchor, then the position is relative to the right edge of the parent container. If this value is NaN, the object's right edge will not be anchored.

The default value is NaN.


Implementation
    public function get right():Number
    public function set right(value:Number):void

See also

rightAnchorDisplayObjectproperty 
rightAnchorDisplayObject:DisplayObject

The right edge of the layout object will be relative to this anchor. If there is no anchor, the right edge of the parent container will be the anchor.

The default value is null.


Implementation
    public function get rightAnchorDisplayObject():DisplayObject
    public function set rightAnchorDisplayObject(value:DisplayObject):void

See also

topproperty 
top:Number

The position, in pixels, of the top edge relative to the top anchor, or, if there is no top anchor, then the position is relative to the top edge of the parent container. If this value is NaN, the object's top edge will not be anchored.

The default value is NaN.


Implementation
    public function get top():Number
    public function set top(value:Number):void

See also

topAnchorDisplayObjectproperty 
topAnchorDisplayObject:DisplayObject

The top edge of the layout object will be relative to this anchor. If there is no anchor, the top edge of the parent container will be the anchor.

The default value is null.


Implementation
    public function get topAnchorDisplayObject():DisplayObject
    public function set topAnchorDisplayObject(value:DisplayObject):void

See also

verticalCenterproperty 
verticalCenter:Number

The position, in pixels, of the vertical center relative to the vertical center anchor, or, if there is no vertical center anchor, then the position is relative to the vertical center of the parent container. If this value is NaN, the object's vertical center will not be anchored.

The default value is NaN.


Implementation
    public function get verticalCenter():Number
    public function set verticalCenter(value:Number):void

See also

verticalCenterAnchorDisplayObjectproperty 
verticalCenterAnchorDisplayObject:DisplayObject

The vertical center of the layout object will be relative to this anchor. If there is no anchor, the vertical center of the parent container will be the anchor.

The default value is null.


Implementation
    public function get verticalCenterAnchorDisplayObject():DisplayObject
    public function set verticalCenterAnchorDisplayObject(value:DisplayObject):void

See also

Constructor Detail
AnchorLayoutData()Constructor
public function AnchorLayoutData(top:Number, right:Number, bottom:Number, left:Number, horizontalCenter:Number, verticalCenter:Number)

Constructor.

Parameters
top:Number (default = NaN)
 
right:Number (default = NaN)
 
bottom:Number (default = NaN)
 
left:Number (default = NaN)
 
horizontalCenter:Number (default = NaN)
 
verticalCenter:Number (default = NaN)
Event Detail
change Event
Event Object Type: starling.events.Event