Packagemx.states
Classpublic class SetEventHandler
InheritanceSetEventHandler Inheritance OverrideBase Inheritance OnDemandEventDispatcher Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The SetEventHandler class specifies an event handler that is active only during a particular view state. For example, you might define a Button control that uses one event handler in the base view state, but uses a different event handler when you change view state.

You use this class in the overrides property of the State class.

MXML SyntaxexpandedHide MXML Syntax

The <mx:SetEventHanlder> tag has the following attributes:

  <mx:SetEventHandler
  Properties
  name="null"
  handlerFunction="null"
  target="null"
  
  Events
  handler=No default
  />

See also

mx.states.State
mx.states.SetProperty
mx.states.SetStyle

Public Properties
 PropertyDefined By
  handlerFunction : Function
The handler function for the event.
SetEventHandler
  name : String
The name of the event whose handler is being set.
SetEventHandler
  originalHandlerFunction : Function
The handler function to remove prior to applying our override.
SetEventHandler
  target : Object
The component that dispatches the event.
SetEventHandler
Public Methods
 MethodDefined By
  
SetEventHandler(target:EventDispatcher = null, name:String = null)
Constructor.
SetEventHandler
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
OnDemandEventDispatcher
  
apply(parent:UIComponent):void
[override] Applies the override.
SetEventHandler
 Inherited
dispatchEvent(event:Event):Boolean
OnDemandEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
OnDemandEventDispatcher
 Inherited
initialize():void
IOverride interface method; this class implements it as an empty method.
OverrideBase
  
remove(parent:UIComponent):void
[override] Removes the override.
SetEventHandler
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
OnDemandEventDispatcher
 Inherited
willTrigger(type:String):Boolean
OnDemandEventDispatcher
Events
 Event Summary Defined By
  
handler
The event handler function to execute in response to the event that is specified by the name property.SetEventHandler
Property Detail
handlerFunctionproperty
public var handlerFunction:Function

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The handler function for the event. This property is intended for developers who use ActionScript to create and access view states. In MXML, you can use the equivalent handler event attribute; do not use both in a single MXML tag.

The default value is null.

nameproperty 
public var name:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The name of the event whose handler is being set. You must set this property, either in the SetEventHandler constructor or by setting the property value directly.

originalHandlerFunctionproperty 
public var originalHandlerFunction:Function

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 9, AIR 1.1

The handler function to remove prior to applying our override.

The default value is null.

targetproperty 
public var target:Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The component that dispatches the event. If the property value is null, Flex uses the immediate parent of the <mx:states> tag.

The default value is null.

Constructor Detail
SetEventHandler()Constructor
public function SetEventHandler(target:EventDispatcher = null, name:String = null)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
target:EventDispatcher (default = null) — The object that dispatches the event to be handled. By default, Flex uses the immediate parent of the State object.
 
name:String (default = null) — The event type for which to set the handler.
Method Detail
apply()method
override public function apply(parent:UIComponent):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Applies the override. Flex retains the original value, so that it can restore the value later in the remove() method.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

remove()method 
override public function remove(parent:UIComponent):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Removes the override. The value remembered in the apply() method is restored.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

Event Detail
handler Event
Event Object Type: Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The event handler function to execute in response to the event that is specified by the name property.

Do not specify the handler property and the handlerFunction property in a single <mx:SetEventHandler> tag.

Flex does not dispatch a handler event. You use the handler key word only as an MXML attribte. When you use the handler handler attribute, you can specify a method that takes multiple parameters, not just the Event object; also, you can specify the handler code in-line in the MXML tag.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00