Package com.arbortext.epic

Interface AElement

All Known Implementing Classes:
ElementImpl
public interface AElement
The PTC Arbortext extension to the W3C DOM Element interface.

  • Field Details

    • UNDEFINED_CONTENT

      static final short UNDEFINED_CONTENT
      The element is not declared in the DTD.
      See Also:

    • CDATA_CONTENT

      static final short CDATA_CONTENT
      The element is declared as CDATA in the DTD.
      See Also:

    • RCDATA_CONTENT

      static final short RCDATA_CONTENT
      The element is declared as RCDATA in the DTD.
      See Also:

    • EMPTY_CONTENT

      static final short EMPTY_CONTENT
      The element is declared as EMPTY content in the DTD.
      See Also:

    • ELEMENT_CONTENT

      static final short ELEMENT_CONTENT
      The element is declared as ELEMENT content in the DTD.
      See Also:

    • ANY_CONTENT

      static final short ANY_CONTENT
      The element is declared as ANY content in the DTD.
      See Also:

    • MIXED_CONTENT

      static final short MIXED_CONTENT
      The element is declared as MIXED content in the DTD.
      See Also:

  • Method Details

    • isTableMarkup

      boolean isTableMarkup()
      Returns whether this Element is a part of table markup.
      Returns:
      Returns true if this Element node is part of table markup. Returns false otherwise.
      Since:
      Epic 4.1

    • getTagContentType

      short getTagContentType()
      An integer constant giving the declared content type for the element in the document type. This attribute is deprecated in favor of the contentType attribute in the ElementEditVAL interface which is a W3C standard attribute that returns similar information.
      Since:
      Epic 4.1

    • getElementsByAttribute

      NodeList getElementsByAttribute(String name, String value, short selector) throws DOMException
      Returns a NodeList of all descendant Elements that match the given attribute name and attribute value, in the order in which they are encountered in a pre-order traversal of this Element tree.
      Parameters:
      name - Specifies the name of the attribute to match. The value "*" matches all attribute names.
      value - Specifies the value of the attribute to match.
      selector - Specifies how the attribute value should be matched. When selector is 0, the value parameter is ignored. When selector is 1, only the elements that match both the name and the value are included.
      Returns:
      A list of matching element nodes.
      Throws:
      DOMException - SYNTAX_ERR: If selector is invalid.
      INVALID_CHARACTER_ERR: If name is namespace qualified.
      Since:
      Epic 4.1

    • getElementsByAttributeNS

      NodeList getElementsByAttributeNS(String namespaceURI, String localName, String value, short selector) throws DOMException
      Returns a NodeList of all descendant Elements that match the given attribute namespace URI, local name, and attribute value, in the order in which they are encountered in a pre-order traversal of this Element tree.
      Parameters:
      namespaceURI - The namespace URI of the attribute to retrieve. The value "*" matches all namespaces.
      localName - Specifies the local name of the attribute to match. The value "*" matches all local attribute names.
      value - Specifies the value of the attribute to match.
      selector - Specifies how the attribute value should be matched. When selector is 0, the value parameter is ignored. When selector is 1, only the elements that match both the name and the value are included.
      Returns:
      A list of matching element nodes.
      Throws:
      DOMException - SYNTAX_ERR: If selector is invalid.
      INVALID_CHARACTER_ERR: If localname is namespace qualified.
      Since:
      Epic 4.1

    • getTableSet

      TableSet getTableSet()
      The TableSet associated with this AElement. Null if none.
      Since:
      Epic 4.3

    • getTableGrid

      TableGrid getTableGrid()
      The TableGrid associated with this AElement. Null if none.
      Since:
      Epic 4.3

    • getTableCell

      TableCell getTableCell()
      The TableCell associated with this AElement. Null if none.
      Since:
      Epic 4.3

    • getTableColumn

      TableColumn getTableColumn()
      The TableColumn associated with this AElement . Null if none.
      Since:
      Epic 4.3

    • getTableRow

      TableRow getTableRow()
      The TableRow associated with this AElement. Null if none.
      Since:
      Epic 4.3

    • getTableRule

      TableRule getTableRule()
      The TableRule associated with this AElement. Null if none.
      Since:
      Epic 4.3

    • getInternalAttribute

      String getInternalAttribute(String name)
      Returns the value of an attribute as a string. Allows examination of Arbortext-specific internal attributes, which are not supported using the standard DOM interfaces.
      Parameters:
      name - Attribute name.
      Returns:
      Attribute value or null if no such attribute is defined.
      Since:
      Epic 4.4

    • getInternalAttributes

      PropertyMap getInternalAttributes(boolean includeDefaults)
      Returns a PropertyMap containing all attribute names and values.
      The list includes Arbortext internal attributes that are excluded from standard DOM processing.
      Parameters:
      includeDefaults - If True, default attribute values are included.
      Returns:
      Map of attribute name/value pairs.
      Since:
      Epic 4.4

    • setInternalAttribute

      boolean setInternalAttribute(String name, String value)
      Sets an attribute value. Allows setting of Arbortext internal attributes which are excluded from standard DOM processing.
      Parameters:
      name - Name of attribute to set.
      value - New value for attribute.
      Returns:
      Returns true if a new attribute value was stored. Returns false otherwise.
      Since:
      Epic 4.4

    • removeInternalAttribute

      boolean removeInternalAttribute(String name)
      Deletes an attribute value. Allows deletion of Arbortext internal attributes which are excluded from standard DOM processing.
      Parameters:
      name - Name of attribute to delete.
      Returns:
      Returns true if the attribute was deleted. Returns false otherwise.
      Since:
      Arbortext 5.4