com.docmosis.template.analysis.structure
Interface TemplateStructureElement


public interface TemplateStructureElement

This class provides a simple interpretation of an element of a template that has been loaded into Docmosis. This element may have children making it a recursive structure which can then be used with a TemplateStructureProcessor to perform different analyses or renderings of the structure of a template.

See Also:
TemplateStructureProcessor

Method Summary
 boolean canHaveChildren()
           
 com.docmosis.template.analysis.structure.NestedStructureDetails getContainingNest()
          Get the containing nesting structure for this element.
 com.docmosis.template.analysis.structure.TemplateExpression getExpression()
          Get any template-expression associated with this field.
 String getName()
           
 String getOriginalFieldText()
          Get the original text of the element from the template
 List getSubStructures()
           
 boolean isArtificial()
          Determine if the element is artificially created by analysis processing.
 boolean isBarcode()
           
 boolean isConditionalSection()
           
 boolean isExpression()
           
 boolean isField()
           
 boolean isFunctionCall()
           
 boolean isHtmlRef()
           
 boolean isHyperlink()
           
 boolean isImage()
           
 boolean isInHeaderOrFooter()
           
 boolean isQRCode()
           
 boolean isRepeatingSection()
           
 boolean isTemplateReference()
           
 boolean isTemplateReferenceStatic()
           
 boolean isVariableGetField()
           
 boolean isVariableSetField()
           
 

Method Detail

getName

String getName()

isInHeaderOrFooter

boolean isInHeaderOrFooter()

isField

boolean isField()

isBarcode

boolean isBarcode()

isQRCode

boolean isQRCode()

isHyperlink

boolean isHyperlink()

isRepeatingSection

boolean isRepeatingSection()

isConditionalSection

boolean isConditionalSection()

isImage

boolean isImage()

canHaveChildren

boolean canHaveChildren()

getSubStructures

List getSubStructures()

isVariableGetField

boolean isVariableGetField()

isVariableSetField

boolean isVariableSetField()

isExpression

boolean isExpression()

isFunctionCall

boolean isFunctionCall()

isTemplateReference

boolean isTemplateReference()

isTemplateReferenceStatic

boolean isTemplateReferenceStatic()

isHtmlRef

boolean isHtmlRef()

isArtificial

boolean isArtificial()
Determine if the element is artificially created by analysis processing. Typically that means the element can be ignored.


getContainingNest

com.docmosis.template.analysis.structure.NestedStructureDetails getContainingNest()
Get the containing nesting structure for this element. This is only set if the field uses a "a.b.c" notation for its lookup term

Returns:
null if none applies.

getExpression

com.docmosis.template.analysis.structure.TemplateExpression getExpression()
Get any template-expression associated with this field.

Returns:
null if there is none.

getOriginalFieldText

String getOriginalFieldText()
Get the original text of the element from the template



Copyright © 2014–2023 Docmosis Pty Ltd. All rights reserved.