Winter Cardinal UI - v0.442.0 / UtilHtmlElement

Class: UtilHtmlElement<ELEMENT, TARGET, OPERATION, THEME, OPTIONS>

Type parameters

Name Type
ELEMENT extends HTMLElement = HTMLElement
TARGET extends UtilHtmlElementTarget = UtilHtmlElementTarget
OPERATION extends UtilHtmlElementOperation<ELEMENT> = UtilHtmlElementOperation<ELEMENT>
THEME extends UtilThemeHtmlElement<ELEMENT> = UtilThemeHtmlElement<ELEMENT>
OPTIONS extends UtilHtmlElementOptions<ELEMENT> = UtilHtmlElementOptions<ELEMENT>

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Type parameters

Name Type
ELEMENT extends HTMLElement = HTMLElement
TARGET extends UtilHtmlElementTarget = UtilHtmlElementTarget
OPERATION extends UtilHtmlElementOperation<ELEMENT> = UtilHtmlElementOperation<ELEMENT>
THEME extends UtilThemeHtmlElement<ELEMENT> = UtilThemeHtmlElement<ELEMENT>
OPTIONS extends UtilHtmlElementOptions<ELEMENT> = UtilHtmlElementOptions<ELEMENT>

Parameters

Name Type
target TARGET
operation OPERATION
theme THEME
options? OPTIONS

Returns

UtilHtmlElement<ELEMENT, TARGET, OPERATION, THEME, OPTIONS>

Defined in

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

Properties

_after

Protected Optional _after: null | HTMLDivElement

Defined in

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


_before

Protected Optional _before: null | HTMLDivElement

Defined in

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


_clipper

Protected Optional _clipper: null | HTMLDivElement

Defined in

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


_clipperEx

Protected Optional _clipperEx: null | UtilHtmlElementClipperEx

Defined in

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


_clipperExRects

Protected Optional _clipperExRects: null | UtilHtmlElementClipperExRects

Defined in

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


_clipperRectResult

Protected Optional _clipperRectResult: Rectangle

Defined in

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


_data

Protected _data: UtilHtmlElementData<ELEMENT>

Defined in

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


_doSelectBound

Protected _doSelectBound: () => void

Type declaration

▸ (): void

Returns

void

Defined in

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


_element

Protected Optional _element: null | ELEMENT

Defined in

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


_elementRectResult

Protected Optional _elementRectResult: Rectangle

Defined in

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


_isElementShown

Protected _isElementShown: boolean

Defined in

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


_isStartRequested

Protected _isStartRequested: boolean

Defined in

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


_isStarted

Protected _isStarted: boolean

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

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

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

Defined in

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


_onPostRenderBound

Protected _onPostRenderBound: () => void

Type declaration

▸ (): void

Returns

void

Defined in

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


_operation

Protected _operation: OPERATION

Defined in

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


_point

Protected Optional _point: Point

Defined in

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


_rendererBound

Protected Optional _rendererBound: Renderer

Defined in

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


_target

Protected _target: TARGET

Defined in

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


_wasStarted

Protected _wasStarted: boolean

Defined in

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

Accessors

element

get element(): null | ELEMENT

Returns

null | ELEMENT

Defined in

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


when

get when(): UtilHtmlElementWhen

Returns

UtilHtmlElementWhen

Defined in

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

Methods

cancel

cancel(): void

Returns

void

Defined in

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


doSelect

doSelect(): void

Returns

void

Defined in

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


doStart

doStart(renderer?): void

Parameters

Name Type
renderer? Renderer

Returns

void

Defined in

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


end

end(): void

Returns

void

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

Defined in

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


getAfter

getAfter(clipper): null | HTMLDivElement

Parameters

Name Type
clipper HTMLDivElement

Returns

null | HTMLDivElement

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

Defined in

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


getClipper

getClipper(): null | HTMLDivElement

Returns

null | HTMLDivElement

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

Defined in

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


getClipperExRects

getClipperExRects(): null | UtilHtmlElementClipperExRects

Returns

null | UtilHtmlElementClipperExRects

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

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

Defined in

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


getElementMatrix

getElementMatrix(): null | Matrix

Returns

null | Matrix

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

Defined in

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


isShown

isShown(): boolean

Returns

boolean

Defined in

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


isStartable

isStartable(): boolean

Returns

boolean

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

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

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

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

Defined in

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


onAfterFocus

onAfterFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Defined in

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


onBeforeFocus

onBeforeFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Defined in

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


onBlur

onBlur(): void

Returns

void

Defined in

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


onCancel

onCancel(): void

Returns

void

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

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

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

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

Defined in

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


onElementDetached

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

Parameters

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

Returns

void

Defined in

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


onElementFocus

onElementFocus(e): void

Parameters

Name Type
e FocusEvent

Returns

void

Defined in

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


onEnd

onEnd(): void

Returns

void

Defined in

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


onEndByBlur

onEndByBlur(): void

Returns

void

Defined in

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


onFocus

onFocus(): void

Returns

void

Defined in

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


onRender

onRender(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Defined in

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


onStart

onStart(): void

Returns

void

Defined in

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


select

select(): this

Returns

this

Defined in

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


start

start(): void

Returns

void

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

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

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

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

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>

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>

Defined in

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


toElementFocused

toElementFocused(element): void

Parameters

Name Type
element ELEMENT

Returns

void

Defined in

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


updateElement

updateElement(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Defined in

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


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

Defined in

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