Class type Ext_form_Labelable.configs

class type configs = object .. end

Inherits

Ext_Base.configs

method activeError : Js.js_string Js.t Js.prop

If specified, then the component will be displayed with this value as its active error when first rendered. Use setActiveError or unsetActiveError to change it after component creation.

method activeErrorsTpl : 'a. 'a Js.t Js.prop

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. if the msgTarget is title, it defaults to a list separated by new lines. Otherwise, it renders each message as an item in an unordered list.

method afterBodyEl : 'b. 'b Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup at the end of the input containing element. If an XTemplate is used, the component's render data serves as the context.

method afterLabelTextTpl : 'c. 'c Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup after the label text. If an XTemplate is used, the component's render data serves as the context.

method afterLabelTpl : 'd. 'd Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup after the label element. If an XTemplate is used, the component's render data serves as the context.

method afterSubTpl : 'e. 'e Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup after the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

method autoFitErrors : bool Js.t Js.prop

Whether to adjust the component's body area to make room for 'side' or 'under' error messages.

Defaults to: true

method baseBodyCls : Js.js_string Js.t Js.prop

The CSS class to be applied to the body content element.

Defaults to: Ext.baseCSSPrefix + 'form-item-body'

method beforeBodyEl : 'f. 'f Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup at the beginning of the input containing element. If an XTemplate is used, the component's render data serves as the context.

method beforeLabelTextTpl : 'g. 'g Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup before the label text. If an XTemplate is used, the component's render data serves as the context.

method beforeLabelTpl : 'h. 'h Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup before the label element. If an XTemplate is used, the component's render data serves as the context.

method beforeSubTpl : 'i. 'i Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup before the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

method clearCls : Js.js_string Js.t Js.prop

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to provide field clearing.

Defaults to: Ext.baseCSSPrefix + 'clear'

method errorMsgCls : Js.js_string Js.t Js.prop

The CSS class to be applied to the error message element.

Defaults to: Ext.baseCSSPrefix + 'form-error-msg'

method fieldBodyCls : Js.js_string Js.t Js.prop

An extra CSS class to be applied to the body content element in addition to baseBodyCls.

Defaults to: ''

method fieldLabel : Js.js_string Js.t Js.prop

The label for the field. It gets appended with the labelSeparator, and its position and sizing is determined by the labelAlign, labelWidth, and labelPad configs.

method formItemCls : Js.js_string Js.t Js.prop

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout.

Defaults to: Ext.baseCSSPrefix + 'form-item'

method hideEmptyLabel : bool Js.t Js.prop

When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is empty. Setting this to false will cause the empty label element to be rendered and space to be reserved for it; this is useful if you want a field without a label to line up with other labeled fields in the same form.

If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set the hideLabel config to true.

Defaults to: true

method hideLabel : bool Js.t Js.prop

Set to true to completely hide the label element (fieldLabel and labelSeparator). Also see hideEmptyLabel, which controls whether space will be reserved for an empty fieldLabel.

Defaults to: false

method invalidCls : Js.js_string Js.t Js.prop

The CSS class to use when marking the component invalid.

Defaults to: Ext.baseCSSPrefix + 'form-invalid'

method labelAlign : Js.js_string Js.t Js.prop

Controls the position and alignment of the fieldLabel. Valid values are:

"left" (the default) - The label is positioned to the left of the field, with its text aligned to the left. Its width is determined by the labelWidth config.
"top" - The label is positioned above the field.
"right" - The label is positioned to the left of the field, with its text aligned to the right. Its width is determined by the labelWidth config.

Defaults to: 'left'

method labelAttrTpl : 'j. 'j Js.t Js.prop

An optional string or XTemplate configuration to insert in the field markup inside the label element (as attributes). If an XTemplate is used, the component's render data serves as the context.

method labelCls : Js.js_string Js.t Js.prop

The CSS class to be applied to the label element. This (single) CSS class is used to formulate the renderSelector and drives the field layout where it is concatenated with a hyphen ('-') and labelAlign. To add additional classes, use labelClsExtra.

Defaults to: Ext.baseCSSPrefix + 'form-item-label'

method labelClsExtra : Js.js_string Js.t Js.prop

An optional string of one or more additional CSS classes to add to the label element. Defaults to empty.

method labelPad : Js.number Js.t Js.prop

The amount of space in pixels between the fieldLabel and the input field.

Defaults to: 5

method labelSeparator : Js.js_string Js.t Js.prop

Character(s) to be inserted at the end of the label text.

Set to empty string to hide the separator completely.

Defaults to: ':'

method labelStyle : Js.js_string Js.t Js.prop

A CSS style specification string to apply directly to this field's label.

method labelWidth : Js.number Js.t Js.prop

The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to "left" or "right".

Defaults to: 100

method msgTarget : Js.js_string Js.t Js.prop

The location where the error message text should display. Must be one of the following values:

qtip Display a quick tip containing the message when the user hovers over the field. This is the default.

Ext.tip.QuickTipManager.init must have been called for this setting to work.
title Display the message in a default browser title attribute popup.
under Add a block div beneath the field containing the error message.
side Add an error icon to the right of the field, displaying the message in a popup on hover.
none Don't display any error message. This might be useful if you are implementing custom error display.
[element id] Add the error message directly to the innerHTML of the specified element.

Defaults to: 'qtip'

method preventMark : bool Js.t Js.prop

true to disable displaying any error message set on this object.

Defaults to: false

method getFieldLabel : (< activeError : Js.js_string Js.t Js.prop;
          activeErrorsTpl : 'a. 'a Js.t Js.prop; afterBodyEl : 'b. 'b Js.t Js.prop;
          afterLabelTextTpl : 'c. 'c Js.t Js.prop;
          afterLabelTpl : 'd. 'd Js.t Js.prop; afterSubTpl : 'e. 'e Js.t Js.prop;
          autoFitErrors : bool Js.t Js.prop;
          baseBodyCls : Js.js_string Js.t Js.prop;
          beforeBodyEl : 'f. 'f Js.t Js.prop;
          beforeLabelTextTpl : 'g. 'g Js.t Js.prop;
          beforeLabelTpl : 'h. 'h Js.t Js.prop; beforeSubTpl : 'i. 'i Js.t Js.prop;
          clearCls : Js.js_string Js.t Js.prop;
          errorMsgCls : Js.js_string Js.t Js.prop;
          fieldBodyCls : Js.js_string Js.t Js.prop;
          fieldLabel : Js.js_string Js.t Js.prop;
          formItemCls : Js.js_string Js.t Js.prop; getFieldLabel : 'k;
          hideEmptyLabel : bool Js.t Js.prop; hideLabel : bool Js.t Js.prop;
          invalidCls : Js.js_string Js.t Js.prop;
          labelAlign : Js.js_string Js.t Js.prop;
          labelAttrTpl : 'j. 'j Js.t Js.prop; labelCls : Js.js_string Js.t Js.prop;
          labelClsExtra : Js.js_string Js.t Js.prop;
          labelPad : Js.number Js.t Js.prop;
          labelSeparator : Js.js_string Js.t Js.prop;
          labelStyle : Js.js_string Js.t Js.prop;
          labelWidth : Js.number Js.t Js.prop;
          msgTarget : Js.js_string Js.t Js.prop; preventMark : bool Js.t Js.prop;
          .. >
        Js.t, unit -> Js.js_string Js.t)
       Js.meth_callback Js.writeonly_prop as 'k

See method t.getFieldLabel