module:MField

module:MField

Abstract field class.

Constructor

(abstract) new (require("MField"))()

Description:

  • Constructor.

Extends

Members

signalValidationCompleted :MSignal

Description:

  • Signal is emitted when the validation for this field is completed. Parameters to be emitted:

    • result {boolean}
    • errorMessages {string[]}

Signal is emitted when the validation for this field is completed. Parameters to be emitted:

  • result {boolean}
  • errorMessages {string[]}
Type:
  • MSignal

signalFieldValueChangedByUser :MSignal

Description:

  • Signal is emitted when the value of this field is changed by the uer. Parameters to be emitted:

    • field {MWidget|MField}
    • value {*}

Signal is emitted when the value of this field is changed by the uer. Parameters to be emitted:

  • field {MWidget|MField}
  • value {*}
Type:
  • MSignal

getFieldHTMLElementFieldName

Description:

  • Get widget HTML element field name.

Get widget HTML element field name.

setFieldHTMLElementFieldName

Description:

  • Set widget HTML element field name.

Set widget HTML element field name.

setPrimaryIconVisible

Description:

  • Set primary icon visible.

Set primary icon visible.

setPrimaryIconHidden

Description:

  • Set primary icon hidden.

Set primary icon hidden.

togglePrimaryIconVisibility

Description:

  • Set primary icon hidden.

Set primary icon hidden.

setSecondaryIconVisible

Description:

  • Set secondary icon visible.

Set secondary icon visible.

setSecondaryIconHidden

Description:

  • Set secondary icon hidden.

Set secondary icon hidden.

toggleSecondaryIconVisibility

Description:

  • Set primary icon hidden.

Set primary icon hidden.

signalSender

Description:

  • Property method.

Overrides:

Property method.

setSignalSender

Description:

  • Property method.

Overrides:

Property method.

setDisabled

Description:

  • Set the widget disabled.

Overrides:

Set the widget disabled.

setEnabled

Description:

  • Set the widget enabled.

Overrides:

Set the widget enabled.

setEnabledState

Description:

  • Set enabled state.

Overrides:

Set enabled state.

setDisabledState

Description:

  • Set disabled state.

Overrides:

Set disabled state.

toggleEnabledState

Description:

  • Toggle enabled state.

Overrides:

Toggle enabled state.

setHidden

Description:

  • Set the widget hidden.

    Method uses style.display CSS to change the visibility.

Overrides:

Set the widget hidden.

Method uses style.display CSS to change the visibility.

setVisible

Description:

  • Set the widget visible.

    Method uses style.display CSS to change the visibility.

Overrides:

Set the widget visible.

Method uses style.display CSS to change the visibility.

setVisibilityState

Description:

  • Set visibility state.

Overrides:

Set visibility state.

setHiddenState

Description:

  • Set hidden state.

Overrides:

Set hidden state.

toggleVisibilityState

Description:

  • Toggle visibility state,

Overrides:

Toggle visibility state,

Methods

labelWidget() → {null|MLabelWidget}

Description:

  • Label widget.

Returns:

Label widget.

Type
null | MLabelWidget

setLabelWidget(widget)

Description:

  • Set label widget.

Parameters:
Name Type Description
widget MLabelWidget

Label widget.

setInformationLabelWidgetText(text)

Description:

  • Set information label text.

Parameters:
Name Type Description
text string

Text to be set.

formatters() → {Array.<MFormatter>}

Description:

  • Property method.

Returns:

Validators

Type
Array.<MFormatter>

addFormatter(formatter)

Description:

  • Add a formatter.

Parameters:
Name Type Description
formatter MFormatter

Formatter.

addFormatters(formatters)

Description:

  • Add formatters.

Parameters:
Name Type Description
formatters Array.<MFormatter>

Formatters.

clearFormatters()

Description:

  • Clear formatters.

validators() → {Array.<MValidator>}

Description:

  • Property method.

Returns:

Validators

Type
Array.<MValidator>

addValidator(validator)

Description:

  • Add a validator.

Parameters:
Name Type Description
validator MValidator

Validator.

addValidators(validators)

Description:

  • Add validators.

Parameters:
Name Type Description
validators Array.<MValidator>

Validators.

clearValidators()

Description:

  • Clear validators.

isValidated() → {boolean}

Description:

  • Whether this field is validated.

Returns:

State.

Type
boolean

setValidated()

Description:

  • Set validated.

setUnvalidated()

Description:

  • Set unvalidated.

setValidationState(state)

Description:

  • Set validation state.

Parameters:
Name Type Description
state boolean

State.

isRequired() → {boolean}

Description:

  • Property.

Returns:

Value.

Type
boolean

setRequired()

Description:

  • Property.

setNotRequired()

Description:

  • Property.

setRequiredState(state)

Description:

  • Property.

Parameters:
Name Type Description
state boolean

State.

doesOperateItself() → {boolean}

Description:

  • Property.

Returns:

State.

Type
boolean

getValue() → {*}

Description:

  • Get current value.

    Reimplement this method in the child class.

Returns:

Value.

Type
*

setValue(value)

Description:

  • Set current value.

    Reimplement this method in the child class.

Parameters:
Name Type Description
value *

Value to be set.

clearValue()

Description:

  • Clear current value.

    Reimplement this method in the child class.

getDefaultValue() → {*}

Description:

  • Get default value.

Returns:

Value.

Type
*

setDefaultValue(defaultValue)

Description:

  • Set default value.

Parameters:
Name Type Description
defaultValue *

Default value to be set.

getPlaceholderText() → {null|string}

Description:

  • Set placeholder text.

Returns:

Placeholder text.

Type
null | string

setPlaceholderText(text)

Description:

  • Set placeholder text.

Parameters:
Name Type Description
text string

Placeholder text.

formatAndValidate(eventName)

Description:

  • Format and validate the current value for the given event.

Parameters:
Name Type Description
eventName null | string

Event name.

primaryIcon() → {null|MFontAwesomeIconWidget}

Description:
Returns:

Icon.

Type
null | MFontAwesomeIconWidget

setPrimaryIcon(iconClasses)

Description:

  • Set primary icon.

    You can use module:MFontAwesomeIconEnums enum class.

Parameters:
Name Type Description
iconClasses Array.<string>

Icon classes.

setPrimaryIconAriaHidden(state)

Description:

  • Set primary icon aria hidden.

Parameters:
Name Type Description
state boolean

State.

setPrimaryIconVisibilityState(state)

Description:

  • Set primary icon visibility state.

Parameters:
Name Type Description
state boolean

State.

secondaryIcon() → {null|MFontAwesomeIconWidget}

Description:
Returns:

Icon.

Type
null | MFontAwesomeIconWidget

setSecondaryIcon(iconClasses)

Description:

  • Set secondary icon.

    You can use module:MFontAwesomeIconEnums enum class.

Parameters:
Name Type Description
iconClasses Array.<string>

Icon classes.

setSecondaryIconAriaHidden(state)

Description:

  • Set secondary icon aria hidden.

Parameters:
Name Type Description
state boolean

State.

setSecondaryIconVisibilityState(state)

Description:

  • Set secondary icon visibility state.

Parameters:
Name Type Description
state boolean

State.

clearErrorMessages()

Description:

  • Clear all error messages.

    This method will remove all the error messages from the field.

addErrorMessage(message)

Description:

  • Add an error message.

Parameters:
Name Type Description
message string

Error message.

type() → {string}

Description:

  • Property Method.

Overrides:
Returns:

Value from MWidgetType enum class.

Type
string

parentWidget() → {null|MWidget}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | MWidget

setParent(parentWidget)

Description:

  • Set parent of this widget.

    This widget will be placed under root HTML element of the given parentWidget.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Parent widget.

setParentOfWidgetElement(parentWidget)

Description:

  • Set parent of this widget.

    This widget will be placed under widget HTML element of the given parentWidget.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Parent widget.

setParentByHTMLElementID(parentHTMLElementID)

Description:

  • Set parent by element ID.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentHTMLElementID string

Parent HTML element ID.

setParentByHTMLElement(parentHTMLElement)

Description:

  • Set parent by HTML element.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentHTMLElement HTMLElement

Parent HTML element.

assignParentWidget(parentWidget)

Description:

  • Assign parent widget.

    This method doesn't change hierarchy, simple sets the given widget as parent widget of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Widget.

rootHTMLElement() → {null|HTMLElement}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | HTMLElement

widgetHTMLElement() → {null|HTMLElement}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | HTMLElement

childrenLayouts() → {Array.<MLayout>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MLayout>

addChildLayout(layout)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
layout MWidget | MLayout

Layout.

removeChildLayout(layout) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
layout MWidget | MLayout

Layout.
Returns:

Whether the given layout found and removed.

Type
boolean

childrenWidgets() → {Array.<MWidget>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MWidget>

addChildWidget(widget)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
widget MWidget

Widget.

removeChildWidget(widget) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
widget MWidget

Widget.
Returns:

Whether the given widget found and removed.

Type
boolean

childrenFields() → {Array.<MField>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MField>

addChildField(field)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
field MWidget | MField

Field.

removeChildField(field) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
field MWidget | MField

Field.
Returns:

Whether the given field found and removed.

Type
boolean

childrenHTMLElements() → {Array.<HTMLElement>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<HTMLElement>

addChildHTMLElement(htmlElement)

Description:

  • Add given htmlElement as a child to this widget.

Overrides:
Parameters:
Name Type Description
htmlElement HTMLElement

HTML element.

removeChildHTMLElement(htmlElement) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
htmlElement htmlElement

HTML element.
Returns:

Whether the given htmlElement found and removed.

Type
boolean

className() → {null|string}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | string

cssClassesNamespace() → {null|string}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | string

data() → {null|*}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | *

setData(data)

Description:

  • Property Method.

Overrides:
Parameters:
Name Type Description
data *

Data to be set.

isDisabled() → {boolean}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
boolean

isHidden() → {boolean}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
boolean

setRootHTMLElementID(id)

Description:

  • Set root HTML element ID.

Overrides:
Parameters:
Name Type Description
id string

ID.

getWidgetHTMLElementName() → {null|string}

Description:

  • Get widget HTML element name.

Overrides:
Returns:

Name.

Type
null | string

setWidgetHTMLElementName(name)

Description:

  • Set widget HTML element name.

Overrides:
Parameters:
Name Type Description
name string

Name.

setWidgetHTMLElementAttribute(attributeName, value)

Description:

  • Set widget HTML element attribute.

Overrides:
Parameters:
Name Type Description
attributeName string

Attribute name.
value *

Value to be set.

getWidgetHTMLElementAttribute(attributeName) → {*}

Description:

  • Set widget HTML element attribute.

Overrides:
Parameters:
Name Type Description
attributeName string

Attribute name.
Returns:

Value.

Type
*

remove()

Description:

  • Remove the widget from its parent.

Overrides:

addRootHTMLElementEventListener(event, callback, context)

Description:

  • Add event listener to the root HTML element.

Overrides:
Parameters:
Name Type Description
event string

Event.
callback function

Callback.
context any

Context, namely this.

addWidgetHTMLElementEventListener(event, callback, context)

Description:

  • Add event listener to the widget HTML element.

Overrides:
Parameters:
Name Type Description
event string

Event.
callback function

Callback.
context any

Context, namely this.

removed()

Description:

  • This method is invoked when a widget is removed for deletion from memory.

Overrides:

initializeDescendantData()

Description:

  • Data block data initialized.

    This method is usually invoked explicitly by the parent object.

Overrides:

initializeData()

Description:

  • Initialize data by using data block.

Overrides: