Package org.soulwing.prospecto.runtime.template

Interface ComposableViewTemplate

All Superinterfaces:

ViewTemplate

All Known Implementing Classes:

ConcreteViewTemplate

public interface ComposableViewTemplate
extends ViewTemplate

A view template that can be composed in another view template.

Author:

Carl Harris

Nested Class Summary

Nested classes/interfaces inherited from interface org.soulwing.prospecto.api.ViewTemplate

ViewTemplate.Traversal

Method Summary

Modifier and Type	Method	Description
AbstractContainerNode	arrayOfObjects(String name, String elementName, String namespace)	Extracts a view node of array-of-objects type from the root of this template for use as a subview in another template.
ViewTemplate	arrayOfObjectsTemplate(String name, String elementName, String namespace)	Extracts a view template of array-of-objects type from the root of this template.
AbstractContainerNode	arrayOfReferences(String name, String elementName, String namespace)	Extracts a view node of array-of-references type from the root of this template for use as a subview in another template.
ViewTemplate	arrayOfReferencesTemplate(String name, String elementName, String namespace)	Extracts a view template of array-of-references type from the root of this template.
AbstractContainerNode	object(String name, String namespace)	Extracts a view node of object type from the root of this template for use as a subview in another template.
AbstractContainerNode	reference(String name, String namespace)	Extracts a view node of reference type from the root of this template for use as a subview in another template.

Methods inherited from interface org.soulwing.prospecto.api.ViewTemplate

breadthFirst, createApplicator, createApplicator, depthFirst, generateView

Method Detail

object

AbstractContainerNode object(String name,
                             String namespace)

Extracts a view node of object type from the root of this template for use as a subview in another template.

Parameters:

name - name for the node (as it will appear in the calling template)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.object(String, String, ViewTemplate)

reference

AbstractContainerNode reference(String name,
                                String namespace)

Extracts a view node of reference type from the root of this template for use as a subview in another template.

Parameters:

name - name for the node (as it will appear in the calling template)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.reference(String, String, ViewTemplate)

arrayOfObjects

AbstractContainerNode arrayOfObjects(String name,
                                     String elementName,
                                     String namespace)

Extracts a view node of array-of-objects type from the root of this template for use as a subview in another template.

Parameters:

name - name for the node (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.arrayOfObjects(String, String, String, ViewTemplate)

arrayOfReferences

AbstractContainerNode arrayOfReferences(String name,
                                        String elementName,
                                        String namespace)

Extracts a view node of array-of-references type from the root of this template for use as a subview in another template.

Parameters:

name - name for the node (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.arrayOfReferences(String, String, String, ViewTemplate)

arrayOfObjectsTemplate

ViewTemplate arrayOfObjectsTemplate(String name,
                                    String elementName,
                                    String namespace)

Extracts a view template of array-of-objects type from the root of this template.

Parameters:

name - name for the root (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view template containing the children of the root node of this template

See Also:

ViewTemplateBuilderProducer.arrayOfObjects(String, String, String, ViewTemplate)

arrayOfReferencesTemplate

ViewTemplate arrayOfReferencesTemplate(String name,
                                       String elementName,
                                       String namespace)

Extracts a view template of array-of-references type from the root of this template.

Parameters:

name - name for the root (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view template containing the children of the root node of this template

See Also:

ViewTemplateBuilderProducer.arrayOfReferences(String, String, String, ViewTemplate)