aem-forms-af-runtime

Class: Checkbox

Implementation of check box runtime model which extends from field model

Hierarchy

• Field

  ↳ Checkbox

Table of contents

Accessors

• :type
• checked
• constraintMessage
• dataRef
• default
• description
• displayFormat
• displayValue
• displayValueExpression
• editFormat
• editValue
• emptyValue
• enabled
• enforceEnum
• enum
• enumNames
• errorMessage
• exclusiveMaximum
• exclusiveMinimum
• fieldType
• form
• format
• fragment
• id
• index
• isContainer
• label
• lang
• maxLength
• maximum
• minLength
• minimum
• name
• parent
• pattern
• placeholder
• properties
• qualifiedName
• readOnly
• repeatable
• required
• ruleEngine
• screenReaderText
• step
• tooltip
• type
• uniqueItems
• valid
• validity
• value
• visible

Properties

• _eventSource

Methods

• change
• dispatch
• executeAction
• executeExpression
• focus
• getDependents
• getErrorMessage
• getNonTransparentParent
• getPropertiesManager
• getRules
• getState
• isTransparent
• markAsInvalid
• ruleNodeReference
• syncDataAndFormModel
• toString
• triggerValidationEvent
• validate
• valueOf

Accessors

:type

• get :type(): string

Returns

string

Inherited from

Field.:type

---

checked

• get checked(): boolean

Returns

boolean

• set checked(check): void

Parameters

Name	Type
check	boolean

Returns

void

---

constraintMessage

• set constraintMessage(constraint): void

Sets constraint message(s) for validation types. This setter automatically triggers change events, enabling UI components to react to constraint message updates.

example

// Set single constraint message
field.constraintMessage = { type: 'required', message: 'This field is mandatory' };

// Set multiple constraint messages in single call (new functionality)
field.constraintMessage = [
  { type: 'minimum', message: 'Date must be after 2025-08-11' },
  { type: 'maximum', message: 'Date must be before 2025-08-14' }
];

// Set pattern validation message
field.constraintMessage = { type: 'pattern', message: 'Please match the required format' };

see ConstraintsMessages for available constraint types

Parameters

Name	Type	Description
constraint	{ message: string ; type: keyof ConstraintsMessages } | { message: string ; type: keyof ConstraintsMessages }[]	Single constraint object or array of constraint objects

Returns

void

Inherited from

Field.constraintMessage

---

dataRef

• get dataRef(): undefined | null | string

Returns

undefined | null | string

Inherited from

Field.dataRef

---

default

• get default(): any

Returns

any

Inherited from

Field.default

---

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

Field.description

• set description(d): void

Parameters

Name	Type
d	undefined | string

Returns

void

Inherited from

Field.description

---

displayFormat

• get displayFormat(): undefined | string

Returns

undefined | string

Inherited from

Field.displayFormat

---

displayValue

• get displayValue(): any

Returns

any

Inherited from

Field.displayValue

---

displayValueExpression

• get displayValueExpression(): undefined | string

Returns

undefined | string

Inherited from

Field.displayValueExpression

---

editFormat

• get editFormat(): undefined | string

Returns

undefined | string

Inherited from

Field.editFormat

---

editValue

• get editValue(): any

Returns

any

Inherited from

Field.editValue

---

emptyValue

• get emptyValue(): undefined | null | ""

Returns

undefined | null | ""

Inherited from

Field.emptyValue

---

enabled

• get enabled(): undefined | boolean

Returns

undefined | boolean

Inherited from

Field.enabled

• set enabled(e): void

Parameters

Name	Type
e	undefined | boolean

Returns

void

Inherited from

Field.enabled

---

enforceEnum

• get enforceEnum(): undefined | boolean

Returns

undefined | boolean

Inherited from

Field.enforceEnum

---

enum

• get enum(): any[]

Returns the enum constraints from the json

Returns

any[]

Overrides

Field.enum

---

enumNames

• get enumNames(): undefined | string[]

Returns

undefined | string[]

Inherited from

Field.enumNames

• set enumNames(e): void

Parameters

Name	Type
e	undefined | string[]

Returns

void

Inherited from

Field.enumNames

---

errorMessage

• get errorMessage(): undefined | string

Returns

undefined | string

Inherited from

Field.errorMessage

• set errorMessage(e): void

Parameters

Name	Type
e	undefined | string

Returns

void

Inherited from

Field.errorMessage

---

exclusiveMaximum

• get exclusiveMaximum(): undefined | string | number

Returns

undefined | string | number

Inherited from

Field.exclusiveMaximum

• set exclusiveMaximum(eM): void

Parameters

Name	Type
eM	undefined | string | number

Returns

void

Inherited from

Field.exclusiveMaximum

---

exclusiveMinimum

• get exclusiveMinimum(): undefined | string | number

Returns

undefined | string | number

Inherited from

Field.exclusiveMinimum

• set exclusiveMinimum(eM): void

Parameters

Name	Type
eM	undefined | string | number

Returns

void

Inherited from

Field.exclusiveMinimum

---

fieldType

• get fieldType(): string

Returns

string

Inherited from

Field.fieldType

---

form

• get form(): FormModel

Returns

FormModel

Inherited from

Field.form

---

format

• get format(): undefined | string

returns the format constraint

Returns

undefined | string

Inherited from

Field.format

---

fragment

• get fragment(): string

Returns

string

Inherited from

Field.fragment

---

id

• get id(): string

Returns

string

Inherited from

Field.id

---

index

• get index(): number

Returns

number

Inherited from

Field.index

---

isContainer

• get isContainer(): boolean

Returns

boolean

Inherited from

Field.isContainer

---

label

• get label(): undefined | Label

Returns

undefined | Label

Inherited from

Field.label

• set label(l): void

Parameters

Name	Type
l	undefined | Label

Returns

void

Inherited from

Field.label

---

lang

• get lang(): undefined | string

Returns

undefined | string

Inherited from

Field.lang

---

maxLength

• get maxLength(): undefined | number

Returns

undefined | number

Inherited from

Field.maxLength

---

maximum

• get maximum(): undefined | string | number

Returns

undefined | string | number

Inherited from

Field.maximum

• set maximum(m): void

Parameters

Name	Type
m	undefined | string | number

Returns

void

Inherited from

Field.maximum

---

minLength

• get minLength(): undefined | number

Returns

undefined | number

Inherited from

Field.minLength

---

minimum

• get minimum(): undefined | string | number

Returns

undefined | string | number

Inherited from

Field.minimum

• set minimum(m): void

Parameters

Name	Type
m	undefined | string | number

Returns

void

Inherited from

Field.minimum

---

name

• get name(): undefined | string

Returns

undefined | string

Inherited from

Field.name

---

parent

• get parent(): ContainerModel

Returns

ContainerModel

Inherited from

Field.parent

---

pattern

• get pattern(): undefined | string

Returns

undefined | string

Inherited from

Field.pattern

---

placeholder

• get placeholder(): undefined | string

Returns

undefined | string

Inherited from

Field.placeholder

---

properties

• get properties(): Object

Returns

Object

Inherited from

Field.properties

• set properties(p): void

Parameters

Name	Type
p	Object

Returns

void

Inherited from

Field.properties

---

qualifiedName

• get qualifiedName(): any

Returns

any

Inherited from

Field.qualifiedName

---

readOnly

• get readOnly(): undefined | boolean

Returns

undefined | boolean

Inherited from

Field.readOnly

• set readOnly(e): void

Parameters

Name	Type
e	undefined | boolean

Returns

void

Inherited from

Field.readOnly

---

repeatable

• get repeatable(): any

Returns

any

Inherited from

Field.repeatable

---

required

• get required(): boolean

Returns

boolean

Inherited from

Field.required

• set required(r): void

Parameters

Name	Type
r	boolean

Returns

void

Inherited from

Field.required

---

ruleEngine

• get ruleEngine(): RuleEngine

Returns

RuleEngine

Inherited from

Field.ruleEngine

---

screenReaderText

• get screenReaderText(): undefined | string

Returns

undefined | string

Inherited from

Field.screenReaderText

---

step

• get step(): undefined | number

Returns

undefined | number

Inherited from

Field.step

---

tooltip

• get tooltip(): undefined | string

Returns

undefined | string

Inherited from

Field.tooltip

---

type

• get type(): undefined | string

Returns

undefined | string

Inherited from

Field.type

---

uniqueItems

• get uniqueItems(): undefined | boolean

Returns

undefined | boolean

Inherited from

Field.uniqueItems

---

valid

• get valid(): any

Returns

any

Inherited from

Field.valid

• set valid(e): void

Parameters

Name	Type
e	any

Returns

void

Inherited from

Field.valid

---

validity

• get validity(): any

Returns

any

Inherited from

Field.validity

---

value

• get value(): any

Returns

any

Inherited from

Field.value

• set value(v): void

Parameters

Name	Type
v	any

Returns

void

Inherited from

Field.value

---

visible

• get visible(): undefined | boolean

Returns

undefined | boolean

Inherited from

Field.visible

• set visible(v): void

Parameters

Name	Type
v	undefined | boolean

Returns

void

Inherited from

Field.visible

Properties

_eventSource

• _eventSource: EventSource = EventSource.CODE

Inherited from

Field._eventSource

Methods

change

▸ change(event, context): void

Parameters

Name	Type
event	Action
context	any

Returns

void

Inherited from

Field.change

---

dispatch

▸ dispatch(action): void

Parameters

Name	Type
action	Action

Returns

void

Inherited from

Field.dispatch

---

executeAction

▸ executeAction(action): void

Executes the given action

Parameters

Name	Type	Description
action	Action	event object

Returns

void

Inherited from

Field.executeAction

---

executeExpression

▸ executeExpression(expr): any

Parameters

Name	Type
expr	string

Returns

any

Inherited from

Field.executeExpression

---

focus

▸ focus(): void

Returns

void

Inherited from

Field.focus

---

getDependents

▸ getDependents(): { id: string = x.node.id; propertyName: undefined | string = x.propertyName }[]

Returns

{ id: string = x.node.id; propertyName: undefined | string = x.propertyName }[]

Inherited from

Field.getDependents

---

getErrorMessage

▸ getErrorMessage(constraint): string

Returns the error message for a given constraint

Parameters

Name	Type
constraint	keyof ConstraintsMessages

Returns

string

Inherited from

Field.getErrorMessage

---

getNonTransparentParent

▸ getNonTransparentParent(): ContainerModel

Returns

ContainerModel

Inherited from

Field.getNonTransparentParent

---

getPropertiesManager

▸ getPropertiesManager(): PropertiesManager

Get the PropertiesManager instance for use in setVariable

Returns

PropertiesManager

Inherited from

Field.getPropertiesManager

---

getRules

▸ getRules(): Items<string>

Returns

Items<string>

Inherited from

Field.getRules

---

getState

▸ getState(isRepeatableChild?, forRestore?): Object

state of the form object

Parameters

Name	Type	Default value
isRepeatableChild	boolean	false
forRestore	boolean	false

Returns

Object

Name	Type
:type	string
_dependents	undefined | { id: string = x.node.id; propertyName: undefined | string = x.propertyName }[]
accept?	string[]
allowedComponents	undefined
altText?	string
appliedCssClassNames?	string
buttonType?	string
checked	boolean
columnClassNames	undefined
columnCount	undefined
constraintMessages?	ConstraintsMessages
dataRef?	null | string
default?	any
description?	string
displayFormat	undefined | string
displayValue	any
displayValueExpression?	string
editFormat	undefined | string
editValue	any
emptyValue?	"" | "undefined" | "null"
enabled	undefined | boolean
enforceEnum?	boolean
enum?	any[]
enumNames?	string[]
errorMessage?	string
events?	Items<undefined | string | string[]>
exclusiveMaximum?	string | number
exclusiveMinimum?	string | number
fieldType?	string
format?	string
gridClassNames	undefined
id	string
index	number
label?	Label
lang?	string
maxFileSize?	string | number
maxItems?	number
maxLength?	number
maxOccur?	number
maximum?	string | number
minItems?	number
minLength?	number
minOccur?	number
minimum?	string | number
name?	string
parent	undefined
pattern?	string
placeholder?	string
properties	{ [key: string]: any; } & { [key: string]: any; }
qualifiedName	any
readOnly	undefined | boolean
repeatable?	boolean
required?	boolean
rules?	Items<string>
screenReaderText?	string
step?	number
tooltip?	string
type?	string
uniqueItems?	boolean
valid?	boolean
validationExpression?	string
validationMessage?	string
validity?	any
value?	any
viewType?	string
visible?	boolean

Overrides

Field.getState

---

isTransparent

▸ isTransparent(): boolean

Transparent form fields are meant only for creation of view. They are also not part of data

Returns

boolean

Inherited from

Field.isTransparent

---

markAsInvalid

▸ markAsInvalid(message, constraint?): void

API to mark a particular field as invalid

Parameters

Name	Type	Default value	Description
message	string	undefined	error message
constraint	null | keyof ConstraintsMessages	null	constraint type due to which field is marked invalid. It should be key of ConstraintsMessages or null

Returns

void

Inherited from

Field.markAsInvalid

---

ruleNodeReference

▸ ruleNodeReference(): any

Returns

any

Inherited from

Field.ruleNodeReference

---

syncDataAndFormModel

▸ syncDataAndFormModel(dataNode): void

Parameters

Name	Type
dataNode	default

Returns

void

Inherited from

Field.syncDataAndFormModel

---

toString

▸ toString(): any

Returns

any

Inherited from

Field.toString

---

triggerValidationEvent

▸ triggerValidationEvent(changes): void

Parameters

Name	Type
changes	any

Returns

void

Inherited from

Field.triggerValidationEvent

---

validate

▸ validate(): ValidationError[]

Validates the current form object

Returns

ValidationError[]

Inherited from

Field.validate

---

valueOf

▸ valueOf(): any

Returns

any

Inherited from

Field.valueOf

This site is open source. Improve this page.