Popup

ICE.UI. Popup

A popup 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:

autoClose :boolean

The flag whether popup should be closed on clicking outside of popup.
Type:
  • boolean

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

isBusy :boolean

The flag whether popup has busy status.
Type:
  • boolean

model :ICE.UI.Model

Inherited From:
The component model.
Type:

mouseRelative :boolean

The flag whether popup positioning should be mouse click relative. This option requires ICE.mouse.update(clickEvent) to be invoked before show method call.
Type:
  • boolean

removeOnClose :boolean

The flag whether popup should be destroyed on hide event.
Type:
  • boolean

Methods

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

busy(busyopt)

Toggles busy status of component.
Parameters:
Name Type Attributes Description
busy boolean <optional>
 If not specified, the busy visual will get updated.

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(Theopt)

Overrides:
Hides popup.
Parameters:
Name Type Attributes Description
The jQuery.Event <optional>
 event.

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.

position($element) → {Object}

Sets position of popup relative to element.
Parameters:
Name Type Description
$element jQuery The element.
Returns:
The side of element at which popup is shown.
Type
Object

positionWithMouse($element) → {Object}

Calculates position of popup based on position of mouse click on element.
Parameters:
Name Type Description
$element jQuery The element clicked.
Returns:
The offset.
Type
Object

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()

Overrides:
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.