Package org.odftoolkit.odfdom.dom.element.text

Class TextHElement

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.odftoolkit.odfdom.pkg.OdfElement
org.odftoolkit.odfdom.dom.element.OdfStylableElement
org.odftoolkit.odfdom.changes.TextContainingElement
org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase
org.odftoolkit.odfdom.dom.element.text.TextHElement
All Implemented Interfaces:
Serializable, Cloneable, OdfStylePropertySet, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
OdfTextHeading
public class TextHElement extends TextParagraphElementBase
DOM implementation of OpenDocument element <text:h>.
See Also:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • TextHElement

      public TextHElement(OdfFileDom ownerDoc)
      Create the instance of TextHElement
      Parameters:
      ownerDoc - The type is OdfFileDom

  • Method Details

    • getOdfName

      public OdfName getOdfName()
      Get the element name
      Overrides:
      getOdfName in class TextContainingElement
      Returns:
      return OdfName the name of element <text:h>.

    • getTextIsListHeaderAttribute

      public Boolean getTextIsListHeaderAttribute()
      Receives the value of the ODFDOM attribute representation TextIsListHeaderAttribute , See @text:is-list-header
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setTextIsListHeaderAttribute

      public void setTextIsListHeaderAttribute(Boolean textIsListHeaderValue)
      Sets the value of ODFDOM attribute representation TextIsListHeaderAttribute , See @text:is-list-header
      Parameters:
      textIsListHeaderValue - The type is Boolean

    • getTextOutlineLevelAttribute

      public Integer getTextOutlineLevelAttribute()
      Receives the value of the ODFDOM attribute representation TextOutlineLevelAttribute , See @text:outline-level

      Attribute is mandatory.

      Returns:
      - the Integer , the value or null, if the attribute is not set and no default value defined.

    • setTextOutlineLevelAttribute

      public void setTextOutlineLevelAttribute(Integer textOutlineLevelValue)
      Sets the value of ODFDOM attribute representation TextOutlineLevelAttribute , See @text:outline-level
      Parameters:
      textOutlineLevelValue - The type is Integer

    • getTextRestartNumberingAttribute

      public Boolean getTextRestartNumberingAttribute()
      Receives the value of the ODFDOM attribute representation TextRestartNumberingAttribute , See @text:restart-numbering
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setTextRestartNumberingAttribute

      public void setTextRestartNumberingAttribute(Boolean textRestartNumberingValue)
      Sets the value of ODFDOM attribute representation TextRestartNumberingAttribute , See @text:restart-numbering
      Parameters:
      textRestartNumberingValue - The type is Boolean

    • getTextStartValueAttribute

      public Integer getTextStartValueAttribute()
      Receives the value of the ODFDOM attribute representation TextStartValueAttribute , See @text:start-value
      Returns:
      - the Integer , the value or null, if the attribute is not set and no default value defined.

    • setTextStartValueAttribute

      public void setTextStartValueAttribute(Integer textStartValueValue)
      Sets the value of ODFDOM attribute representation TextStartValueAttribute , See @text:start-value
      Parameters:
      textStartValueValue - The type is Integer

    • newTextNumberElement

      public TextNumberElement newTextNumberElement()
      Create child element <text:number>.
      Returns:
      the element <text:number>

    • accept

      public void accept(ElementVisitor visitor)
      Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.
      Overrides:
      accept in class OdfElement
      Parameters:
      visitor - an instance of DefaultElementVisitor

    • newTextNode

      public void newTextNode(String content)
      Add text content. Only elements which are allowed to have text content offer this method.

    • setTextContent

      public void setTextContent(String content)
      Replaces all content with given text content. Only elements which are allowed to have text content offer this method.
      Specified by:
      setTextContent in interface Node
      Overrides:
      setTextContent in class ParentNode
      Parameters:
      new - text content to replace the existing children (or removes all if null)

    • onRemoveNode

      protected void onRemoveNode()
      Overrides:
      onRemoveNode in class OdfStylableElement

    • onInsertNode

      protected void onInsertNode()
      Overrides:
      onInsertNode in class OdfStylableElement

    • isComponentRoot

      public boolean isComponentRoot()
      Overrides:
      isComponentRoot in class OdfElement

    • split

      public OdfElement split(int posStart)
      Splitting the element at the given position into two halves

      If the paragraph does have an automatic style with a master-page, which results into a page break before the paragraph, this page break will be removed for the new second half. For paragraph containing template styles the follow-up style should be chosen.

      Overrides:
      split in class OdfElement
      Parameters:
      posStart - The logical position of the first character (or other paragraph child component) that will be moved to the beginning of the new paragraph.
      Returns:
      the new created second text container