com.adobe.xfa.template
Class TemplateModel.Insertion

java.lang.Object
  com.adobe.xfa.template.TemplateModel.Insertion

Enclosing class:

TemplateModel

public static class TemplateModel.Insertion
extends java.lang.Object

A class to define a mapping between a key and template fragment reference.

See Also:

TemplateModel.splice(List, boolean)

Constructor Summary

TemplateModel.Insertion(java.lang.String key, java.lang.String reference)
Instantiates an insertion from the given.

TemplateModel.Insertion(java.lang.String key, java.lang.String reference, java.lang.String somContext)
Instantiates an insertion from the given.

Method Summary

java.lang.String	getContainedBySom() Gets the SOM expression that defines the subtree(s) within the template that must contain the insertion point in order to be matched.
java.lang.String	getKey() Gets the name that identifies an insertion point.
java.lang.String	getReference() Gets the reference that defines a fragment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateModel.Insertion

public TemplateModel.Insertion(java.lang.String key,
                               java.lang.String reference)

Instantiates an insertion from the given.

TemplateModel.Insertion

public TemplateModel.Insertion(java.lang.String key,
                               java.lang.String reference,
                               java.lang.String somContext)

Instantiates an insertion from the given.

Method Detail

getKey

public final java.lang.String getKey()

Gets the name that identifies an insertion point.

Returns:

a name that identifies an insertion point.

getReference

public final java.lang.String getReference()

Gets the reference that defines a fragment.

Returns:

the reference that defines a fragment.

getContainedBySom

public final java.lang.String getContainedBySom()

Gets the SOM expression that defines the subtree(s) within the template that must contain the insertion point in order to be matched. If the SOM expression is null or empty, this insertion can be matched anywhere the key matches in the template.

Returns:

a SOM expression that defines the subtree(s) within the template where this insertion can be matched.