ICE

ICE

The ICE namespace.

Classes

AbstractPlugin
Command

Namespaces

Plugin
UI
UI

Members

(static) Browser :Browser

Create Repository Browser Plugin instance to ICE
Type:
  • Browser

(static) editor :ICE.Editor

The editor instance.
Type:
  • ICE.Editor

(static) menuItems :Object

Ribbon menu items.
Type:
  • Object

(static) meta :Object

The metadata.
Type:
  • Object

(static) mouse :ICE.UI.Mouse

The UI mouse instance
Type:

(static) PluginType :number

Properties:
Name Type Description
BLOCK number Block (topmost element inside of XTL slot).
DYNAMIC number Dynamic groups plugin.
ELEMENT number Element (bottommost element)
DESIGN number Design plugin (provides design settings).
WRAPPER number Wrapper (inline element wrapper, link, ...).
INPUT number Input.
LAYOUT number Layout plugin (topmost element inside of block).
CONTENT number XTL content.
CONTAINER number Named container plugin (grid column, etc.)
VIEW number Page plugin (XTL view)
OBSTRUCTIVE number Obstructive element whose content requires blocking of interactions during editing.
The plugin types.
Type:
  • number

Methods

(static) addPlugin()

Deprecated:
  • Use nge.extend instead.
Registers plugin with ICE.

(static) basename(path) → {String}

Returns trailing name component of file path.
Parameters:
Name Type Description
path String The path.
Returns:
The name.
Type
String

(static) childrenOf($element, excludeopt) → {Array}

Returns children entities of an element.
Parameters:
Name Type Attributes Description
$element jQuery The element.
exclude string <optional>
 The jQuery selector of children to exclude.
Returns:
The array of entities.
Type
Array

(static) dirname(path) → {String}

Returns parent directory's path.
Parameters:
Name Type Description
path String The path.
Returns:
The directory.
Type
String

(static) edit($element)

Enables editing of an XTL element.
Parameters:
Name Type Description
$element jQuery The XTL element to edit.

(static) entityOf($element) → {Object}

Returns REST entity of an XTL element's document.
Parameters:
Name Type Description
$element jQuery The XTL element.
Returns:
The REST entity.
Type
Object

(static) getPluginsByProperty(property) → {Object.<ICE.AbstractPlugin>}

Returns plugins with specified static property set.
Parameters:
Name Type Description
property string The property name.
Returns:
The plugins.
Type
Object.<ICE.AbstractPlugin>

(static) getPluginsByType(type, exact) → {Object.<ICE.AbstractPlugin>}

Returns plugins of specified type.
Parameters:
Name Type Description
type number The plugin type.
exact boolean The flag whether exact type comparsion should be used instead of bitwise.
Returns:
The plugins.
Type
Object.<ICE.AbstractPlugin>

(static) init(The)

Initializes system menu.
Parameters:
Name Type Description
The ICE.UI.Content content model of menu.

(static) save($element) → {boolean}

Saves content of an XTL element(s).
Parameters:
Name Type Description
$element jQuery The XTL element(s) in document order.
Returns:
true on success, false otherwise.
Type
boolean

(static) streamOf(uri, renditionnullable) → {String}

Returns stream URL of an XTL document.
Parameters:
Name Type Attributes Description
uri String The document URI.
rendition String <nullable>
 The optional rendition.
Returns:
The URL.
Type
String

(static) submit($element) → {nge.io.Submittable}

Submits inplace edited data.
Parameters:
Name Type Description
$element jQuery The XTL element(s) in document order.
Returns:
Submittable instance with Promise interface.
Type
nge.io.Submittable

(static) uriOf($element) → (nullable) {String}

Returns URI of an XTL element.
Parameters:
Name Type Description
$element jQuery The XTL element.
Returns:
The URI or null.
Type
String

Type Definitions

UI.Content

A custom type for UI component's content model. An object representation of one or more UI components. Plain object value is treated as a collection of named components, where object property names also specify component names. An array value is treated as a collection of anonymous components.
Type:

UI.Model

A custom type for UI component model. An object representation of component properties.
Type:
  • Object