qnx.events.ShortcutEvent

ShortcutEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class ShortcutEvent
InheritanceShortcutEvent Inheritance flash.events.Event

Dispatched by the ShortcutManger class when platform shortcuts are triggered.

Class information:
BlackBerry 10 Version:   10.0.0
Found in:  QNXDevice.ane

See also

qnx.system.ShortcutManager



Public Properties

 PropertyDefined By
  keys : Array
[read-only] An Array of keys that were pressed to trigger this ShortcutEvent.
ShortcutEvent

Public Methods

 MethodDefined By
  
ShortcutEvent(type:String, keys:Array)
Creates a ShortcutEvent instance.
ShortcutEvent

Public Constants

 ConstantDefined By
  BOTTOM : String = bottom
[static] When triggered, scrollable views should jump to the bottom of the content.
ShortcutEvent
  CREATE_NEW : String = createNew
[static] When triggered, a new document, or other related composing action, should be created.
ShortcutEvent
  DELETE : String = delete
[static] When triggered, applications should delete the currently selected item.
ShortcutEvent
  ENTER : String = enter
[static] When triggered, applications should commit the current selection.
ShortcutEvent
  FORWARD : String = forward
[static] When triggered, applications should forward the currently selected item.
ShortcutEvent
  INCREMENTAL_SEARCH : String = incrementalSearch
[static] Triggered when the user hits an alphanumeric key.
ShortcutEvent
  INCREMENTAL_SEARCH_RESET : String = incrementalSearchReset
[static] Triggered after the user stops hitting keys in rapid succession.
ShortcutEvent
  NEXT : String = next
[static] When triggered, scrollable views should jump to the next section.
ShortcutEvent
  NEXT_UNREAD : String = nextUnread
[static] When triggered, scrollable views should jump to the next unread item.
ShortcutEvent
  PREVIOUS : String = previous
[static] When triggered, scrollable views should jump to the previous section.
ShortcutEvent
  REPLY : String = reply
[static] When triggered, applications should create a reply to the currently selected item.
ShortcutEvent
  REPLY_ALL : String = replyAll
[static] When triggered, applications should create a reply all to the currently selected item.
ShortcutEvent
  SCROLL_SCREEN_DOWN : String = scrollScreenDown
[static] When triggered, scrollable views should scroll down one full screen length.
ShortcutEvent
  SCROLL_SCREEN_UP : String = scrollScreenUp
[static] When triggered, scrollable views should scroll up one full screen length.
ShortcutEvent
  SEARCH : String = search
[static] When triggered, focus should move to a search field.
ShortcutEvent
  SHORTCUT_PRESSED : String = shortcutPressed
Deprecated: SHORTCUT_PRESSED has been deprecated as shortcuts trigger on key down. Use ShortcutEvent.SHORTCUT_SELECTED instead.
[static] Triggered when all the keys in a custom shortcut are pressed in order.
ShortcutEvent
  SHORTCUT_SELECTED : String = shortcutSelected
[static] Triggered when all the keys in a custom shortcut are pressed in order.
ShortcutEvent
  TOP : String = top
[static] When triggered, scrollable views should jump to the top of the content.
ShortcutEvent
  ZOOM_IN : String = zoomIn
[static] When triggered, applications should zoom in.
ShortcutEvent
  ZOOM_OUT : String = zoomOut
[static] When triggered, applications should zoom out.
ShortcutEvent

Property Detail

keys


keys:Array  [read-only]

An Array of keys that were pressed to trigger this ShortcutEvent.


Implementation

public function get keys():Array

Constructor Detail

ShortcutEvent()


public function ShortcutEvent(type:String, keys:Array)

Creates a ShortcutEvent instance.

Parameters

type:String — The type of event.
keys:Array — An Array of keys that triggered the event.

Constant Detail

BOTTOM


public static const BOTTOM:String = bottom

When triggered, scrollable views should jump to the bottom of the content.

The ShortcutEvent.BOTTOM constant defines the value of the type property of the event object for an bottom event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.BOTTOM

CREATE_NEW


public static const CREATE_NEW:String = createNew

When triggered, a new document, or other related composing action, should be created.

The ShortcutEvent.CREATE_NEW constant defines the value of the type property of the event object for an createNew event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.CREATE_NEW

DELETE


public static const DELETE:String = delete

When triggered, applications should delete the currently selected item.

The ShortcutEvent.DELETE constant defines the value of the type property of the event object for an delete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.DELETE

ENTER


public static const ENTER:String = enter

When triggered, applications should commit the current selection.

The ShortcutEvent.ENTER constant defines the value of the type property of the event object for an enter event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.ENTER

FORWARD


public static const FORWARD:String = forward

When triggered, applications should forward the currently selected item.

The ShortcutEvent.FORWARD constant defines the value of the type property of the event object for an forward event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.FORWARD

INCREMENTAL_SEARCH


public static const INCREMENTAL_SEARCH:String = incrementalSearch

Triggered when the user hits an alphanumeric key. The event's keys property is String buffer of all the keys the user has hit in rapid succession. If the user waits a small ammount of time, the string buffer is reset.

The ShortcutEvent.INCREMENTAL_SEARCH constant defines the value of the type property of the event object for an incrementalSearch event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.INCREMENTAL_SEARCH

INCREMENTAL_SEARCH_RESET


public static const INCREMENTAL_SEARCH_RESET:String = incrementalSearchReset

Triggered after the user stops hitting keys in rapid succession. When this event fires, the key buffer sent in an INCREMENTAL_SEARCH event is reset.

The ShortcutEvent.INCREMENTAL_SEARCH_RESET constant defines the value of the type property of the event object for an incrementalSearchReset event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.INCREMENTAL_SEARCH_RESET

NEXT


public static const NEXT:String = next

When triggered, scrollable views should jump to the next section.

The ShortcutEvent.NEXT constant defines the value of the type property of the event object for an next event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.NEXT

NEXT_UNREAD


public static const NEXT_UNREAD:String = nextUnread

When triggered, scrollable views should jump to the next unread item.

The ShortcutEvent.NEXT_UNREAD constant defines the value of the type property of the event object for an nextUnread event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.NEXT_UNREAD

PREVIOUS


public static const PREVIOUS:String = previous

When triggered, scrollable views should jump to the previous section.

The ShortcutEvent.PREVIOUS constant defines the value of the type property of the event object for an previous event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.PREVIOUS

REPLY


public static const REPLY:String = reply

When triggered, applications should create a reply to the currently selected item.

The ShortcutEvent.REPLY constant defines the value of the type property of the event object for an reply event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.REPLY

REPLY_ALL


public static const REPLY_ALL:String = replyAll

When triggered, applications should create a reply all to the currently selected item.

The ShortcutEvent.REPLY_ALL constant defines the value of the type property of the event object for an replyAll event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.REPLY_ALL

SCROLL_SCREEN_DOWN


public static const SCROLL_SCREEN_DOWN:String = scrollScreenDown

When triggered, scrollable views should scroll down one full screen length.

The ShortcutEvent.SCROLL_SCREEN_DOWN constant defines the value of the type property of the event object for an scrollScreenDown event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.SCROLL_SCREEN_DOWN

SCROLL_SCREEN_UP


public static const SCROLL_SCREEN_UP:String = scrollScreenUp

When triggered, scrollable views should scroll up one full screen length.

The ShortcutEvent.SCROLL_SCREEN_UP constant defines the value of the type property of the event object for an scrollScreenUp event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.SCROLL_SCREEN_UP

SEARCH


public static const SEARCH:String = search

When triggered, focus should move to a search field.

The ShortcutEvent.SEARCH constant defines the value of the type property of the event object for an search event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.SEARCH

SHORTCUT_PRESSED


public static const SHORTCUT_PRESSED:String = shortcutPressed
Deprecated: SHORTCUT_PRESSED has been deprecated as shortcuts trigger on key down. Use ShortcutEvent.SHORTCUT_SELECTED instead.

Triggered when all the keys in a custom shortcut are pressed in order. Once a key is released a SHORTCUT_SELECTED event is dispatched.

The ShortcutEvent.SHORTCUT_PRESSED constant defines the value of the type property of the event object for an shortcutPressed event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.SHORTCUT_PRESSED

SHORTCUT_SELECTED


public static const SHORTCUT_SELECTED:String = shortcutSelected

Triggered when all the keys in a custom shortcut are pressed in order.

The ShortcutEvent.SHORTCUT_SELECTED constant defines the value of the type property of the event object for an shortcutSelected event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.SHORTCUT_SELECTED

TOP


public static const TOP:String = top

When triggered, scrollable views should jump to the top of the content.

The ShortcutEvent.TOP constant defines the value of the type property of the event object for an top event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.TOP

ZOOM_IN


public static const ZOOM_IN:String = zoomIn

When triggered, applications should zoom in.

The ShortcutEvent.ZOOM_IN constant defines the value of the type property of the event object for an zoomIn event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.ZOOM_IN

ZOOM_OUT


public static const ZOOM_OUT:String = zoomOut

When triggered, applications should zoom out.

The ShortcutEvent.ZOOM_OUT constant defines the value of the type property of the event object for an zoomOut event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
keysAn Array of keys that triggered the event.
typeShortcutEvent.ZOOM_OUT





comments powered by Disqus