Class PatternFixedDefinition

Subset of Masked attributes used with pattern

Implements

PatternBlock

Index

Constructors

Properties

_isRawInput? _value char eager isFixed isUnmasking?

Accessors

displayValue isComplete isFilled rawInputValue state unmaskedValue value

Methods

_appendChar _appendEager _appendPlaceholder append appendTail doCommit extractInput extractTail nearestInputPos pad remove reset totalInputPositions

Constructors

constructor

new PatternFixedDefinition(opts): PatternFixedDefinition
Parameters
- opts: PatternFixedDefinitionOptions
Returns PatternFixedDefinition
- Defined in masked/pattern/fixed-definition.ts:28

Properties

`Optional` _isRawInput

_isRawInput?: boolean

_value

_value: string

char

char: string

eager

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

isFixed

isFixed: boolean

`Optional` isUnmasking

isUnmasking?: boolean

Accessors

displayValue

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

isComplete

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

isFilled

get isFilled(): boolean
Returns boolean
Implementation of PatternBlock.isFilled
- Defined in masked/pattern/fixed-definition.ts:90

rawInputValue

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

state

get state(): MaskedState
Returns MaskedState
Implementation of PatternBlock.state
- Defined in masked/pattern/fixed-definition.ts:144
set state(state): void
Parameters
- state: MaskedState
Returns void
Implementation of PatternBlock.state
- Defined in masked/pattern/fixed-definition.ts:151

unmaskedValue

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

value

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

Methods

_appendChar

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

_appendEager

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

_appendPlaceholder

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

append

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

appendTail

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

doCommit

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

extractInput

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

extractTail

extractTail(): TailDetails
Returns TailDetails
Implementation of PatternBlock.extractTail
- Defined in masked/pattern/fixed-definition.ts:122

nearestInputPos

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

pad

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

remove

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

reset

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

totalInputPositions

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