Mixin: StructuredViewMixin

qui.views.commonviews.StructuredViewMixin

A view with top, body and bottom elements. Designed to be mixed together with qui.views.ViewMixin.

Methods

getBody() → {jQuery}

Return the body element.

Source:
Returns:
Type
jQuery

getBottom() → (nullable) {jQuery}

Return the bottom element.

Source:
Returns:
Type
jQuery

getIcon() → {qui.icons.Icon}

Return the view icon.

Source:
Returns:
Type
qui.icons.Icon

getTitle() → (nullable) {String}

Return the view title.

Source:
Returns:
Type
String

getTop() → {jQuery}

Return the top element.

Source:
Returns:
Type
jQuery

isMinimizable() → {Boolean}

Tell if the view is minimizable or not.

Source:
Returns:
Type
Boolean

isMinimized() → {Boolean}

Tell if the view is minimized or not.

Source:
Returns:
Type
Boolean

(abstract) makeBody() → {jQuery}

Implement this method to create the actual body of the view.

Source:
Returns:
Type
jQuery

makeBottom() → {jQuery}

Implement this method to create the bottom part of the view.

Source:
Returns:
Type
jQuery

minimize()

Minimize the view.

Source:

onMinimize()

Called when the view is minimized.

Source:

onUnminimize()

Called when the view is unminimized.

Source:

prepareIcon(icon) → {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

setIcon(iconnullable)

Set the view icon.

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

the new icon (null to disable icon)

Source:

setTitle(title)

Set the view title.

Parameters:
Name Type Description
title String

the new title

Source:

toggleMinimized()

Toggle the view's minimization state.

Source:

unminimize()

Restore the view's minimization to normal state.

Source: