Class ItemsUiAction<T>`Abstract`

Type Parameters

T

Hierarchy (View Summary)

ItemUiAction<readonly T[]>
- ItemsUiAction
  - SelectItemsUiAction
  - StringArrayUiAction

Constructors

constructor

new ItemsUiAction<T>(valueRequired?: boolean): ItemsUiAction<T>
Type Parameters
- T
Parameters
- valueRequired: boolean = true
Returns ItemsUiAction<T>
Overrides ItemUiAction.constructor

Accessors

autoAcceptanceTypeId

get autoAcceptanceTypeId(): AutoAcceptanceTypeId
Returns AutoAcceptanceTypeId
Inherited from ItemUiAction.autoAcceptanceTypeId
set autoAcceptanceTypeId(value: AutoAcceptanceTypeId): void
Parameters
- value: AutoAcceptanceTypeId
Returns void
Inherited from ItemUiAction.autoAcceptanceTypeId

autoEchoCommit

get autoEchoCommit(): boolean
Returns boolean
Inherited from ItemUiAction.autoEchoCommit
set autoEchoCommit(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ItemUiAction.autoEchoCommit

autoInvalid

get autoInvalid(): boolean
Returns boolean
Inherited from ItemUiAction.autoInvalid
set autoInvalid(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ItemUiAction.autoInvalid

caption

get caption(): string
Returns string
Inherited from ItemUiAction.caption

commitEvent

get commitEvent(): undefined | CommitEventHandler
Returns undefined | CommitEventHandler
Inherited from ItemUiAction.commitEvent
set commitEvent(value: undefined | CommitEventHandler): void
Parameters
- value: undefined | CommitEventHandler
Returns void
Inherited from ItemUiAction.commitEvent

commitOnAnyValidInput

get commitOnAnyValidInput(): boolean
Returns boolean
Inherited from ItemUiAction.commitOnAnyValidInput
set commitOnAnyValidInput(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ItemUiAction.commitOnAnyValidInput

definedValue

get definedValue(): T
Returns T
Inherited from ItemUiAction.definedValue

edited

get edited(): boolean
Returns boolean
Inherited from ItemUiAction.edited

editedChangeEvent

get editedChangeEvent(): undefined | EditedChangeEventHandler
Returns undefined | EditedChangeEventHandler
Inherited from ItemUiAction.editedChangeEvent
set editedChangeEvent(value: undefined | EditedChangeEventHandler): void
Parameters
- value: undefined | EditedChangeEventHandler
Returns void
Inherited from ItemUiAction.editedChangeEvent

editedInvalidErrorText

get editedInvalidErrorText(): undefined | string
Returns undefined | string
Inherited from ItemUiAction.editedInvalidErrorText

editedMissing

get editedMissing(): boolean
Returns boolean
Inherited from ItemUiAction.editedMissing

editedValid

get editedValid(): boolean
Returns boolean
Inherited from ItemUiAction.editedValid

enabled

get enabled(): boolean
Returns boolean
Inherited from ItemUiAction.enabled

inputEvent

get inputEvent(): undefined | InputEventHandler
Returns undefined | InputEventHandler
Inherited from ItemUiAction.inputEvent
set inputEvent(value: undefined | InputEventHandler): void
Parameters
- value: undefined | InputEventHandler
Returns void
Inherited from ItemUiAction.inputEvent

inputtedText

get inputtedText(): string
Returns string
Inherited from ItemUiAction.inputtedText

placeholder

get placeholder(): string
Returns string
Inherited from ItemUiAction.placeholder

signalEvent

get signalEvent(): undefined | SignalEventHandler
Returns undefined | SignalEventHandler
Inherited from ItemUiAction.signalEvent
set signalEvent(value: undefined | SignalEventHandler): void
Parameters
- value: undefined | SignalEventHandler
Returns void
Inherited from ItemUiAction.signalEvent

stateId

get stateId(): StateId
Returns StateId
Inherited from ItemUiAction.stateId

title

get title(): string
Returns string
Inherited from ItemUiAction.title

value

get value(): undefined | T
Returns undefined | T
Inherited from ItemUiAction.value

valueRequired

get valueRequired(): boolean
Returns boolean
Inherited from ItemUiAction.valueRequired
set valueRequired(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ItemUiAction.valueRequired

valueUndefined

get valueUndefined(): boolean
Returns boolean
Inherited from ItemUiAction.valueUndefined

Methods

cancelEdit

cancelEdit(): void
Returns void
Inherited from ItemUiAction.cancelEdit

commitValue

commitValue(value: undefined | readonly T[], typeId: CommitTypeId): void
Parameters
- value: undefined | readonly T[]
- typeId: CommitTypeId
Returns void
Inherited from ItemUiAction.commitValue

createPushEventHandlersInterface

createPushEventHandlersInterface(): UiAction.PushEventHandlersInterface
Returns UiAction.PushEventHandlersInterface
Inherited from ItemUiAction.createPushEventHandlersInterface

finalise

finalise(): void
Returns void
Inherited from ItemUiAction.finalise

input

input(
    text: string,
    valid: boolean,
    missing: boolean,
    errorText: undefined | string,
): void
Parameters
- text: string
- valid: boolean
- missing: boolean
- errorText: undefined | string
Returns void
Inherited from ItemUiAction.input

isValueOk

isValueOk(): boolean
Returns boolean
Inherited from ItemUiAction.isValueOk

isValueOkOrDisabled

isValueOkOrDisabled(): boolean
Returns boolean
Inherited from ItemUiAction.isValueOkOrDisabled

pushAccepted

pushAccepted(value?: boolean): void
Parameters
- Optionalvalue: boolean
Returns void
Inherited from ItemUiAction.pushAccepted

pushCaption

pushCaption(value: string): void
Parameters
- value: string
Returns void
Inherited from ItemUiAction.pushCaption

pushDisabled

pushDisabled(disabledTitleText?: string): void
Parameters
- OptionaldisabledTitleText: string
Returns void
Inherited from ItemUiAction.pushDisabled

pushError

pushError(errorTitleText?: string): void
Parameters
- OptionalerrorTitleText: string
Returns void
Inherited from ItemUiAction.pushError

pushInvalid

pushInvalid(invalidTitleText?: string): void
Parameters
- OptionalinvalidTitleText: string
Returns void
Inherited from ItemUiAction.pushInvalid

pushPlaceholder

pushPlaceholder(value: string): void
Parameters
- value: string
Returns void
Inherited from ItemUiAction.pushPlaceholder

pushReadonly

pushReadonly(): void
Returns void
Inherited from ItemUiAction.pushReadonly

pushState

pushState(newStateId: StateId, stateTitleText?: string): void
Parameters
- newStateId: StateId
- OptionalstateTitleText: string
Returns void
Inherited from ItemUiAction.pushState

pushTitle

pushTitle(value: string): void
Parameters
- value: string
Returns void
Inherited from ItemUiAction.pushTitle

pushValidOrMissing

pushValidOrMissing(titleText?: string): void
Parameters
- OptionaltitleText: string
Returns void
Inherited from ItemUiAction.pushValidOrMissing

pushValue

pushValue(value: undefined | readonly T[]): void
Parameters
- value: undefined | readonly T[]
Returns void
Inherited from ItemUiAction.pushValue

pushWaiting

pushWaiting(waitingTitleText?: string): void
Parameters
- OptionalwaitingTitleText: string
Returns void
Inherited from ItemUiAction.pushWaiting

pushWarning

pushWarning(warningTitleText?: string): void
Parameters
- OptionalwarningTitleText: string
Returns void
Inherited from ItemUiAction.pushWarning

signal

signal(signalTypeId: SignalTypeId, downKeys: number): void
Parameters
- signalTypeId: SignalTypeId
- downKeys: number
Returns void
Inherited from ItemUiAction.signal

subscribePushEvents

subscribePushEvents(
handlersInterface: ItemUiAction.PushEventHandlersInterface<readonly T[]>,
): number
Parameters
- handlersInterface: ItemUiAction.PushEventHandlersInterface<readonly T[]>
Returns number
Inherited from ItemUiAction.subscribePushEvents

unsubscribePushEvents

unsubscribePushEvents(subscriptionId: SubscriptionId): void
Parameters
- subscriptionId: SubscriptionId
Returns void
Inherited from ItemUiAction.unsubscribePushEvents