InteractionStateDetector

Package	spark.components.supportClasses
Class	public class InteractionStateDetector
Inheritance	InteractionStateDetector EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.1, AIR 2.5

A helper class for components to use to help them determine if they should be in the up, over, or down states.

As the state changes, if the transition should play, the playTransitions.

Related API Elements

spark.components.supportClasses.InteractionState

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		state : String [read-only] Returns the state of the component Possible values are: InteractionState.UP InteractionState.DOWN InteractionState.OVER	InteractionStateDetector

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		InteractionStateDetector(component:UIComponent) Constructor	InteractionStateDetector
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
change	Dispatched after the state has changed.	InteractionStateDetector
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

state

property

state:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.1, AIR 2.5

Returns the state of the component

Possible values are:

InteractionState.UP
InteractionState.DOWN
InteractionState.OVER

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

Implementation
public function get state():String

Related API Elements

spark.components.supportClasses.InteractionState;

Constructor Detail

()

Constructor

public function InteractionStateDetector(component:UIComponent)

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.1, AIR 2.5

Constructor

Parameters

component:UIComponent — The UIComponent to detect the up/over/down state on. The event listeners are attached to this object.

Event Detail

change

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CHANGE

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.1, AIR 2.5

Dispatched after the state has changed.

The Event.CHANGE constant defines the value of the type property of a change event object.

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that has had its value modified. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

InteractionStateDetector - AS3 Flex

Classes x

state

InteractionStateDetector

change

spark.components.supportClasses InteractionStateDetector - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples