avail/avail.anvil.shortcuts/WorkbenchShortcut

WorkbenchShortcut

sealed class WorkbenchShortcut : KeyboardShortcut

A KeyboardShortcut that is used to launch an AbstractWorkbenchAction while using the AvailWorkbench.

Parameters

defaultKey

The default Key when pressed triggers this shortcut.

key

The Key used for this shortcut. Defaults to defaultKey.

Functions

open fun addToInputMap(inputMap: InputMap)

Add this KeyboardShortcut to the provided InputMap.

open fun matchesOther(bks: BaseKeyboardShortcut): Boolean

Check to see if the provided BaseKeyboardShortcut matches the key bindings of this BaseKeyboardShortcut while having different actionMapKeys.

resetToDefaults

fun resetToDefaults()

Reset the key to the defaultKey.

fun updateFrom(keyStroke: KeyStroke): Boolean

Update this KeyboardShortcut to match the ModifierKeys and KeyCode used in the provided KeyStroke.

Properties

abstract val actionMapKey: String

The key that identifies this BaseKeyboardShortcut.

open override val category: KeyboardShortcutCategory

The KeyboardShortcutCategory this shortcut belongs to.

open val customizable: Boolean = true

This KeyboardShortcut is permitted to customized for an environment.

open override val defaultKey: Key

abstract val description: String

The description of the action the shortcut performs.

descriptionDisplay

val descriptionDisplay: String

The description that is displayed that describes the shortcut or the actionMapKey if the description is empty.

open override var key: Key

open val keyStroke: KeyStroke

The KeyStroke used to trigger this KeyboardShortcut.

shortcutOverride

val shortcutOverride: KeyboardShortcutOverride

A corresponding KeyboardShortcutOverride sourced from this KeyboardShortcut.

Inheritors

WorkbenchBuildShortcut

WorkbenchRefreshShortcut

WorkbenchRefreshStylesheetShortcut

SearchOpenModuleDialogShortcut

DebugActionShortcut

GenerateDocumentationActionShortcut

OpenFileShortcut

NewModuleActionShortcut

CancelBuildActionShortcut

OpenSettingsViewShortcut