| Package | flash.events |
| Class | public class SoftKeyboardEvent |
| Inheritance | SoftKeyboardEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
needsSoftKeyboardproperty
set to true.
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 | |
| relatedObject : InteractiveObject
A reference to a display list object that is related to the event. | SoftKeyboardEvent | ||
| target : Object [read-only]
The event target. | Event | |
| triggerType : String [read-only]
Indicates whether the change in keyboard status has been triggered by
an application (such as programmatic use of requestSoftKeyboard()) or by the user
(such as selecting a text field). | SoftKeyboardEvent | ||
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
SoftKeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObjectVal:InteractiveObject, triggerTypeVal:String)
Creates an event object that contains information about soft keyboard activation and de-activation events. | SoftKeyboardEvent | ||
[override]
Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of
the original. | SoftKeyboardEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the SoftKeyboardEvent object. | SoftKeyboardEvent | ||
|
Returns the primitive value of the specified object. | Object | |
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 | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| 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 defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| 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 | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate 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 | |
| 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 Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| 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 | |
| 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 | |
| SOFT_KEYBOARD_ACTIVATE : String = "softKeyboardActivate" [static]
The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE constant defines the value of the type property SoftKeyboardEvent
object when a soft keyboard is displayed. | SoftKeyboardEvent | ||
| SOFT_KEYBOARD_ACTIVATING : String = "softKeyboardActivating" [static]
The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING constant defines the value of the type property SoftKeyboardEvent
object immediately before a soft keyboard is displayed. | SoftKeyboardEvent | ||
| SOFT_KEYBOARD_DEACTIVATE : String = "softKeyboardDeactivate" [static]
The SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE constant defines the value of the type property SoftKeyboardEvent
object when a soft keyboard is lowered or hidden. | SoftKeyboardEvent | ||
| 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 | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode 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 | |
Property Detail
relatedObject | property |
relatedObject:InteractiveObject| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
A reference to a display list object that is related to the event.
Implementation
public function get relatedObject():InteractiveObject public function set relatedObject(value:InteractiveObject):voidtriggerType | property |
triggerType:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
Indicates whether the change in keyboard status has been triggered by
an application (such as programmatic use of requestSoftKeyboard()) or by the user
(such as selecting a text field).
Implementation
public function get triggerType():StringConstructor Detail
SoftKeyboardEvent | () | Constructor |
public function SoftKeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObjectVal:InteractiveObject, triggerTypeVal:String)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
Creates an event object that contains information about soft keyboard activation and de-activation events. Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event as a constant value (such as SOFT_KEYBOARD_ACTIVATE).
Event listeners can access this information through the
inherited type property.
| |
bubbles:Boolean — Determines whether the Event object participates in the bubbling phase of the
event flow. Event listeners can access this information through the inherited
bubbles property.
| |
cancelable:Boolean — Determines whether the Event object can be canceled. Event listeners can
access this information through the inherited cancelable property.
| |
relatedObjectVal:InteractiveObject — A reference to a display list object that is related to the event.
| |
triggerTypeVal:String — Indicates whether the keyboard event was triggered by an application or user.
|
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new SoftKeyboardEvent object with property values that match those of the original.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
Returns a string that contains all the properties of the SoftKeyboardEvent object. The following format is used:
[SoftKeyboardEvent type=value bubbles=value cancelable=value relatedObjectVal=value
triggerTypeVal=value activating=value]
String — A string that contains all the properties of the SoftKeyboardEvent object.
|
Constant Detail
SOFT_KEYBOARD_ACTIVATE | Constant |
public static const SOFT_KEYBOARD_ACTIVATE:String = "softKeyboardActivate"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE constant defines the value of the type property SoftKeyboardEvent
object when a soft keyboard is displayed.
This event has the following properties:
| Property | Value |
|---|---|
type | SOFT_KEYBOARD_ACTIVATE |
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
relatedObjectVal | A reference to a display list object that is related to the event. |
triggerTypeVal | Indicates whether the keyboard event was triggered by an application or user. |
currentTarget | The object that is actively processing the Event object with an event listener. |
SOFT_KEYBOARD_ACTIVATING | Constant |
public static const SOFT_KEYBOARD_ACTIVATING:String = "softKeyboardActivating"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING constant defines the value of the type property SoftKeyboardEvent
object immediately before a soft keyboard is displayed.
This event has the following properties:
| Property | Value |
|---|---|
type | SOFT_KEYBOARD_ACTIVATING |
bubbles | true |
cancelable | sometimes; this event can be canceled when dispatched by TextField and InteractiveObject instances,
but not when dispatched by StageText instances. |
relatedObjectVal | A reference to a display list object that is related to the event. |
triggerTypeVal | Indicates whether the keyboard event was triggered by an application or user. |
currentTarget | The object that is actively processing the Event object with an event listener. |
SOFT_KEYBOARD_DEACTIVATE | Constant |
public static const SOFT_KEYBOARD_DEACTIVATE:String = "softKeyboardDeactivate"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.2, AIR 2.6 |
The SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE constant defines the value of the type property SoftKeyboardEvent
object when a soft keyboard is lowered or hidden.
This event has the following properties:
| Property | Value |
|---|---|
type | SOFT_KEYBOARD_DEACTIVATE |
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
relatedObjectVal | A reference to a display list object that is related to the event. |
triggerTypeVal | Indicates whether the keyboard event was triggered by an application or user. |
currentTarget | The object that is actively processing the Event object with an event listener. |
Mon Nov 28 2011, 06:48 AM -08:00