Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIComponentDefinition

This defines control type and its properties when creating UI using UIBuilder.buildLayout method. All other control definitions extend this definition. All control definitions must be written as plain JavaScript objects. For example:

Service.UIBuilder.buildLayout({type: 'Label', text: 'Name', helpText: 'Name of something.'}, container, fields);

Hierarchy

Indexable

[key: string]: any

This defines control type and its properties when creating UI using UIBuilder.buildLayout method. All other control definitions extend this definition. All control definitions must be written as plain JavaScript objects. For example:

Service.UIBuilder.buildLayout({type: 'Label', text: 'Name', helpText: 'Name of something.'}, container, fields);

Index

Properties

Optional afterInit

Optional attr

attr: IDictionary<string>

Object defining html attributes for controls root element.

Optional click

Callback that will be called when control is clicked.

Optional css

css: JQueryCssProperties

Object defining css styles for controls root element.

Optional enabled

enabled: undefined | false | true

If true control will be enabled if false control will be disabled (inactive).

Optional fixedWidth

fixedWidth: undefined | number

Optional id

id: undefined | string

Reference id of the control, it will be used to reference this control in the code throuth FieldsIndex objects.

Optional ignore

ignore: undefined | false | true

If true this control definition will be ignored and control will not be initiated.

Optional init

Callback that will be called when control is initialised.

Optional on

Optional styleClass

styleClass: undefined | string

Style class to add on root element of the control.

type

type: string | object

Control type, tells what kind of control this is.

Optional visible

visible: undefined | false | true

Set initial visibility of control. (default: true)