BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: Retrieving Data from Server...
Retrieving Data from Server...
flash.events 

SQLEvent  - AS3

(Beta)
Packageflash.events
Classpublic class SQLEvent
InheritanceSQLEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Adobe AIR dispatches SQLEvent objects when one of the operations performed by a SQLConnection or SQLStatement instance completes successfully.

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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
    SQLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Creates a SQLEvent object to pass as a parameter to event listeners.
SQLEvent
  
    clone():Event
[override] Creates a copy of the SQLEvent object and sets the value of each property to match that of the original.
SQLEvent
 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
      ANALYZE : String = "analyze"
[static] The SQLEvent.ANALYZE constant defines the value of the type property of an analyze event object.
SQLEvent
      ATTACH : String = "attach"
[static] The SQLEvent.ATTACH constant defines the value of the type property of an attach event object.
SQLEvent
      BEGIN : String = "begin"
[static] The SQLEvent.BEGIN constant defines the value of the type property of a begin event object.
SQLEvent
      CANCEL : String = "cancel"
[static] The SQLEvent.CANCEL constant defines the value of the type property of a cancel event object.
SQLEvent
      CLOSE : String = "close"
[static] The SQLEvent.CLOSE constant defines the value of the type property of a close event object.
SQLEvent
      COMMIT : String = "commit"
[static] The SQLEvent.COMMIT constant defines the value of the type property of a commit event object.
SQLEvent
      COMPACT : String = "compact"
[static] The SQLEvent.COMPACT constant defines the value of the type property of a compact event object.
SQLEvent
      DEANALYZE : String = "deanalyze"
[static] The SQLEvent.DEANALYZE constant defines the value of the type property of a deanalyze event object.
SQLEvent
      DETACH : String = "detach"
[static] The SQLEvent.DETACH constant defines the value of the type property of a detach event object.
SQLEvent
      OPEN : String = "open"
[static] The SQLEvent.OPEN constant defines the value of the type property of a open event object.
SQLEvent
      REENCRYPT : String = "reencrypt"
[static] The SQLEvent.REENCRYPT constant defines the value of the type property of a reencrypt event object.
SQLEvent
      RELEASE_SAVEPOINT : String = "releaseSavepoint"
[static] The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the type property of a releaseSavepoint event object.
SQLEvent
      RESULT : String = "result"
[static] The SQLEvent.RESULT constant defines the value of the type property of a result event object.
SQLEvent
      ROLLBACK : String = "rollback"
[static] The SQLEvent.ROLLBACK constant defines the value of the type property of a rollback event object.
SQLEvent
      ROLLBACK_TO_SAVEPOINT : String = "rollbackToSavepoint"
[static] The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the type property of a rollbackToSavepoint event object.
SQLEvent
      SCHEMA : String = "schema"
[static] The SQLEvent.SCHEMA constant defines the value of the type property of a schema event object.
SQLEvent
      SET_SAVEPOINT : String = "setSavepoint"
[static] The SQLEvent.SET_SAVEPOINT constant defines the value of the type property of a setSavepoint event object.
SQLEvent
Constructor Detail
    

SQLEvent

()Constructor
public function SQLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a SQLEvent object to pass as a parameter to event listeners.

Parameters
type:String — The type of the event, available in 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 canceled. The default value is false.
Method Detail

    clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

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

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

ANALYZE

Constant
public static const ANALYZE:String = "analyze"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.ANALYZE constant defines the value of the type property of an analyze event object. This type of event is dispatched when a SQLConnection.analyze() method call completes successfully. The analyze 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

ATTACH

Constant 
public static const ATTACH:String = "attach"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.ATTACH constant defines the value of the type property of an attach event object. This type of event is dispatched when a SQLConnection.attach() method call completes successfully. The attach 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

BEGIN

Constant 
public static const BEGIN:String = "begin"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.BEGIN constant defines the value of the type property of a begin event object. This type of event is dispatched when a SQLConnection.begin() method call completes successfully. The begin 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

CANCEL

Constant 
public static const CANCEL:String = "cancel"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.CANCEL constant defines the value of the type property of a cancel event object. This type of event is dispatched when a SQLConnection.cancel() method call completes successfully. The cancel 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.
targetThe SQLConnection or SQLStatement object that performed the operation.

Related API Elements

    

CLOSE

Constant 
public static const CLOSE:String = "close"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.CLOSE constant defines the value of the type property of a close event object. This type of event is dispatched when a SQLConnection.close() method call completes successfully. The close 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

COMMIT

Constant 
public static const COMMIT:String = "commit"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.COMMIT constant defines the value of the type property of a commit event object. This type of event is dispatched when a SQLConnection.commit() method call completes successfully. The commit 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

COMPACT

Constant 
public static const COMPACT:String = "compact"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.COMPACT constant defines the value of the type property of a compact event object. This type of event is dispatched when a SQLConnection.compact() method call completes successfully. The compact 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

DEANALYZE

Constant 
public static const DEANALYZE:String = "deanalyze"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.DEANALYZE constant defines the value of the type property of a deanalyze event object. This type of event is dispatched when a SQLConnection.deanalyze() method call completes successfully. The deanalyze 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

DETACH

Constant 
public static const DETACH:String = "detach"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.DETACH constant defines the value of the type property of a detach event object. This type of event is dispatched when a SQLConnection.detach() method call completes successfully.

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

OPEN

Constant 
public static const OPEN:String = "open"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.OPEN constant defines the value of the type property of a open event object. This type of event is dispatched when a SQLConnection.open() or SQLConnection.openAsync() method call completes successfully. The open 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

REENCRYPT

Constant 
public static const REENCRYPT:String = "reencrypt"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5

The SQLEvent.REENCRYPT constant defines the value of the type property of a reencrypt event object. This type of event is dispatched when a SQLConnection.reencrypt() method call completes successfully. The reencrypt 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

RELEASE_SAVEPOINT

Constant 
public static const RELEASE_SAVEPOINT:String = "releaseSavepoint"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the type property of a releaseSavepoint event object. This type of event is dispatched when a SQLConnection.releaseSavepoint() method call completes successfully. The releaseSavepoint 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

RESULT

Constant 
public static const RESULT:String = "result"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.RESULT constant defines the value of the type property of a result event object. Dispatched when either the SQLStatement.execute() method or SQLStatement.next() method completes successfully. Once the SQLEvent.RESULT event is dispatched the SQLStatement.getResult() method can be called to access the result data. The result 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.
targetThe SQLStatement object that performed the operation.

Related API Elements

    

ROLLBACK

Constant 
public static const ROLLBACK:String = "rollback"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.ROLLBACK constant defines the value of the type property of a rollback event object. This type of event is dispatched when a SQLConnection.rollback() method call completes successfully. The rollback 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

ROLLBACK_TO_SAVEPOINT

Constant 
public static const ROLLBACK_TO_SAVEPOINT:String = "rollbackToSavepoint"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the type property of a rollbackToSavepoint event object. This type of event is dispatched when a SQLConnection.rollbackToSavepoint() method call completes successfully. The rollbackToSavepoint 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

SCHEMA

Constant 
public static const SCHEMA:String = "schema"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The SQLEvent.SCHEMA constant defines the value of the type property of a schema event object. Dispatched when the SQLConnection.loadSchema() method completes successfully. Once the SQLEvent.SCHEMA event is dispatched the SQLConnection.getSchemaResult() method can be used to get the schema information. The schema 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.
targetThe SQLConnection object that performed the operation.

Related API Elements

    

SET_SAVEPOINT

Constant 
public static const SET_SAVEPOINT:String = "setSavepoint"

Language Version: ActionScript 3.0
Runtime Versions: AIR 2

The SQLEvent.SET_SAVEPOINT constant defines the value of the type property of a setSavepoint event object. This type of event is dispatched when a SQLConnection.setSavepoint() method call completes successfully. The setSavepoint 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.
targetThe SQLConnection object that performed the operation.

Related API Elements