feathers.layout.ILayoutDisplayObject

Public Properties

	Property		Defined By
		alpha : Number The opacity of the display object.	IFeathersDisplayObject
		base : DisplayObject [read-only] The top-most object of the display tree that the display object is connected to.	IFeathersDisplayObject
		blendMode : String The blend mode used when rendering the display object.	IFeathersDisplayObject
		bounds : Rectangle [read-only] The bounds of the display object in its local coordinate space.	IFeathersDisplayObject
		filter : FragmentFilter The filter used when rendering the display object.	IFeathersDisplayObject
		height : Number The height of the display object in the parent's coordinate space.	IFeathersDisplayObject
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	ILayoutDisplayObject
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	ILayoutDisplayObject
		mask : DisplayObject The display object's mask.	IFeathersDisplayObject
		name : String The name of the display object.	IFeathersDisplayObject
		parent : DisplayObjectContainer [read-only] The display object's parent, or null if it doesn't have a parent.	IFeathersDisplayObject
		pivotX : Number The x coordinate of the display object's origin in its own coordinate space.	IFeathersDisplayObject
		pivotY : Number The y coordinate of the display object's origin in its own coordinate space.	IFeathersDisplayObject
		root : DisplayObject [read-only]	IFeathersDisplayObject
		rotation : Number The rotation of the display object, in radians.	IFeathersDisplayObject
		scaleX : Number This horizontal scale factor.	IFeathersDisplayObject
		scaleY : Number The vertical scale factor.	IFeathersDisplayObject
		skewX : Number The horizontal skew, in radians.	IFeathersDisplayObject
		skewY : Number The vertical skew, in radians.	IFeathersDisplayObject
		stage : Stage [read-only] The stage that the display object is connected to, or null if it is not connected to a stage.	IFeathersDisplayObject
		touchable : Boolean Determines if the display object may be touched.	IFeathersDisplayObject
		transformationMatrix : Matrix [read-only] The transformation matrix of the display object, relative to its parent.	IFeathersDisplayObject
		useHandCursor : Boolean Determines if the mouse cursor should turn into a hand when the mouse is over the display object.	IFeathersDisplayObject
		visible : Boolean Determines the visibility of the display object.	IFeathersDisplayObject
		width : Number The width of the display object in the parent's coordinate space.	IFeathersDisplayObject
		x : Number The x, or horizontal, position of the display object in the parent's coordinate space.	IFeathersDisplayObject
		y : Number The y, or vertical, position of the display object in the parent's coordinate space.	IFeathersDisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function):void Adds a listener for an event type.	IFeathersEventDispatcher
		dispatchEvent(event:Event):void Dispatches an event to all listeners added for the specified event type.	IFeathersEventDispatcher
		dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event from the pool with the specified to all listeners for the specified event type.	IFeathersEventDispatcher
		dispose():void Disposes the display object.	IFeathersDisplayObject
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Gets the display object's bounds in the target coordinate space.	IFeathersDisplayObject
		getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Calculates a transformation matrix to convert values from the display object's coordinate space to a target coordinate space.	IFeathersDisplayObject
		globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Converts a point from the stage's coordinate space to the display object's coordinate space.	IFeathersDisplayObject
		hasEventListener(type:String, listener:Function = null):Boolean Checks if a listener has been added for the specified event type.	IFeathersEventDispatcher
		hitTest(localPoint:Point):DisplayObject Determines if a point exists within the display object's bounds.	IFeathersDisplayObject
		localToGlobal(localPoint:Point, resultPoint:Point = null):Point Converts a point from the display object's coordinate space to the stage's coordinate space.	IFeathersDisplayObject
		removeEventListener(type:String, listener:Function):void Removes a listener for an event type.	IFeathersEventDispatcher
		removeEventListeners(type:String = null):void Removes all listeners for an event type.	IFeathersEventDispatcher
		removeFromParent(dispose:Boolean = false):void Removes a display object from its parent.	IFeathersDisplayObject
		render(painter:Painter):void Renders the display object.	IFeathersDisplayObject

Events

	Event		Summary	Defined By
		layoutDataChange	Dispatched when a property of the display object's layout data changes.	ILayoutDisplayObject

Property Detail

includeInLayout

property

includeInLayout:Boolean

Determines if the ILayout should use this object or ignore it.

In the following example, the display object is excluded from the layout:

object.includeInLayout = false;

Implementation
public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void

layoutData

property

layoutData:ILayoutData

Extra parameters associated with this display object that will be used by the layout algorithm.

Implementation
public function get layoutData():ILayoutData
public function set layoutData(value:ILayoutData):void

Event Detail

layoutDataChange

Event

Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.LAYOUT_DATA_CHANGE

Dispatched when a property of the display object's layout data changes.

The FeathersEventType.LAYOUT_DATA_CHANGE event type is used by Feathers controls when their layout data has changed.

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
ILayoutDisplayObject	Properties Events

Package	feathers.layout
Interface	public interface ILayoutDisplayObject extends IFeathersDisplayObject, IFeathersEventDispatcher
Implementors	FeathersControl