Class: IconLabelViewMixin

qui.views.commonviews.IconLabelViewMixin(iconopt, labelopt, nullable, subLabelopt, nullable, clickableopt, …args)

A view made of an icon with a label.

Constructor

new IconLabelViewMixin(iconopt, labelopt, nullable, subLabelopt, nullable, clickableopt, …args)

Parameters:
Name Type Attributes Description
icon qui.icons.Icon <optional>

icon
label String <optional>
<nullable>

label
subLabel String <optional>
<nullable>

subscript label
clickable Boolean <optional>

whether to make view clickable or not (defaults to false)
args * <repeatable>

parent class parameters
Source:

Methods

getIcon() → (nullable) {qui.icons.Icon}

Return the icon.

Source:
Returns:
Type
qui.icons.Icon

getIconLabelContainer() → {jQuery}

Return the icon and label container.

Source:
Returns:
Type
jQuery

getLabel() → {String}

Return the label.

Source:
Returns:
Type
String

getSubLabel() → (nullable) {String}

Return the subscript label.

Source:
Returns:
Type
String

isClickable() → {Boolean}

Tell if view is clickable.

Source:
Returns:
Type
Boolean

makeIconLabelContainer() → {jQuery}

Create the icon and label container.

Source:
Returns:
Type
jQuery

prepareIcon(icon) → (nullable) {qui.icons.Icon}

Prepare the view icon, altering its attributes as needed, before applying it.

Parameters:
Name Type Description
icon qui.icons.Icon
Source:
Returns:
Type
qui.icons.Icon

setClickable(clickable)

Set or clear the clickable flag.

Parameters:
Name Type Description
clickable Boolean
Source:

setIcon(iconnullable)

Update the icon.

Parameters:
Name Type Attributes Description
icon qui.icons.Icon <nullable>
Source:

setLabel(labelnullable)

Update the label.

Parameters:
Name Type Attributes Description
label String <nullable>
Source:

setSubLabel(subLabelnullable)

Update the subscript label.

Parameters:
Name Type Attributes Description
subLabel String <nullable>
Source:

updateIcon()

Reapply the icon.

Source: