UIZE JavaScript Framework

MODULES Uize.Templates.Collection

1. Introduction

The Uize.Templates.Collection module generates HTML that can be used for instances of the Uize.Widget.Collection class.

DEVELOPERS: Chris van Rensburg

The Uize.Templates.Collection module is a JavaScript Template Module that is automatically generated by a build script from a companion Uize.Templates.Collection.js.jst JavaScript Template (.jst) file.

1.1. Examples

There are no dedicated showcase example pages for the Uize.Templates.Collection module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Templates.Collection module...

SEARCH

1.2. Implementation Info

The Uize.Templates.Collection module defines the Uize.Templates.Collection package under the Uize.Templates namespace.

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

STATIC METHODS

Uize.Templates.Collection.process

STATIC PROPERTIES

Uize.Templates.Collection.input | Uize.Templates.Collection.moduleName | Uize.Templates.Collection.pathToResources

1.2.2. Features Overridden in This Module

No features have been overridden in this module.

1.2.3. Features Inherited From Other Modules

This module has no inherited features.

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

The Uize.Templates.Collection module is unit tested by the Uize.Test.Uize.Templates.Collection test module.

2. Static Methods

2.1. Uize.Templates.Collection.process

Returns a string, being the generated HTML that is to be used by an instance of the Uize.Widget.Collection class (or subclass).

SYNTAX

widgetHtmlSTR = Uize.Templates.Collection.process (inputOBJ);

The value of the inputOBJ parameter should be an object of the form...

{
  idPrefix: idPrefixSTR
}

2.1.1. idPrefix

A string, specifying the value of the idPrefix state property of the widget instance that uses this module to generate its HTML.

IMPLEMENTATION INFO

this feature was introduced in this module

3. Static Properties

3.1. Uize.Templates.Collection.input

An object, describing the allowed properties of the inputOBJ parameter of the Uize.Templates.Collection.process static method.

IMPLEMENTATION INFO

this feature was introduced in this module

3.2. Uize.Templates.Collection.moduleName

IMPLEMENTATION INFO

this feature was introduced in this module

3.3. Uize.Templates.Collection.pathToResources

IMPLEMENTATION INFO

this feature was introduced in this module