Packagefeathers.core
Interfacepublic interface IStateContext extends IFeathersEventDispatcher
Implementors BasicButton, TextArea, TextInput, ToggleSwitch

Product Version : Feathers 2.3.0

An object with multiple states.


Public Properties
 PropertyDefined By
  currentState : String
[read-only] The object's current state.
IStateContext
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
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
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
Events
 Event Summary Defined By
  
stateChange
Dispatched when the display object's state changes.IStateContext
Property Detail
currentStateproperty
currentState:String  [read-only]

The object's current state.


Implementation
    public function get currentState():String

See also

feathers.events.FeathersEventType.STATE_CHANGE
Event Detail
stateChange Event
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.STATE_CHANGE

Dispatched when the display object's state changes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
datanull
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

The FeathersEventType.STATE_CHANGE event type is used by Feathers classes that implement the IStateContext interface.




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