Class type Ext_form_Labelable.t

class type t = object .. end

method bodyEl : Ext_dom_Element.t Js.t Js.prop

The div Element wrapping the component's contents. Only available after the component has been rendered.

method errorEl : Ext_dom_Element.t Js.t Js.prop

The div Element that will contain the component's error message(s). Note that depending on the configured msgTarget, this element may be hidden in favor of some other form of presentation, but will always be present in the DOM for use by assistive technologies.

method isFieldLabelable : bool Js.t Js.prop

Flag denoting that this object is labelable as a field. Always true.

Defaults to: true

method labelCell : Ext_dom_Element.t Js.t Js.prop

The <TD> Element which contains the label Element for this component. Only available after the component has been rendered.

method labelEl : Ext_dom_Element.t Js.t Js.prop

The label Element for this component. Only available after the component has been rendered.

method getActiveError : Js.js_string Js.t Js.meth

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.

Returns:

• Js.js_string Js.t

  The active error message on the component; if there is no error, an empty string is returned.

method getActiveErrors : Js.js_string Js.t Js.js_array Js.t Js.meth

Gets an Array of any active error messages currently applied to the field. This does not trigger validation on its own, it merely returns any messages that the component may already hold.

Returns:

• Js.js_string Js.t Js.js_array Js.t

  The active error messages on the component; if there are no errors, an empty Array is returned.

method getFieldLabel : Js.js_string Js.t Js.meth

Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be overridden to provide a custom generated label.

Returns:

• Js.js_string Js.t

  The configured field label, or empty string if not defined

method getInputId : Js.js_string Js.t Js.meth

Get the input id, if any, for this component. This is used as the "for" attribute on the label element. Implementing subclasses may also use this as e.g. the id for their own input element.

Returns:

• Js.js_string Js.t

  The input id

method getLabelWidth : Js.number Js.t Js.meth

Gets the width of the label (if visible)

Returns:

• Js.number Js.t

  The label width

method getLabelableRenderData : 'a. 'a Js.t Js.meth

Generates the arguments for the field decorations rendering template.

Returns:

• _ Js.t

  The template arguments

method getSubTplMarkup : Js.js_string Js.t Js.meth

Gets the markup to be inserted into the outer template's bodyEl. Defaults to empty string, should be implemented by classes including this mixin as needed.

Returns:

• Js.js_string Js.t

  The markup to be inserted

method hasActiveError : bool Js.t Js.meth

Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely looks for any message that the component may already hold.

method hasVisibleLabel : bool Js.t Js.meth

Checks if the field has a visible label

Returns:

• bool Js.t

  True if the field has a visible label

method initLabelable : unit Js.meth

Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

method setActiveError : Js.js_string Js.t -> unit Js.meth

Sets the active error message to the given string. This replaces the entire error message contents with the given string. Also see setActiveErrors which accepts an Array of messages and formats them according to the activeErrorsTpl. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters:

• msg: Js.js_string Js.t

  The error message

method setActiveErrors : Js.js_string Js.t Js.js_array Js.t -> unit Js.meth

Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters:

• errors: Js.js_string Js.t Js.js_array Js.t

  The error messages

method setFieldDefaults : 'b. 'b Js.t -> unit Js.meth

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given object, check if this component hasOwnProperty that config; if not then it's inheriting a default value from its prototype and we should apply the default value.

Parameters:

• defaults: _ Js.t

  The defaults to apply to the object.

method setFieldLabel : Js.js_string Js.t -> unit Js.meth

Set the label of this field.

Parameters:

• label: Js.js_string Js.t

  The new label. The labelSeparator will be automatically appended to the label string.

method trimLabelSeparator : Js.js_string Js.t Js.meth

Returns the trimmed label by slicing off the label separator character. Can be overridden.

Returns:

• Js.js_string Js.t

  The trimmed field label, or empty string if not defined

method unsetActiveError : unit Js.meth

Clears the active error message(s). Note that this only clears the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call clearInvalid instead.