Package com.adobe.xfa.template.containers

Class Field

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.Field
All Implemented Interfaces:
Peer
Direct Known Subclasses:
FormField
public class Field extends Container
A class to represent the XFA field object. A field describes a container capable of capturing and presenting data content.

  • Constructor Details

    • Field

      public Field(Element parent, Node prevSibling)
      Instantiates a field container.
      Parameters:
      parent - the field's parent, if any.
      prevSibling - the field's previous sibling, if any.

  • Method Details

    • clearItems

      public void clearItems()

    • deleteItem

      public boolean deleteItem(int nIndex)
      Delete an item at an index
      Parameters:
      nIndex - - the index to delete
      Returns:
      true if deleted.

    • execEvent

      public void execEvent(String sActivity)

    • execValidate

      public boolean execValidate()

    • getAttribute

      public Attribute getAttribute(int eTag, boolean bPeek, boolean bValidate)
      Description copied from class: Element
      Gets this element's attribute whose attribute tag is given.

      To peek at an attribute, set the peek argument to true. If the attribute is present, it is returned; otherwise null is returned.

      To create an attribute, set the peek argument to false. If the attribute is absent, a default attribute is created and returned; for attributes with no default, null is returned.

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

      Overrides:
      getAttribute in class Container
      Parameters:
      eTag - the tag of the attribute.
      bPeek - whether to peek at the attribute or not.
      bValidate - whether to validate the attribute or not.
      Returns:
      the attribute.

    • getDataNode

      public DataNode getDataNode()

    • getFormattedValue

      public String getFormattedValue()
      Gets the formatted value for this field. The returned formatted value will be either
      • the field's format picture representation, or,
      • the field's default locale picture representation, or,
      • any representation for works-in-progress.
      Returns:
      the formatted value for this field, or null if the content is null.

    • getItemLists

      public void getItemLists(boolean bPeek, Field.ItemPair items, boolean bEnforceMultiColumn)
      Get the display and save lists
      Parameters:
      bPeek - - if TRUE return lists that must not be modified
      items - - a structure holding the bound and display elements
      bEnforceMultiColumn - -

    • getNeutralValue

      public String getNeutralValue()
      Get the neutral value of this field
      Returns:
      String for Neutral value, null if undefined. This method is for checkbutton fields only.

    • getNodes

      public NodeList getNodes()
      Description copied from class: Element
      Gets this element's list of children.
      Overrides:
      getNodes in class Element
      Returns:
      a node list of all child nodes.
      See Also:

    • resolveAndEnumerateChildren

      public NodeList resolveAndEnumerateChildren(boolean bAllProperties, boolean bFirstDefaultOnly)
      Description copied from class: Element
      Construct a list of element-based properties and children. The list is fully resolved (ie: it will have children from any prototypes in it).
      Overrides:
      resolveAndEnumerateChildren in class Element
      See Also:

    • getOffValue

      public String getOffValue()
      Get the off value of this field
      Returns:
      The Off value. If none, null This method is for checkbutton fields only.

    • getOnValue

      public String getOnValue()
      Get the on value of this field
      Returns:
      The On value, null if there isn't one. This method is for checkbutton fields only.

    • getRawValue

      public String getRawValue()
      Gets the raw value for this field. The returned unformatted value will be either
      • the field's canonical representation, or,
      • any representation for works-in-progress.
      Returns:
      the unformatted raw value for this field, or null if the content is null.

    • getScriptTable

      public ScriptTable getScriptTable()
      Overrides:
      getScriptTable in class Container

    • hasValidFormattedValue

      public boolean hasValidFormattedValue()

    • isConnectSupported

      public boolean isConnectSupported()
      Description copied from class: Container
      Return whether the container supports connect i.e. field, exclGroup or subform
      Overrides:
      isConnectSupported in class Container
      Returns:
      true if the container supports connect
      See Also:

    • 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

    • 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

    • setFormattedValue

      public void setFormattedValue(String sValue)
      Set the formatted value for this field.
      Parameters:
      sValue - the formatted value for this field.
      Throws:
      UnsupportedOperationException - if you try and set the value of a boilerplate content. The given formatted value should be in the either
      • in the field's format picture representation, or,
      • in the field's default locale picture representation, or,
      • in any representation for works-in-progress.
      If the given formatted value can be successfully unformatted into its canonical representation, then the field's raw value is set to this canonical representation. Otherwise the field's raw value is set to the given formatted value.

    • setIsNull

      public void setIsNull(boolean bNull, boolean bNotify)
      Set this node to contain a null value.
      Parameters:
      bNull - true if the node contains a null value, false otherwise.

    • setOn

      public void setOn(boolean bOn)
      Set whether or not this container is 'on' in its ExclGroup
      Parameters:
      bOn - true if this container is 'on', false if the is not 'on'.

    • setRawValue

      public void setRawValue(String sString)
      Set the raw value for this field, no formatting.
      Parameters:
      sString - the unformatted raw value for this field.
      Throws:
      UnsupportedOperationException - if you try and set the value of a boilerplate content. The given unformatted value should be in the either
      • in the field's canonical representation, or,
      • in any representation for works-in-progress.