Class FormSubformSet

  • All Implemented Interfaces:
    Peer

    public class FormSubformSet
    extends SubformSet
    • Constructor Detail

      • FormSubformSet

        public FormSubformSet​(Element parent,
                              Node prevSibling)
    • Method Detail

      • isSpecified

        public boolean isSpecified​(int eTag,
                                   boolean bCheckProtos,
                                   int nOccurrence)
        Description copied from class: Node
        Check if a property, child, or oneOfChild has been defined for this node
        Overrides:
        isSpecified in class Element
        Parameters:
        eTag - The XFA tag (name) of the property/child/oneOfChild to check for.
        bCheckProtos - if true, check if this property is specified via prototype inheritance. Defaults to true.
        nOccurrence - if this property can occur a fix number of times (usually [0..n]), then specify which occurrence to check for. Defaults to 0.
        Returns:
        True if the property has been specified.
        See Also:
        Node.isSpecified(int, boolean, int)
      • getElement

        public Element getElement​(int eTag,
                                  boolean bPeek,
                                  int nOccurrence,
                                  boolean bReturnDefault,
                                  boolean bValidate)
        Description copied from class: Element
        Gets this element's sub element whose element tag is given.

        To return the element, set the returnDefault argument to true. If the element is present, it is returned; otherwise the default element is created and returned.

        To peek at the element, set the peek argument to true. If the element is present, it is returned; otherwise null is returned. When set to true, default properties aren't created, and proto references are not expanded.

        To create the element, set the peek argument to false. If the element is absent, a default element is created and returned.

        If validation argument is true, and the validation fails, this method throws.

        If the occurrence argument is out of range, this method throws.

        Overrides:
        getElement in class ProtoableNode
        Parameters:
        eTag - the tag of the element to retrieve.
        bPeek - whether to peek at the element, or not.
        nOccurrence - the n'th occurrence of the element to retrieve.
        bReturnDefault - whether to create a default element, or not.
        bValidate - whether to validate the element, or not.
        Returns:
        the element, or null.
      • setElement

        public Node setElement​(Node child,
                               int eTag,
                               int nOccurrence)
        Description copied from class: Element
        Set an element value. Must be a valid 0..1 element, (not a oneOfChild or a 0..n child)
        Overrides:
        setElement in class ProtoableNode
        Parameters:
        child - the child to add or set.
        eTag - only used if oChild isNull -- in which case we remove the element
        See Also:
        Element.setElement(Node, int, int)