AnchorLayoutData

public class
feathers.layout.AnchorLayoutData

Description

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

See also:
http://wiki.starling-framework.org/feathers/anchor-layout
feathers.layout.AnchorLayout
feathers.layout.ILayoutDisplayObject

API overview

Constructor

AnchorLayoutData ( top: Number = , right: Number = , bottom: Number = , left: Number = , horizontalCenter: Number = , verticalCenter: Number = )
Constructor.

Attributes

Public attributes

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

bottomAnchorDisplayObject: DisplayObject

The bottom edge of the layout object will be relative to this anchor

horizontalCenter: Number

The position, in pixels, of the horizontal center relative to the horizontal center anchor, or, if there is no vertical center anchor, then the position is relative to the horizontal center of the parent container

horizontalCenterAnchorDisplayObject: DisplayObject

The horizontal center of the layout object will be relative to this anchor

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

leftAnchorDisplayObject: DisplayObject

The left edge of the layout object will be relative to this anchor

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

rightAnchorDisplayObject: DisplayObject

The right edge of the layout object will be relative to this anchor

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

topAnchorDisplayObject: DisplayObject

The top edge of the layout object will be relative to this anchor

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

verticalCenterAnchorDisplayObject: DisplayObject

The vertical center of the layout object will be relative to this anchor

Functions

Public functions

Constructor

AnchorLayoutData ( top: Number = , right: Number = , bottom: Number = , left: Number = , horizontalCenter: Number = , verticalCenter: Number = )

Constructor.

Attributes

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.

See also:
#bottomAnchorDisplayObject

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.

See also:
#bottom

horizontalCenter: Number

The position, in pixels, of the horizontal center relative to the horizontal center anchor, or, if there is no vertical center anchor, then the position is relative to the horizontal center of the parent container.

See also:
#horizontalCenterAnchorDisplayObject

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.

See also:
#horizontalCenter

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.

See also:
#leftAnchorDisplayObject

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.

See also:
#left

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.

See also:
#rightAnchorDisplayObject

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.

See also:
#right

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.

See also:
#topAnchorDisplayObject

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.

See also:
#top

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.

See also:
#verticalCenterAnchorDisplayObject

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.

See also:
#verticalCenter

Functions

addEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Registers an event listener at a certain object.

Parameters

type: String
listener: Function


dispatchEvent ( event: Event ): Void
Inherited from EventDispatcher

Dispatches an event to all objects that have registered listeners for its type. If an event with enabled 'bubble' property is dispatched to a display object, it will travel up along the line of parents, until it either hits the root object or someone stops its propagation manually.

Parameters

event: Event


dispatchEventWith ( type: String , bubbles: Boolean = false , data: Object = null ): Void
Inherited from EventDispatcher

Dispatches an event with the given parameters to all objects that have registered listeners for the given type. The method uses an internal pool of event objects to avoid allocations.

Parameters

type: String
bubbles: Boolean = false
data: Object = null


getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

hasEventListener ( type: String ): Boolean
Inherited from EventDispatcher

Returns if there are listeners registered for a certain event type.

Parameters

type: String


removeEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Removes an event listener from the object.

Parameters

type: String
listener: Function


removeEventListeners ( type: String = null ): Void
Inherited from EventDispatcher

Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.

Parameters

type: String = null


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.