Ribbon

ICE.UI. Ribbon

new Ribbon(model)

A ribbon component.
Parameters:
Name Type Description
model ICE.UI.Model The component model.

Extends

Members

$dom :jQuery

Inherited From:
The component's DOM.
Type:

_kids :Array.<ICE.UI.Base>|Object.<String, ICE.UI.Base>

Inherited From:
The children components.
Type:

_locked :Boolean

Inherited From:
The flag whether component is locked.
Type:
  • Boolean

_name :String

Inherited From:
The name of component.
Type:
  • String

_parent :ICE.UI.Base

Inherited From:
The parent component.
Type:

content :ICE.UI.Content

Inherited From:
The model of component's content.
Type:

hidden :Boolean

Inherited From:
The flag whether component is hidden.
Type:
  • Boolean

model :ICE.UI.Model

Inherited From:
The component model.
Type:

Methods

addGroups($panel, content, form) → {jQuery}

Adds group(s) into panel.
Parameters:
Name Type Description
$panel jQuery The target panel.
content ICE.UI.Model The content model.
form Object.<string, ICE.UI.Form> The forms to associate with named group(s).
Returns:
The DOM of created groups.
Type
jQuery

addToFooter($panelnullable, content, form) → {jQuery}

Adds components to panel or ribbon footer.
Parameters:
Name Type Attributes Description
$panel jQuery <nullable>
 The target panel or null for ribbon.
content ICE.UI.Content The content model of components.
form Object The form(s) to associate with components.
Returns:
A jQuery collection of added components.
Type
jQuery

ancestor(type) → {ICE.UI.Base}

Inherited From:
Returns ancestor of specified type.
Parameters:
Name Type Description
type ICE.UI.Base The type to look for.
Returns:
The UI component or null if there is none.
Type
ICE.UI.Base

createPanel(name, model) → {jQuery}

Creates panel.
Parameters:
Name Type Description
name string The panel name.
model ICE.UI.Model The panel model.
Returns:
The panel's DOM element.
Type
jQuery

has(name) → {Boolean}

Inherited From:
Determines whether component has property set.
Parameters:
Name Type Description
name String The property name.
Returns:
true if it has property set, false otherwise.
Type
Boolean

hide()

Inherited From:
Hides component.

html(formopt) → {jQuery}

Overrides:
Returns component's DOM element.
Parameters:
Name Type Attributes Description
form ICE.UI.Form <optional>
 The form.
Returns:
jQuery collection of DOM element.
Type
jQuery

htmlOf(content, formopt) → {jQuery}

Inherited From:
Returns a collection of DOM elements of a content.
Parameters:
Name Type Attributes Description
content ICE.UI.Content The content model.
form ICE.UI.Form <optional>
 The form.
Returns:
jQuery collection of DOM element(s).
Type
jQuery

is(prop)

Inherited From:
Determines value of boolean property.
Parameters:
Name Type Description
prop string The property name.
Returns:
true if property evaluates to true, false otherwise.

lock()

Inherited From:
Locks root component.

onScrollerClick(elem, event)

Invoked when ribbon scroller is clicked.
Parameters:
Name Type Description
elem DOMElement The scroller element.
event jQuery.Event The event.

pop(refreshlessopt) → {jQuery}

Removes one panel from ribbon.
Parameters:
Name Type Attributes Description
refreshless boolean <optional>
 The flag whether ribbon refresh should be suppressed.
Returns:
The new active panel.
Type
jQuery

popAll($panel) → {jQuery}

Removes panel from ribbon with all panels above it.
Parameters:
Name Type Description
$panel jQuery The panel to pop.
Returns:
The removed panels.
Type
jQuery

postHtml(form)

Inherited From:
Invoked after html method invocation for component during modeling.
Parameters:
Name Type Description
form ICE.UI.Form The form

preHtml(form)

Inherited From:
Invoked before html method invocation for component during modeling.
Parameters:
Name Type Description
form ICE.UI.Form The form

show()

Inherited From:
Shows component.

trigger(event)

Inherited From:
Triggers custom event for component and its descendants.
Parameters:
Name Type Description
event String The event name.

unlock()

Inherited From:
Unlocks root component.

(abstract) update(model)

Inherited From:
Updates component according to a new model.
Parameters:
Name Type Description
model ICE.UI.Model The component model.

updateWith(content)

Inherited From:
Updates content of component.
Parameters:
Name Type Description
content ICE.UI.Content The content model.