Packagefeathers.core
Interfacepublic interface IFeathersControl
Implementors FeathersControl

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



Public Properties
 PropertyDefined By
  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
  nameList : TokenList
[read-only] Contains a list of all "names" assigned to this control.
IFeathersControl
Public Methods
 MethodDefined By
  
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
  Dispatched after the control has been initialized, but before it has drawn for the first time.IFeathersControl
  Dispatched when the width or height of the control changes.IFeathersControl
Property Detail
isEnabledproperty
isEnabled:Boolean

Indicates whether the control is interactive or not.


Implementation
    public function get isEnabled():Boolean
    public function set isEnabled(value:Boolean):void
isInitializedproperty 
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
maxHeightproperty 
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
maxWidthproperty 
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
minHeightproperty 
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
minWidthproperty 
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
nameListproperty 
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.

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.