Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.forms.items.GroupBoxFormItem} class.

    Parameters

    • xmlNode: Element

      Xml node containing the form item definition.

    • Optional formDefinition: FormDefinitionInterface

      The form definition that this form item belongs to.

    Returns GroupBoxFormItem

Properties

argumentName

argumentName: Observable<string>

The name of the argument that will be used to store the result of this item.

Private createElementDelegate

createElementDelegate: function

Type declaration

    • (xmlDoc: Element, formDefinition: any): FormItem
    • Parameters

      • xmlDoc: Element
      • formDefinition: any

      Returns FormItem

description

description: Observable<string>

The description of the group.

type

Observable(String)

formDefinition

formDefinition: FormDefinitionInterface

A reference to the FormDefinition that contains this form item.

formItemType

formItemType: string

The type of the FormItem.

formItems

header

header: Observable<string>

The header text displayed at the top of the group box.

type

Observable(String)

isRequired

isRequired: Observable<boolean>

The value indicating whether this item is required.

isValid

isValid: Observable<boolean>

The value indicating whether this item is valid.

isVisible

isVisible: Observable<boolean>

The value indicating whether this item is visible or not.

itemID

itemID: Observable<string>

The form item ID.

maxWidth

maxWidth: Observable<number>

The maximum width of the group.

type

Observable(Number)

orientation

orientation: Observable<string>

The tooltip of this form item.

type

Observable(String)

toolTip

toolTip: Observable<string>

The tooltip of this form item.

validationItems

validationItems: ValidationItem[]

Gets the collection of {@link validation.ValidationItem} objects that belong to this FormItem.

type

ValidationItem[]

visibleControlID

visibleControlID: Observable<string>

The ID of the form item whose value controls the visibility of this item.

visibleControlValue

visibleControlValue: Observable<string>

The value that the visible control form item must have for this item to be visible.

Methods

Private _destroy

  • _destroy(): void

Private _getResults

Protected _notifyResultChanged

  • _notifyResultChanged(): void

Private _render

  • _render(): Node

applyVisibility

  • applyVisibility(controlFormItem: FormItem): void
  • Set the visibility of this FormItem based on the value of the controlling FormItem.

    Parameters

    Returns void

getDisplayName

  • getDisplayName(): string

getFormItemById

  • getFormItemById(itemId: string): FormItem

getResult

refresh

  • refresh(): void

validate