GODPAPER | All Packages | All Classes | Index | Frames No Frames |
IFeathersControl

Package | feathers.core
Interface | public interface IFeathersControl extends IFeathersDisplayObject, IFeathersEventDispatcher
Implementors | FeathersControl

Basic interface for Feathers UI controls. A Feathers control must also be a Starling display object.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number | IFeathersDisplayObject
|  | base : DisplayObject [read-only] | IFeathersDisplayObject
|  | blendMode : String | IFeathersDisplayObject
|  | bounds : Rectangle [read-only] | IFeathersDisplayObject
|  | filter : FragmentFilter | IFeathersDisplayObject
|  | hasVisibleArea : Boolean [read-only] | IFeathersDisplayObject
|  | height : Number | IFeathersDisplayObject
|  | isEnabled : Boolean Indicates whether the control is interactive or not. | IFeathersControl
|  | isInitialized : Boolean [read-only] Determines if the component has been initialized yet. | IFeathersControl
|  | maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | IFeathersControl
|  | name : String | IFeathersDisplayObject
|  | nameList : TokenList [read-only] Contains a list of all "names" assigned to this control. | IFeathersControl
|  | parent : DisplayObjectContainer [read-only] | IFeathersDisplayObject
|  | pivotX : Number | IFeathersDisplayObject
|  | pivotY : Number | IFeathersDisplayObject
|  | root : DisplayObject [read-only] | IFeathersDisplayObject
|  | rotation : Number | IFeathersDisplayObject
|  | scaleX : Number | IFeathersDisplayObject
|  | scaleY : Number | IFeathersDisplayObject
|  | skewX : Number | IFeathersDisplayObject
|  | skewY : Number | IFeathersDisplayObject
|  | stage : Stage [read-only] | IFeathersDisplayObject
|  | touchable : Boolean | IFeathersDisplayObject
|  | transformationMatrix : Matrix [read-only] | IFeathersDisplayObject
|  | useHandCursor : Boolean | IFeathersDisplayObject
|  | visible : Boolean | IFeathersDisplayObject
|  | width : Number | IFeathersDisplayObject
|  | x : Number | IFeathersDisplayObject
|  | y : Number | IFeathersDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function):void | IFeathersEventDispatcher
|  | dispatchEvent(event:Event):void | IFeathersEventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void | IFeathersEventDispatcher
|  | dispose():void | IFeathersDisplayObject
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle | IFeathersDisplayObject
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix | IFeathersDisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point | IFeathersDisplayObject
|  | hasEventListener(type:String):Boolean | IFeathersEventDispatcher
|  | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject | IFeathersDisplayObject
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point | IFeathersDisplayObject
|  | removeEventListener(type:String, listener:Function):void | IFeathersEventDispatcher
|  | removeEventListeners(type:String = null):void | IFeathersEventDispatcher
|  | removeFromParent(dispose:Boolean = false):void | IFeathersDisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void | IFeathersDisplayObject
|  | setSize(width:Number, height:Number):void Sets both the width and the height of the control. | IFeathersControl
|  | validate():void Immediately validates the control, which triggers a redraw, if one is pending. | IFeathersControl

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | initialize | Dispatched after the control has been initialized, but before it has drawn for the first time. | IFeathersControl
|  | resize | Dispatched when the width or height of the control changes. | IFeathersControl

Property Detail

isEnabled | property

`isEnabled:Boolean`

Indicates whether the control is interactive or not.

Implementation
`public function get isEnabled():Boolean`
`public function set isEnabled(value:Boolean):void`

isInitialized | property |

`isInitialized:Boolean` [read-only]

Determines if the component has been initialized yet. The `initialize()` function is called one time only, when the Feathers UI control is added to the display list for the first time.

Implementation
`public function get isInitialized():Boolean`

maxHeight | property |

`maxHeight:Number`

The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit height value that is larger than `maxHeight` may be set and will not be affected by the maximum.

Implementation
`public function get maxHeight():Number`
`public function set maxHeight(value:Number):void`

maxWidth | property |

`maxWidth:Number`

The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit width value that is larger than `maxWidth` may be set and will not be affected by the maximum.

Implementation
`public function get maxWidth():Number`
`public function set maxWidth(value:Number):void`

minHeight | property |

`minHeight:Number`

The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit height value that is smaller than `minHeight` may be set and will not be affected by the minimum.

Implementation
`public function get minHeight():Number`
`public function set minHeight(value:Number):void`

minWidth | property |

`minWidth:Number`

The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit width value that is smaller than `minWidth` may be set and will not be affected by the minimum.

Implementation
`public function get minWidth():Number`
`public function set minWidth(value:Number):void`

nameList | property |

`nameList:TokenList` [read-only]

Contains a list of all "names" assigned to this control. Names are like classes in CSS selectors. They are a non-unique identifier that can differentiate multiple styles of the same type of UI control. A single control may have many names, and many controls can share a single name. Names may be added, removed, or toggled on the `nameList`.

Implementation
`public function get nameList():TokenList`
Method Detail

setSize | () | method

`public function setSize(width:Number, height:Number):void`

Sets both the width and the height of the control.

Parameters

| `width:Number`
| `height:Number`

validate | () | method |

`public function validate():void`

Immediately validates the control, which triggers a redraw, if one is pending. Validation exists to postpone redrawing a component until the last possible moment before rendering so that multiple properties can be changed at once without requiring a full redraw after each change.

A component cannot validate if it does not have access to the stage and if it hasn't initialized yet. A component initializes the first time that it has been added to the stage.

Event Detail

initialize | Event

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

Dispatched after the control has been initialized, but before it has drawn for the first time. Typically, the component's children will have been created by this point.

The `FeathersEventType.INITIALIZE` event type is meant to be used when an `IFeathersControl` has finished running its `initialize()` function.

resize | Event |

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

Dispatched when the width or height of the control changes.

The `FeathersEventType.RESIZE` event type is meant to be used when an `IFeathersControl` has resized.

Thu Jan 16 2014, 01:11 PM +08:00