Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
PropertyChangeEvent

Package | mx.events
Class | public class PropertyChangeEvent
Inheritance | PropertyChangeEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The PropertyChangeEvent class represents the event object passed to the event listener when one of the properties of an object has changed, and provides information about the change. This event is used by collection classes, and is the only way for collections to know that the data they represent has changed. This event is also used by the Flex data binding mechanism.

See also

PropertyChangeEventKind

Public Properties

| Property | Defined By
--- | --- | ---
|  | kind : String Specifies the kind of change. | PropertyChangeEvent
|  | newValue : Object The value of the property after the change. | PropertyChangeEvent
|  | oldValue : Object The value of the property before the change. | PropertyChangeEvent
|  | property : Object A String, QName, or int specifying the property that changed. | PropertyChangeEvent
|  | source : Object The object that the change occured on. | PropertyChangeEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | PropertyChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null) Constructor. | PropertyChangeEvent
|  | createUpdateEvent(source:Object, property:Object, oldValue:Object, newValue:Object):PropertyChangeEvent [static] Returns a new PropertyChangeEvent of kind PropertyChangeEventKind.UPDATE with the specified properties. | PropertyChangeEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | PROPERTY_CHANGE : String = propertyChange [static] The PropertyChangeEvent.PROPERTY_CHANGE constant defines the value of the type property of the event object for a PropertyChange event. | PropertyChangeEvent

Property Detail

kind | property

`public var kind:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the kind of change. The possible values are `PropertyChangeEventKind.UPDATE`, `PropertyChangeEventKind.DELETE`, and `null`.

newValue | property |

`public var newValue:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the property after the change.

oldValue | property |

`public var oldValue:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The value of the property before the change.

property | property |

`public var property:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A String, QName, or int specifying the property that changed.

source | property |

`public var source:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The object that the change occured on.

Constructor Detail

PropertyChangeEvent | () | Constructor

`public function PropertyChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that triggered the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.
| `kind:String` (default = `null`)`` — Specifies the kind of change. The possible values are `PropertyChangeEventKind.UPDATE`, `PropertyChangeEventKind.DELETE`, and `null`.
| `property:Object` (default = `null`)`` — A String, QName, or int specifying the property that changed.
| `oldValue:Object` (default = `null`)`` — The value of the property before the change.
| `newValue:Object` (default = `null`)`` — The value of the property after the change.
| `source:Object` (default = `null`)`` — The object that the change occured on.

Method Detail

createUpdateEvent | () | method

`public static function createUpdateEvent(source:Object, property:Object, oldValue:Object, newValue:Object):PropertyChangeEvent`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a new PropertyChangeEvent of kind `PropertyChangeEventKind.UPDATE` with the specified properties. This is a convenience method.

Parameters

| `source:Object` — The object where the change occured.
| `property:Object` — A String, QName, or int specifying the property that changed,
| `oldValue:Object` — The value of the property before the change.
| `newValue:Object` — The value of the property after the change.

Returns

| `PropertyChangeEvent` — A newly constructed PropertyChangeEvent with the specified properties.

Constant Detail

PROPERTY_CHANGE | Constant

`public static const PROPERTY_CHANGE:String = propertyChange`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `PropertyChangeEvent.PROPERTY_CHANGE` constant defines the value of the `type` property of the event object for a `PropertyChange` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | Determined by the constructor; defaults to false.
`cancelable` | Determined by the constructor; defaults to false.
`kind` | The kind of change; PropertyChangeEventKind.UPDATE or PropertyChangeEventKind.DELETE.
`oldValue` | The original property value.
`newValue` | The new property value, if any.
`property` | The property that changed.
`source` | The object that contains the property that changed.
`currentTarget` | The 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`.
`target` | The 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.

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