Class FtBooleanFieldDefinition

Field definition for boolean fields.

Hierarchy (View Summary)

FtGenericFieldDefinition<boolean>
- FtBooleanFieldDefinition

Constructors

constructor

new FtBooleanFieldDefinition(index: number): FtBooleanFieldDefinition
Parameters
- index: number
Returns FtBooleanFieldDefinition
Overrides FtGenericFieldDefinition.constructor
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:17

Properties

`Readonly`autoLeftPad

autoLeftPad: boolean

`Readonly`dataType

dataType: FtDataType

`Protected`formatter

formatter: FtBooleanFieldFormatter

`Readonly`valueType

valueType: string

`Static` `Readonly`AUTO_LEFT_PAD

AUTO_LEFT_PAD: false

Accessors

autoPadChar

get autoPadChar(): string
Returns string
Inherited from FtGenericFieldDefinition.autoPadChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:178

constant

get constant(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.constant
- Defined in lib/src/fields/definitions/ft-field-definition.ts:109

culture

get culture(): DotNetLocaleSettings | undefined
Returns DotNetLocaleSettings | undefined
Inherited from FtGenericFieldDefinition.culture
- Defined in lib/src/fields/definitions/ft-field-definition.ts:100

falseText

get falseText(): string
Returns string
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:22

fixedWidth

get fixedWidth(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.fixedWidth
- Defined in lib/src/fields/definitions/ft-field-definition.ts:103

fixedWidthNullValueText

get fixedWidthNullValueText(): string
Returns string
Inherited from FtGenericFieldDefinition.fixedWidthNullValueText
- Defined in lib/src/fields/definitions/ft-field-definition.ts:187

headingAlwaysWriteOptionalQuote

get headingAlwaysWriteOptionalQuote(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.headingAlwaysWriteOptionalQuote
- Defined in lib/src/fields/definitions/ft-field-definition.ts:153

headingConstraint

get headingConstraint(): FtHeadingConstraint
Returns FtHeadingConstraint
Inherited from FtGenericFieldDefinition.headingConstraint
- Defined in lib/src/fields/definitions/ft-field-definition.ts:147

headingEndOfValueChar

get headingEndOfValueChar(): string
Returns string
Inherited from FtGenericFieldDefinition.headingEndOfValueChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:174

headingLeftPad

get headingLeftPad(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.headingLeftPad
- Defined in lib/src/fields/definitions/ft-field-definition.ts:181

headingPadAlignment

get headingPadAlignment(): FtPadAlignment
Returns FtPadAlignment
Inherited from FtGenericFieldDefinition.headingPadAlignment
- Defined in lib/src/fields/definitions/ft-field-definition.ts:159

headingPadChar

get headingPadChar(): string
Returns string
Inherited from FtGenericFieldDefinition.headingPadChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:165

headingPadCharType

get headingPadCharType(): FtPadCharType
Returns FtPadCharType
Inherited from FtGenericFieldDefinition.headingPadCharType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:162

headingQuotedType

get headingQuotedType(): FtQuotedType
Returns FtQuotedType
Inherited from FtGenericFieldDefinition.headingQuotedType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:150

headingTruncateChar

get headingTruncateChar(): string
Returns string
Inherited from FtGenericFieldDefinition.headingTruncateChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:171

headingTruncateType

get headingTruncateType(): FtTruncateType
Returns FtTruncateType
Inherited from FtGenericFieldDefinition.headingTruncateType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:168

headingWritePrefixSpace

get headingWritePrefixSpace(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.headingWritePrefixSpace
- Defined in lib/src/fields/definitions/ft-field-definition.ts:156

id

get id(): number | undefined
Returns number | undefined
Inherited from FtGenericFieldDefinition.id
- Defined in lib/src/fields/definitions/ft-field-definition.ts:85

index

get index(): number
Returns number
Inherited from FtGenericFieldDefinition.index
- Defined in lib/src/fields/definitions/ft-field-definition.ts:82

mainHeadingIndex

get mainHeadingIndex(): number
Returns number
Inherited from FtGenericFieldDefinition.mainHeadingIndex
- Defined in lib/src/fields/definitions/ft-field-definition.ts:97

metaHeadingCount

get metaHeadingCount(): number
Returns number
Inherited from FtGenericFieldDefinition.metaHeadingCount
- Defined in lib/src/fields/definitions/ft-field-definition.ts:94

metaHeadings

get metaHeadings(): string[]
Returns string[]
Inherited from FtGenericFieldDefinition.metaHeadings
- Defined in lib/src/fields/definitions/ft-field-definition.ts:91

metaName

get metaName(): string
Returns string
Inherited from FtGenericFieldDefinition.metaName
- Defined in lib/src/fields/definitions/ft-field-definition.ts:88

null

get null(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.null
- Defined in lib/src/fields/definitions/ft-field-definition.ts:112

styles

get styles(): number
Returns number
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:30

trueText

get trueText(): string
Returns string
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:26

value

get value(): T
Returns T
Inherited from FtGenericFieldDefinition.value
- Defined in lib/src/fields/definitions/ft-generic-field-definition.ts:13

valueAlwaysWriteOptionalQuote

get valueAlwaysWriteOptionalQuote(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.valueAlwaysWriteOptionalQuote
- Defined in lib/src/fields/definitions/ft-field-definition.ts:119

valueEndOfValueChar

get valueEndOfValueChar(): string
Returns string
Inherited from FtGenericFieldDefinition.valueEndOfValueChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:140

valueLeftPad

get valueLeftPad(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.valueLeftPad
- Defined in lib/src/fields/definitions/ft-field-definition.ts:184

valueNullChar

get valueNullChar(): string
Returns string
Inherited from FtGenericFieldDefinition.valueNullChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:143

valuePadAlignment

get valuePadAlignment(): FtPadAlignment
Returns FtPadAlignment
Inherited from FtGenericFieldDefinition.valuePadAlignment
- Defined in lib/src/fields/definitions/ft-field-definition.ts:125

valuePadChar

get valuePadChar(): string
Returns string
Inherited from FtGenericFieldDefinition.valuePadChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:131

valuePadCharType

get valuePadCharType(): FtPadCharType
Returns FtPadCharType
Inherited from FtGenericFieldDefinition.valuePadCharType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:128

valueQuotedType

get valueQuotedType(): FtQuotedType
Returns FtQuotedType
Inherited from FtGenericFieldDefinition.valueQuotedType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:116

valueTruncateChar

get valueTruncateChar(): string
Returns string
Inherited from FtGenericFieldDefinition.valueTruncateChar
- Defined in lib/src/fields/definitions/ft-field-definition.ts:137

valueTruncateType

get valueTruncateType(): FtTruncateType
Returns FtTruncateType
Inherited from FtGenericFieldDefinition.valueTruncateType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:134

valueWritePrefixSpace

get valueWritePrefixSpace(): boolean
Returns boolean
Inherited from FtGenericFieldDefinition.valueWritePrefixSpace
- Defined in lib/src/fields/definitions/ft-field-definition.ts:122

width

get width(): number
Returns number
Inherited from FtGenericFieldDefinition.width
- Defined in lib/src/fields/definitions/ft-field-definition.ts:106

Methods

getValueText

getValueText(value: boolean): string
Convert a typed value to its text representation.
Parameters
- value: boolean
  The value to convert
Returns string
The text representation
Overrides FtGenericFieldDefinition.getValueText
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:42

loadMeta

loadMeta(
    metaField: FtBooleanMetaField,
    myCulture: DotNetLocaleSettings | undefined,
    myMainHeadingIndex: number,
): void
Load metadata from a meta field.
Parameters
- metaField: FtBooleanMetaField
  The meta field containing configuration
- myCulture: DotNetLocaleSettings | undefined
  The culture settings for formatting
- myMainHeadingIndex: number
  Index of the main heading
Returns void
Overrides FtGenericFieldDefinition.loadMeta
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:34

parseValueText

parseValueText(text: string): boolean
Parse text into a typed value.
Parameters
- text: string
  The text to parse
Returns boolean
The parsed value
Overrides FtGenericFieldDefinition.parseValueText
- Defined in lib/src/fields/definitions/ft-boolean-field-definition.ts:46

Class FtBooleanFieldDefinition

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FtBooleanFieldDefinition

Properties

ReadonlyautoLeftPad

ReadonlydataType

Protectedformatter

ReadonlyvalueType

Static ReadonlyAUTO_LEFT_PAD

Accessors

autoPadChar

Returns string

constant

Returns boolean

culture

Returns DotNetLocaleSettings | undefined

falseText

Returns string

fixedWidth

Returns boolean

fixedWidthNullValueText

Returns string

headingAlwaysWriteOptionalQuote

Returns boolean

headingConstraint

Returns FtHeadingConstraint

headingEndOfValueChar

Returns string

headingLeftPad

Returns boolean

headingPadAlignment

Returns FtPadAlignment

headingPadChar

Returns string

headingPadCharType

Returns FtPadCharType

headingQuotedType

Returns FtQuotedType

headingTruncateChar

Returns string

headingTruncateType

Returns FtTruncateType

headingWritePrefixSpace

Returns boolean

id

Returns number | undefined

index

Returns number

mainHeadingIndex

Returns number

metaHeadingCount

Returns number

metaHeadings

Returns string[]

metaName

Returns string

null

Returns boolean

styles

Returns number

trueText

Returns string

value

Returns T

valueAlwaysWriteOptionalQuote

Returns boolean

valueEndOfValueChar

Returns string

valueLeftPad

Returns boolean

valueNullChar

Returns string

`Readonly`autoLeftPad

`Readonly`dataType

`Protected`formatter

`Readonly`valueType

`Static` `Readonly`AUTO_LEFT_PAD