Class: UWA.Controls.Tag

UWA/Controls/Tag. UWA.Controls.Tag

new UWA.Controls.Tag(options)

Represents a tag. Inherits from Input.Button.

Available Events
Event Description
onClick When the user click on the control
onClose When the user clicks on the close icon
Available CSS Classes

The className option can be composed of one or more of those CSS classes:

Themes: all UWA.Input.Controls.Button themes

Example
var tag = new UWA.Controls.Tag({
    value: "A tag",
    events: {
        onClick: function () {
             this.setClosable(true); // Make the tag closable
         },
        onClose: function () {
             this.setClosable(false); // Make the tag not closable (removes the cross)
         }
    }
}).inject(widget.body);
Parameters
Name Type Description
options Object

Options hash or a option/value pair. Support all options from UWA.Controls.Input and some specific to this control.

Properties
Name Type Argument Default Description
closable Boolean <optional>
 false

If the element should be closable

Extends

Index

Members

Methods

Members

<protected> name

Properties:
Name Type Description
name String

The input name. Default: 'uwa-tag'.

<protected> options

Properties:
Name Type Description
options Object

The default controls options.

<protected> elements :Object

The current control elements.

Type
  • Object
Inherited From:

Methods

setClosable(closable)

Toggle the state of the tag

Parameters
Name Type Argument Default Description
closable Boolean <optional>
 true

If false, remove the close button.

syncInput()

Synchronize the control display with the native input state. To override.

Inherited From:

focus(y, changeInputFocus) → {this}

Set the focus on this input.

Parameters
Name Type Argument Default Description
y Boolean <optional>
 true

If false, removes the focus.
changeInputFocus Boolean <optional>
 true

change the input focus (you should not change that)
Returns

instance

Type
this
Inherited From:

isDisabled() → {Boolean}

Get if this input is disabled

Returns
Type
Boolean
Inherited From:

setDisabled(y) → {this}

Set the input as disabled

Parameters
Name Type Argument Default Description
y Boolean <optional>
 true

If false, enable the input.
Returns
Type
this
Inherited From:

getValue() → {String}

Get the input value. To override if needed.

Returns

The input value

Type
String
Inherited From:

setValue(value) → {this}

Set the input value. To override if needed.

Parameters
Name Type Description
value String

The new value
Returns
Type
this
Inherited From:

getContent() → {HTMLelement}

Returns control content.

Returns

Control container.

Type
HTMLelement
Inherited From:

getInputElement() → {HTMLelement}

Returns the native input element

Returns
Type
HTMLelement
Inherited From:

inject(element, where) → {this}

Inject control in the dom.

Parameters
Name Type Argument Description
element HTMLelement

Dom target
where String <optional>

Where to inject
Returns
Type
this
Inherited From:

remove() → {this}

Remove the control from the dom

Returns
Type
this
Inherited From:

getClassNames(suffixes) → {String}

Generate a CSS class name based on the class name property, its parent classes, and the options "className". It should be used internally (in the control).

Example
var Input = UWA.Controls.Abstract.extend({
   name: 'uwa-input',

   options: {
       className: '',
   },

   buildSkeleton: function () {
       this.elements.container = UWA.createElement('div', { 'class': this.getClassNames() });
       this.elements.content = UWA.createElement('div', { 'class': this.getClassNames('-content') });
   }
});

var Radio = Input.extend({
   name: 'uwa-inputradio'
});

new Radio({
    className: 'toto black'
});
// container will have the class 'toto black uwa-inputradio uwa-input'
// content will have the class 'toto black uwa-inputradio-content uwa-input-content'
Parameters
Name Type Description
suffixes String

All parameters should be strings, used as suffix to append to the UWA.Class names of the inheritance chain.
Returns

The generated CSS class name.

Type
String
Inherited From:

hide()

Hide control content.

Inherited From:

show()

Show control content.

Inherited From:

destroy()

Destroy the control elements and its children. Remove all events and remove the element from the dom. This control and its children should not be used after this.

Inherited From: