Package com.adobe.xfa.template.containers

Class SubformSet

java.lang.Object
com.adobe.xfa.Obj
com.adobe.xfa.Node
com.adobe.xfa.Element
com.adobe.xfa.ProtoableNode
com.adobe.xfa.template.containers.Container
com.adobe.xfa.template.containers.SubformSet
All Implemented Interfaces:
Peer
Direct Known Subclasses:
FormSubformSet
public class SubformSet extends Container
An element that describes a set of related subform objects.

A subformSet has an attribute called relation, that describes the relationship between the subforms contained in the subform set. The value of the relation attribute can be on of "ordered", "unordered", or "choice".

When the subforms in a subformSet are dynamically created based on the data specified for the template, it is the relation attribute which defines in what order the subforms will be instantiated.

Let's take the following example: 

 
  Example 1:
  In this example with relation set to "unordered", we can expect to see forms
  with the following structures:
 
  "abcd"
  "acbd"
  "acccbbbcbbbbbcbcbd"
 
  subforms "c" and "b" can appear in any order.<br/>
 
  Example 2:
  If the relation attribute was "ordered" we can expect to see forms with the
  following structure:<br/>
 
  "abcd"
  "abbbbbbbbbcccccccccd"
 
  subforms "b" and "c" must appear in the order they appear in the
  subform set.
 
  Example 3:
  finally, if the relation attribute was "choice", we can expect to see forms
  with the following structure:
 
  "abd"
  "acd"
  "abbbbbbbbbbbbd"
  "accccccccccccd"
 
  Where you only have a choice of "b" or "c" from the available subforms in
  the subformSet.

  • Constructor Details

    • SubformSet

      public SubformSet(Element parent, Node prevSibling)
       
                    index  Used
     overflowLeader[     |     ]
   overflowTtrailer[     |     ]
      bookendLeader[     |     ]
     bookendTrailer[     |     ]

  • Method Details

    • reset

      public void reset()

    • isWidthGrowSupported

      public boolean isWidthGrowSupported()
      Description copied from class: Container
      Return whether or not this container support growable widths This does not indicate whether the container height is currently growable, just whether it's supported by this container type.

      Comments Helps distinguish - ie text draws supporting growing but arc draws do not.

      Overrides:
      isWidthGrowSupported in class Container

    • isHeightGrowSupported

      public boolean isHeightGrowSupported()
      Description copied from class: Container
      Returns whether or not this container support growable heights. This does not indicate whether the container height is currently growable, just whether it's supported by this container type.
      Overrides:
      isHeightGrowSupported in class Container

    • getUsedTable

      public int[][] getUsedTable()

    • setInstanceIndex

      public void setInstanceIndex(int nIndex)

    • getInstanceManager

      public Obj getInstanceManager()

    • getScriptTable

      public ScriptTable getScriptTable()
      Overrides:
      getScriptTable in class Container