Class PatternInputDefinition<Opts>

Subset of Masked attributes used with pattern

Type Parameters

Opts extends FactoryOpts = any

Implements

PatternBlock<PatternInputDefinitionState<Opts>>

Constructors

constructor

new PatternInputDefinition<Opts>(opts): PatternInputDefinition<Opts>
Type Parameters
- Opts extends FactoryOpts = any
Parameters
- opts: PatternInputDefinitionOptions<Opts>
Returns PatternInputDefinition<Opts>
- Defined in masked/pattern/input-definition.ts:62

Properties

displayChar

displayChar: string

eager

eager: undefined | boolean | "remove" | "append"

isFilled

isFilled: boolean

isOptional

isOptional: boolean

lazy

lazy: boolean

`Readonly` masked

masked: FactoryReturnMasked<Opts>

parent

parent: Masked<any>

placeholderChar

placeholderChar: string

`Static` DEFAULT_DEFINITIONS

DEFAULT_DEFINITIONS: {
[k: string]: RegExp;
} = ...

Type declaration

[k: string]: RegExp

Accessors

displayValue

get displayValue(): string
Returns string
Implementation of PatternBlock.displayValue
- Defined in masked/pattern/input-definition.ts:98

isComplete

get isComplete(): boolean
Returns boolean
Implementation of PatternBlock.isComplete
- Defined in masked/pattern/input-definition.ts:102

rawInputValue

get rawInputValue(): string
Returns string
- Defined in masked/pattern/input-definition.ts:94

state

get state(): PatternInputDefinitionState<Opts>
Returns PatternInputDefinitionState<Opts>
Implementation of PatternBlock.state
- Defined in masked/pattern/input-definition.ts:185
set state(state): void
Parameters
- state: PatternInputDefinitionState<Opts>
Returns void
Implementation of PatternBlock.state
- Defined in masked/pattern/input-definition.ts:194

unmaskedValue

get unmaskedValue(): string
Returns string
Implementation of PatternBlock.unmaskedValue
- Defined in masked/pattern/input-definition.ts:90

value

get value(): string
Returns string
Implementation of PatternBlock.value
- Defined in masked/pattern/input-definition.ts:83

Methods

_appendChar

_appendChar(ch, flags?): ChangeDetails
Parameters
- ch: string
- flags: AppendFlags<PatternInputDefinitionState<Opts>> = {}
Returns ChangeDetails
Implementation of PatternBlock._appendChar
- Defined in masked/pattern/input-definition.ts:106

_appendEager

_appendEager(): ChangeDetails
Returns ChangeDetails
Implementation of PatternBlock._appendEager
- Defined in masked/pattern/input-definition.ts:139

_appendPlaceholder

_appendPlaceholder(): ChangeDetails
Returns ChangeDetails
Implementation of PatternBlock._appendPlaceholder
- Defined in masked/pattern/input-definition.ts:132

append

append(str, flags?, tail?): ChangeDetails
Parameters
- str: string
- Optional flags: AppendFlags<PatternInputDefinitionState<Opts>>
- Optional tail: TailDetails
Returns ChangeDetails
Implementation of PatternBlock.append
- Defined in masked/pattern/input-definition.ts:127

appendTail

appendTail(tail): ChangeDetails
Parameters
- tail: string | TailDetails
Returns ChangeDetails
Implementation of PatternBlock.appendTail
- Defined in masked/pattern/input-definition.ts:147

currentMaskFlags

currentMaskFlags(flags?): AppendFlags<MaskedState>
Parameters
- Optional flags: AppendFlags<PatternInputDefinitionState<Opts>>
Returns AppendFlags<MaskedState>
- Defined in masked/pattern/input-definition.ts:199

doCommit

doCommit(): void
Returns void
Implementation of PatternBlock.doCommit
- Defined in masked/pattern/input-definition.ts:181

doValidate

doValidate(flags): boolean
Parameters
- flags: AppendFlags<PatternInputDefinitionState<Opts>>
Returns boolean
- Defined in masked/pattern/input-definition.ts:176

extractInput

extractInput(fromPos?, toPos?, flags?): string
Parameters
- fromPos: number = 0
- toPos: number = ...
- Optional flags: ExtractFlags
Returns string
Implementation of PatternBlock.extractInput
- Defined in masked/pattern/input-definition.ts:151

extractTail

extractTail(fromPos?, toPos?): TailDetails
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns TailDetails
Implementation of PatternBlock.extractTail
- Defined in masked/pattern/input-definition.ts:143

nearestInputPos

nearestInputPos(cursorPos, direction?): number
Parameters
- cursorPos: number
- direction: Direction = DIRECTION.NONE
Returns number
Implementation of PatternBlock.nearestInputPos
- Defined in masked/pattern/input-definition.ts:155

pad

pad(flags?): ChangeDetails
Parameters
- Optional flags: AppendFlags<MaskedState>
Returns ChangeDetails
Implementation of PatternBlock.pad
- Defined in masked/pattern/input-definition.ts:206

remove

remove(fromPos?, toPos?): ChangeDetails
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns ChangeDetails
Implementation of PatternBlock.remove
- Defined in masked/pattern/input-definition.ts:74

reset

reset(): void
Returns void
Implementation of PatternBlock.reset
- Defined in masked/pattern/input-definition.ts:69

totalInputPositions

totalInputPositions(fromPos?, toPos?): number
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns number
Implementation of PatternBlock.totalInputPositions
- Defined in masked/pattern/input-definition.ts:172