flash.events

# SoftKeyboardEvent - AS3

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

A SoftKeyboardEvent object is dispatched when a software-driven keyboard is activated or de-activated on a device or operating system. A SoftKeyboardEvent object is dispatched by a TextField or InteractiveObject that has the `needsSoftKeyboard`property 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
|  | 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
Hide Inherited Public Methods
Show Inherited 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
|  | clone():Event [override] Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of the original. | SoftKeyboardEvent
|  | 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 [override] Returns a string that contains all the properties of the SoftKeyboardEvent object. | SoftKeyboardEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | 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

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):void`

### triggerType

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():String`
Constructor 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.

Parameters

| `type: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.

Returns

| `Event` — 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]`

Returns

| `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. For this event, `cancellable = false`.

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. For this event, `cancellable = true`.

This event has the following properties:

Property | Value
--- | ---
`type` | `SOFT_KEYBOARD_ACTIVATING`
`bubbles` | `true`
`cancelable` | `true` unless the event is dispatched by a StageText object. For StageText objects, the event is not cancellable.
`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. For this event, `cancellable = false`.

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00