Winter Cardinal UI - v0.442.0 / UtilInput

Class: UtilInput<VALUE, ELEMENT, TARGET, OPERATION, THEME, OPTIONS>

Type parameters

Name Type
VALUE unknown
ELEMENT extends HTMLInputElement | HTMLTextAreaElement = HTMLInputElement | HTMLTextAreaElement
TARGET extends UtilInputTarget = UtilInputTarget
OPERATION extends UtilInputOperation<VALUE, ELEMENT> = UtilInputOperation<VALUE, ELEMENT>
THEME extends UtilThemeInput<VALUE, ELEMENT> = UtilThemeInput<VALUE, ELEMENT>
OPTIONS extends UtilInputOptions<VALUE, ELEMENT> = UtilInputOptions<VALUE, ELEMENT>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new UtilInput<VALUE, ELEMENT, TARGET, OPERATION, THEME, OPTIONS>(target, operation, theme, options?): UtilInput<VALUE, ELEMENT, TARGET, OPERATION, THEME, OPTIONS>

Type parameters

Name Type
VALUE unknown
ELEMENT extends HTMLInputElement | HTMLTextAreaElement = HTMLInputElement | HTMLTextAreaElement
TARGET extends UtilInputTarget = UtilInputTarget
OPERATION extends UtilInputOperation<VALUE, ELEMENT> = UtilInputOperation<VALUE, ELEMENT>
THEME extends UtilThemeInput<VALUE, ELEMENT> = UtilThemeInput<VALUE, ELEMENT>
OPTIONS extends UtilInputOptions<VALUE, ELEMENT> = UtilInputOptions<VALUE, ELEMENT>

Parameters

Name Type
target TARGET
operation OPERATION
theme THEME
options? OPTIONS

Returns

UtilInput<VALUE, ELEMENT, TARGET, OPERATION, THEME, OPTIONS>

Overrides

UtilHtmlElement.constructor

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:67

Properties

_after

Protected Optional _after: null | HTMLDivElement

Inherited from

UtilHtmlElement._after

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:189


_before

Protected Optional _before: null | HTMLDivElement

Inherited from

UtilHtmlElement._before

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:186


_clipper

Protected Optional _clipper: null | HTMLDivElement

Inherited from

UtilHtmlElement._clipper

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:175


_clipperEx

Protected Optional _clipperEx: null | UtilHtmlElementClipperEx

Inherited from

UtilHtmlElement._clipperEx

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:178


_clipperExRects

Protected Optional _clipperExRects: null | UtilHtmlElementClipperExRects

Inherited from

UtilHtmlElement._clipperExRects

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:179


_clipperRectResult

Protected Optional _clipperRectResult: Rectangle

Inherited from

UtilHtmlElement._clipperRectResult

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:176


_data

Protected _data: UtilHtmlElementData<ELEMENT>

Inherited from

UtilHtmlElement._data

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:171


_description

Protected _description: string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:60


_doSelectBound

Protected _doSelectBound: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

UtilHtmlElement._doSelectBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:194


_editingFormatter

Protected _editingFormatter: (value: VALUE, caller: any) => string

Type declaration

▸ (value, caller): string

Parameters
Name Type
value VALUE
caller any
Returns

string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:62


_editingUnformatter

Protected _editingUnformatter: (text: string, caller: any) => VALUE

Type declaration

▸ (text, caller): VALUE

Parameters
Name Type
text string
caller any
Returns

VALUE

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:63


_editingValidationResult

Protected Optional _editingValidationResult: null | string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:65


_editingValidator

Protected _editingValidator: (value: VALUE, caller: any) => null | string

Type declaration

▸ (value, caller): null | string

Parameters
Name Type
value VALUE
caller any
Returns

null | string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:64


_element

Protected Optional _element: null | ELEMENT

Inherited from

UtilHtmlElement._element

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:181


_elementRectResult

Protected Optional _elementRectResult: Rectangle

Inherited from

UtilHtmlElement._elementRectResult

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:182


_isElementShown

Protected _isElementShown: boolean

Inherited from

UtilHtmlElement._isElementShown

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:183


_isStartRequested

Protected _isStartRequested: boolean

Inherited from

UtilHtmlElement._isStartRequested

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:195


_isStarted

Protected _isStarted: boolean

Inherited from

UtilHtmlElement._isStarted

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:192


_onAfterFocusBound

Protected _onAfterFocusBound: (e: FocusEvent) => void

Type declaration

▸ (e): void

Parameters
Name Type
e FocusEvent
Returns

void

Inherited from

UtilHtmlElement._onAfterFocusBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:190


_onBeforeFocusBound

Protected _onBeforeFocusBound: (e: FocusEvent) => void

Type declaration

▸ (e): void

Parameters
Name Type
e FocusEvent
Returns

void

Inherited from

UtilHtmlElement._onBeforeFocusBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:187


_onElementFocusBound

Protected _onElementFocusBound: (e: FocusEvent) => void

Type declaration

▸ (e): void

Parameters
Name Type
e FocusEvent
Returns

void

Inherited from

UtilHtmlElement._onElementFocusBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:184


_onInputChangeBound

Protected _onInputChangeBound: (e: Event) => void

Type declaration

▸ (e): void

Parameters
Name Type
e Event
Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:57


_onInputInputBound

Protected _onInputInputBound: (e: Event) => void

Type declaration

▸ (e): void

Parameters
Name Type
e Event
Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:58


_onInputKeyDownBound

Protected _onInputKeyDownBound: (e: KeyboardEvent) => void

Type declaration

▸ (e): void

Parameters
Name Type
e KeyboardEvent
Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:56


_onPostRenderBound

Protected _onPostRenderBound: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

UtilHtmlElement._onPostRenderBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:198


_operation

Protected _operation: OPERATION

Inherited from

UtilHtmlElement._operation

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:170


_point

Protected Optional _point: Point

Inherited from

UtilHtmlElement._point

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:173


_rendererBound

Protected Optional _rendererBound: Renderer

Inherited from

UtilHtmlElement._rendererBound

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:197


_target

Protected _target: TARGET

Inherited from

UtilHtmlElement._target

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:169


_wasStarted

Protected _wasStarted: boolean

Inherited from

UtilHtmlElement._wasStarted

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:193

Accessors

element

get element(): null | ELEMENT

Returns

null | ELEMENT

Inherited from

UtilHtmlElement.element

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:332


when

get when(): UtilHtmlElementWhen

Returns

UtilHtmlElementWhen

Inherited from

UtilHtmlElement.when

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:336

Methods

applyTitle

applyTitle(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:181


cancel

cancel(): void

Returns

void

Inherited from

UtilHtmlElement.cancel

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:585


doSelect

doSelect(): void

Returns

void

Inherited from

UtilHtmlElement.doSelect

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:573


doStart

doStart(renderer?): void

Parameters

Name Type
renderer? Renderer

Returns

void

Inherited from

UtilHtmlElement.doStart

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:471


end

end(): void

Returns

void

Inherited from

UtilHtmlElement.end

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:767


fillClipperExRects

fillClipperExRects(resolution, result): boolean

Parameters

Name Type
resolution number
result UtilHtmlElementClipperExRects

Returns

boolean

Inherited from

UtilHtmlElement.fillClipperExRects

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:460


fromValue

fromValue(value): string

Parameters

Name Type
value undefined | VALUE

Returns

string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:150


getAfter

getAfter(clipper): null | HTMLDivElement

Parameters

Name Type
clipper HTMLDivElement

Returns

null | HTMLDivElement

Inherited from

UtilHtmlElement.getAfter

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:715


getBefore

getBefore(clipper): null | HTMLDivElement

Parameters

Name Type
clipper HTMLDivElement

Returns

null | HTMLDivElement

Inherited from

UtilHtmlElement.getBefore

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:706


getClipper

getClipper(): null | HTMLDivElement

Returns

null | HTMLDivElement

Inherited from

UtilHtmlElement.getClipper

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:660


getClipperEx

getClipperEx(clipper): null | UtilHtmlElementClipperEx

Parameters

Name Type
clipper HTMLDivElement

Returns

null | UtilHtmlElementClipperEx

Inherited from

UtilHtmlElement.getClipperEx

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:670


getClipperExRects

getClipperExRects(): null | UtilHtmlElementClipperExRects

Returns

null | UtilHtmlElementClipperExRects

Inherited from

UtilHtmlElement.getClipperExRects

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:684


getClipperRect

getClipperRect(resolution): null | Rectangle

Parameters

Name Type
resolution number

Returns

null | Rectangle

Inherited from

UtilHtmlElement.getClipperRect

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:452


getElement

getElement(clipper): null | ELEMENT

Parameters

Name Type
clipper HTMLDivElement

Returns

null | ELEMENT

Inherited from

UtilHtmlElement.getElement

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:697


getElementMatrix

getElementMatrix(): null | Matrix

Returns

null | Matrix

Inherited from

UtilHtmlElement.getElementMatrix

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:448


getElementRect

getElementRect(resolution): null | Rectangle

Parameters

Name Type
resolution number

Returns

null | Rectangle

Inherited from

UtilHtmlElement.getElementRect

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:440


isShown

isShown(): boolean

Returns

boolean

Inherited from

UtilHtmlElement.isShown

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:423


isStartable

isStartable(): boolean

Returns

boolean

Inherited from

UtilHtmlElement.isStartable

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:400


newAfterStyler

newAfterStyler(theme): (target: HTMLDivElement) => void

Parameters

Name Type
theme THEME

Returns

fn

▸ (target): void

Parameters
Name Type
target HTMLDivElement
Returns

void

Inherited from

UtilHtmlElement.newAfterStyler

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:326


newBeforeStyler

newBeforeStyler(theme): (target: HTMLDivElement) => void

Parameters

Name Type
theme THEME

Returns

fn

▸ (target): void

Parameters
Name Type
target HTMLDivElement
Returns

void

Inherited from

UtilHtmlElement.newBeforeStyler

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:313


newClipperStyler

newClipperStyler(theme): (target: HTMLDivElement, state: DBaseStateSet, padding: null | UtilHtmlElementPadding, elementRect: null | Rectangle, elementMatrix: null | Matrix, clipperRect: null | Rectangle, clipperEx: undefined | null | UtilHtmlElementClipperEx) => void

Parameters

Name Type
theme THEME

Returns

fn

▸ (target, state, padding, elementRect, elementMatrix, clipperRect, clipperEx): void

Parameters
Name Type
target HTMLDivElement
state DBaseStateSet
padding null | UtilHtmlElementPadding
elementRect null | Rectangle
elementMatrix null | Matrix
clipperRect null | Rectangle
clipperEx undefined | null | UtilHtmlElementClipperEx
Returns

void

Inherited from

UtilHtmlElement.newClipperStyler

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:284


newElementStyler

newElementStyler(theme): (target: ELEMENT, state: DBaseStateSet, padding: null | UtilHtmlElementPadding, elementRect: null | Rectangle, elementMatrix: null | Matrix, clipperRect: null | Rectangle, clipperEx: undefined | null | UtilHtmlElementClipperEx) => void

Parameters

Name Type
theme THEME

Returns

fn

▸ (target, state, padding, elementRect, elementMatrix, clipperRect, clipperEx): void

Parameters
Name Type
target ELEMENT
state DBaseStateSet
padding null | UtilHtmlElementPadding
elementRect null | Rectangle
elementMatrix null | Matrix
clipperRect null | Rectangle
clipperEx undefined | null | UtilHtmlElementClipperEx
Returns

void

Inherited from

UtilHtmlElement.newElementStyler

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:251


onAfterFocus

onAfterFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Inherited from

UtilHtmlElement.onAfterFocus

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:737


onBeforeFocus

onBeforeFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Inherited from

UtilHtmlElement.onBeforeFocus

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:724


onBlur

onBlur(): void

Returns

void

Inherited from

UtilHtmlElement.onBlur

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:386


onCancel

onCancel(): void

Returns

void

Inherited from

UtilHtmlElement.onCancel

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:636


onDblClick

onDblClick(e, interactionManager): void

Parameters

Name Type
e MouseEvent | KeyboardEvent | TouchEvent
interactionManager InteractionManager

Returns

void

Inherited from

UtilHtmlElement.onDblClick

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:364


onDown

onDown(e): void

Parameters

Name Type
e KeyboardEvent | InteractionEvent

Returns

void

Inherited from

UtilHtmlElement.onDown

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:354


onDowning

onDowning(e): void

Parameters

Name Type
e KeyboardEvent | InteractionEvent

Returns

void

Inherited from

UtilHtmlElement.onDowning

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:340


onElementAttached

onElementAttached(element, before?, after?): void

Parameters

Name Type
element ELEMENT
before? null | HTMLDivElement
after? null | HTMLDivElement

Returns

void

Overrides

UtilHtmlElement.onElementAttached

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:96


onElementDetached

onElementDetached(element, before?, after?): void

Parameters

Name Type
element ELEMENT
before? null | HTMLDivElement
after? null | HTMLDivElement

Returns

void

Overrides

UtilHtmlElement.onElementDetached

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:107


onElementFocus

onElementFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Inherited from

UtilHtmlElement.onElementFocus

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:750


onEnd

onEnd(): void

Returns

void

Overrides

UtilHtmlElement.onEnd

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:91


onEndByBlur

onEndByBlur(): void

Returns

void

Inherited from

UtilHtmlElement.onEndByBlur

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:759


onFocus

onFocus(): void

Returns

void

Inherited from

UtilHtmlElement.onFocus

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:375


onInputChange

onInputChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:132


onInputInput

onInputInput(e): void

Parameters

Name Type
e Event

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:157


onInputKeyDown

onInputKeyDown(e): void

Parameters

Name Type
e KeyboardEvent

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:117


onRender

onRender(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Inherited from

UtilHtmlElement.onRender

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:427


onStart

onStart(): void

Returns

void

Inherited from

UtilHtmlElement.onStart

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:569


select

select(): this

Returns

this

Inherited from

UtilHtmlElement.select

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:772


start

start(): void

Returns

void

Inherited from

UtilHtmlElement.start

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:411


toAfterData

toAfterData(theme, options?): UtilHtmlElementAfterData

Parameters

Name Type
theme THEME
options? OPTIONS["after"]

Returns

UtilHtmlElementAfterData

Inherited from

UtilHtmlElement.toAfterData

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:319


toBeforeData

toBeforeData(theme, options?): UtilHtmlElementBeforeData

Parameters

Name Type
theme THEME
options? OPTIONS["before"]

Returns

UtilHtmlElementBeforeData

Inherited from

UtilHtmlElement.toBeforeData

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:306


toClipperData

toClipperData(theme, options?): UtilHtmlElementClipperData

Parameters

Name Type
theme THEME
options? OPTIONS["clipper"]

Returns

UtilHtmlElementClipperData

Inherited from

UtilHtmlElement.toClipperData

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:273


toClipperRectAdjusted

toClipperRectAdjusted(elementRect, elementMatrix, clipperRect): null | Rectangle

Parameters

Name Type
elementRect null | Rectangle
elementMatrix null | Matrix
clipperRect null | Rectangle

Returns

null | Rectangle

Inherited from

UtilHtmlElement.toClipperRectAdjusted

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:779


toData

toData(theme, options?): UtilHtmlElementData<ELEMENT>

Parameters

Name Type
theme THEME
options? OPTIONS

Returns

UtilHtmlElementData<ELEMENT>

Inherited from

UtilHtmlElement.toData

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:230


toElementData

toElementData(theme, options?): UtilHtmlElementElementData<ELEMENT>

Parameters

Name Type
theme THEME
options? OPTIONS["element"]

Returns

UtilHtmlElementElementData<ELEMENT>

Inherited from

UtilHtmlElement.toElementData

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:241


toElementFocused

toElementFocused(element): void

Parameters

Name Type
element ELEMENT

Returns

void

Overrides

UtilHtmlElement.toElementFocused

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:126


toValue

toValue(valueAsString): VALUE

Parameters

Name Type
valueAsString string

Returns

VALUE

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:146


updateElement

updateElement(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Inherited from

UtilHtmlElement.updateElement

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:805


validate

validate(): null | string

Returns

null | string

Defined in

src/main/typescript/wcardinal/ui/util/util-input.ts:164


getClipperRect

getClipperRect(parent, target, resolution, point, result): null | Rectangle

Parameters

Name Type
parent unknown
target unknown
resolution number
point Point
result Rectangle

Returns

null | Rectangle

Inherited from

UtilHtmlElement.getClipperRect

Defined in

src/main/typescript/wcardinal/ui/util/util-html-element.ts:868