flash.events.SQLEvent - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.events
Class	public class SQLEvent
Inheritance	SQLEvent Event 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.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		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
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The SQLEvent.CLOSE constant defines the value of the type property of a close event object.	SQLEvent
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		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
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		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
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The SQLEvent.OPEN constant defines the value of the type property of a open event object.	SQLEvent
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		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
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		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
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SET_SAVEPOINT : String = "setSavepoint" [static] The SQLEvent.SET_SAVEPOINT constant defines the value of the type property of a setSavepoint event object.	SQLEvent
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.	Event
		STANDARD_INPUT_CLOSE : String = "standardInputClose" [static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.	Event
		STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.analyze()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.attach()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.begin()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection or SQLStatement object that performed the operation.

See also

flash.data.SQLConnection.cancel()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.close()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.commit()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.compact()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.deanalyze()

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.

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.detach()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.reencrypt()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

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:

Property	Value
`bubbles`	`false`
`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 SQLStatement object that performed the operation.

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.rollback()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.loadSchema()

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:

Property	Value
`bubbles`	`false`
`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 SQLConnection object that performed the operation.

See also

flash.data.SQLConnection.setSavepoint()