avail/avail.anvil.shortcuts/KeyboardShortcutCategory

KeyboardShortcutCategory

enum KeyboardShortcutCategory : Enum<KeyboardShortcutCategory>

An enumeration of the different categorization of KeyboardShortcuts.

Author

Richard Arriaga

Entries

KeyboardShortcuts across all JTextPanes.

KeyboardShortcuts for AvailEditors.

KeyboardShortcuts across all CodePanes.

KeyboardShortcuts for the AvailDebugger.

KeyboardShortcuts for the FileEditor.

KeyboardShortcuts for the AvailWorkbench.

Types

object Companion

Properties

val display: String

val name: String

val ordinal: Int

overlapCategories

open val overlapCategories: Set<KeyboardShortcutCategory>

The set of other KeyboardShortcutCategorys that are also active when this KeyboardShortcutCategory os active. The shortcuts of this KeyboardShortcutCategory and the shortcuts of the KeyboardShortcutCategorys in this set are all available at the same time from at least one screen. The consequence is that the KeyboardShortcut.keyStrokes must be unique across all these shortcuts.

abstract val shortcuts: List<KeyboardShortcut>

The list of KeyboardShortcuts in this KeyboardShortcutCategory.

shortcutsByDescription

val shortcutsByDescription: List<KeyboardShortcut>

The shortcuts sorted by KeyboardShortcut.descriptionDisplay.

Functions

checkShortcutsUnique

fun checkShortcutsUnique(): List<Set<KeyboardShortcut>>

Check to see that the shortcuts of this category and the shortcuts of all the overlapCategories are unique relative to each other.

checkShortcutsUniqueAgainst

fun checkShortcutsUniqueAgainst(bks: BaseKeyboardShortcut): Set<KeyboardShortcut>

Check to see that the shortcuts of this category and the shortcuts of all the overlapCategories are unique relative to the provided BaseKeyboardShortcut.

keyboardShortcut

fun keyboardShortcut(actionMapKey: String): KeyboardShortcut?

Answer the KeyboardShortcut associated with the provided KeyboardShortcut.actionMapKey.

fun valueOf(value: String): KeyboardShortcutCategory

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<KeyboardShortcutCategory>

Returns an array containing the constants of this enum type, in the order they're declared.