ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

SQLUpdateEvent  - AS3

Packageflash.events
Classpublic class SQLUpdateEvent
InheritanceSQLUpdateEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A SQLUpdateEvent object is dispatched by a SQLConnection object when a data change occurs on any table associated with the SQLConnection instance. A data change can result from the execution of a SQL INSERT, UPDATE, or DELETE statement, either directly or as a result of a trigger that fires in connection with the statement execution.

View the examples

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
      rowID : Number
[read-only] The unique row identifier of the row that was inserted, deleted, or updated.
SQLUpdateEvent
      table : String
[read-only] The name of the table whose data change caused the event to be dispatched.
SQLUpdateEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    SQLUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, table:String = null, rowID:Number = 0)
Creates a new SQLUpdateEvent instance.
SQLUpdateEvent
  
    clone():Event
[override] Creates a copy of the SQLUpdateEvent object and sets the value of each property to match that of the original.
SQLUpdateEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      DELETE : String = "delete"
[static] The SQLUpdateEvent.DELETE constant defines the value of the type property of a SQLConnection delete event.
SQLUpdateEvent
      INSERT : String = "insert"
[static] The SQLUpdateEvent.INSERT constant defines the value of the type property of a SQLConnection insert event.
SQLUpdateEvent
      UPDATE : String = "update"
[static] The SQLUpdateEvent.UPDATE constant defines the value of the type property of a SQLConnection update event.
SQLUpdateEvent
Property Detail
    

rowID

property
rowID:Number  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The unique row identifier of the row that was inserted, deleted, or updated.

A row identifier is used to uniquely identify a row in a table within the database. The value is frequently generated by the database.

The row identifier for a single SQL INSERT statement execution can be obtained through the lastInsertRowID property of the SQLResult object returned by the SQLStatement object's getResult() method (when called after the SQLStatement dispatches its result event).

For more information about primary keys and generated row identifiers, see the "CREATE TABLE" and "Expressions" sections in the appendix "SQL support in local databases."



Implementation
    public function get rowID():Number

Related API Elements

    

table

property 
table:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The name of the table whose data change caused the event to be dispatched.



Implementation
    public function get table():String
Constructor Detail
    

SQLUpdateEvent

()Constructor
public function SQLUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, table:String = null, rowID:Number = 0)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a new SQLUpdateEvent instance.

Parameters
type:String — The type of the event, available through the type property.
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling stage of the event flow. The default value is false.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled. The default value is false.
 
table:String (default = null) — Indicates the name of the table whose data changed.
 
rowID:Number (default = 0) — The unique row identifier of the row that was inserted, deleted, or updated.
Method Detail

    clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a copy of the SQLUpdateEvent object and sets the value of each property to match that of the original.

Returns
Event — A new SQLUpdateEvent object with property values that match those of the original.
Constant Detail
    

DELETE

Constant
public static const DELETE:String = "delete"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLUpdateEvent.DELETE constant defines the value of the type property of a SQLConnection delete event. The delete event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
    

INSERT

Constant 
public static const INSERT:String = "insert"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLUpdateEvent.INSERT constant defines the value of the type property of a SQLConnection insert event. The insert event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
    

UPDATE

Constant 
public static const UPDATE:String = "update"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLUpdateEvent.UPDATE constant defines the value of the type property of a SQLConnection update event.

The update event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
SQLUpdateEvent.class.1.as

The following example shows the use of of a SQLUpdateEvent instance in responding to an update event.

var dbStatement:SQLStatement;

function initConnection():void
{
    var dbFile:File = new File(File.separator + "employee.db");
    db.addEventListener(SQLEvent.OPEN, dbOpenHandler);
    db.addEventListener(SQLUpdateEvent.UPDATE, dbUpdateHandler);

    dbStatement.text = "UPDATE employees SET name = :name WHERE id = :id";
    dbStatement.parameters[:name] = "Bruce";
    dbStatement.parameters[:id] = 100;

    dbStatement.sqlConnection = db;

    db.open(dbFile);
}

function dbUpdateHandler(event:SQLUpdateEvent):void
{
    trace(event.type + " for table '" + event.table + "' was fired for row with ID:" + event.rowID);
}

function dbOpenHandler(event:SQLEvent):void
{
    dbStatement.execute();
}