A bundle (similar to a BiStringBundle) but containing BiKeystroke objects instead of strings. This is also not switched based on language, but based on platform (Mac) and other preferences.

This class extends BiAbstractLoader and therefore all methods and fields available for BiAbstractLoader are also available for BiKeyBundle .

Constructor

new BiKeyBundle ( )

Parameters

No parameters.

Properties

NameTypegetsetDescription
bundleObjectcheckedThe actual keystrokes info
mergeBooleancheckedcheckedWhether to merge this or simply overwrite the default.
srcBiUricheckedcheckedAlias to uri for backwards compatibility
textStringcheckedThe script text to evaluate
uriBiUricheckedcheckedThe location of the script file

Methods

NameDescription
abortStops the current loading
getModifiersFind a set (or sets) of named modifiers in the active key bundle.
getShortcutsFind keyboard shortcuts for a specified action in the key bundle.

Events

None.

Static Methods

None.

Static Fields

None.

Enumerations

None.

Remarks

None.

Method Details

abort

Stops the current loading

Syntax

object.abort ( )

Parameters

No arguments.

Return Type

void

getModifiers

Find a set (or sets) of named modifiers in the active key bundle.

Syntax

object.getModifiers ( sName )

Parameters

NameTypeOptionalDefaultDescription
sNameStringthe name of an action that uses keyboard modifiers

Return Type

Number[]

getShortcuts

Find keyboard shortcuts for a specified action in the key bundle.

Syntax

object.getShortcuts ( sName )

Parameters

NameTypeOptionalDefaultDescription
sNameStringthe name of an action that can be triggered with keyboard shortcuts

Return Type

BiKeystroke[]