Class ZCircusKeyBuilder

Represents a builder for an IZCircusKey object.

Index

Constructors

Methods

build modifier printable shift toggle upper

Constructors

constructor

new ZCircusKeyBuilder(key: string, code: string): ZCircusKeyBuilder
Initializes a new instance of this object.
Parameters
- key: string
  The key value as a lower case variant.
- code: string
  The key code.
Returns ZCircusKeyBuilder
- Defined in keyboard/circus-key.mts:66

Methods

build

build(): IZCircusKey
Builds the key.

Returns IZCircusKey
A shallow copy of the built key.
- Defined in keyboard/circus-key.mts:142

modifier

modifier(): this
Sets the modifier flag.

Returns this
This object.
- Defined in keyboard/circus-key.mts:109

printable

printable(): this
Sets the printable flag.

Returns this
This object.
- Defined in keyboard/circus-key.mts:98

shift

shift(): this
Sets the shift flag.

Returns this
This object.
- Defined in keyboard/circus-key.mts:120

toggle

toggle(): this
Sets the toggle flag.

Returns this
This object.
- Defined in keyboard/circus-key.mts:131

upper

upper(key: string): this
Sets the upper case variant of this key.
Parameters
- key: string
  The key to set.
Returns this
This object.
- Defined in keyboard/circus-key.mts:87