Package org.odftoolkit.odfdom.incubator.doc.text

Class OdfTextHeading

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

org.odftoolkit.odfdom.incubator.doc.text.OdfTextHeading

All Implemented Interfaces:

Serializable, Cloneable, OdfStylePropertySet, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class OdfTextHeading
extends TextHElement

Convenient functionality for the parent ODF OpenDocument element

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.odftoolkit.odfdom.dom.element.text.TextHElement

ELEMENT_NAME

Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement

mFamily, mStyleNameAttrib

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor	Description
OdfTextHeading(OdfFileDom ownerDoc)
OdfTextHeading(OdfFileDom ownerDoc, String styleName)	Creates a new instance of this class with the given style name.
OdfTextHeading(OdfFileDom ownerDoc, String styleName, String content)	Creates an instance of this class with the given styleName and content.

Method Summary

Modifier and Type	Method	Description
OdfTextHeading	addContent(String content)	Add the given content to the paragraph.
OdfTextHeading	addContentWhitespace(String content)	Add the given content to the heading.
OdfTextHeading	addStyledContent(String styleName, String content)	Set a heading to have the given styleName and add the given content.
OdfTextHeading	addStyledContentWhitespace(String styleName, String content)	Set a heading to have the given styleName and add the given content.
OdfTextHeading	addStyledSpan(String styleName, String content)	Add a span with the given styleName and content to this heading.
OdfTextHeading	addStyledSpanWhitespace(String styleName, String content)	Add a span with the given styleName and content to this paragraph.

Methods inherited from class org.odftoolkit.odfdom.dom.element.text.TextHElement

accept, getOdfName, getTextIsListHeaderAttribute, getTextOutlineLevelAttribute, getTextRestartNumberingAttribute, getTextStartValueAttribute, isComponentRoot, newTextNode, newTextNumberElement, onInsertNode, onRemoveNode, setTextContent, setTextIsListHeaderAttribute, setTextOutlineLevelAttribute, setTextRestartNumberingAttribute, setTextStartValueAttribute, split

Methods inherited from class org.odftoolkit.odfdom.dom.element.text.TextParagraphElementBase

getTextClassNamesAttribute, getTextCondStyleNameAttribute, getTextIdAttribute, getTextStyleNameAttribute, getXhtmlAboutAttribute, getXhtmlContentAttribute, getXhtmlDatatypeAttribute, getXhtmlPropertyAttribute, getXmlIdAttribute, newDr3dSceneElement, newDrawAElement, newDrawCaptionElement, newDrawCircleElement, newDrawConnectorElement, newDrawControlElement, newDrawCustomShapeElement, newDrawEllipseElement, newDrawFrameElement, newDrawGElement, newDrawLineElement, newDrawMeasureElement, newDrawPageThumbnailElement, newDrawPathElement, newDrawPolygonElement, newDrawPolylineElement, newDrawRectElement, newDrawRegularPolygonElement, newOfficeAnnotationElement, newOfficeAnnotationEndElement, newPresentationDateTimeElement, newPresentationFooterElement, newPresentationHeaderElement, newTextAElement, newTextAlphabeticalIndexMarkElement, newTextAlphabeticalIndexMarkEndElement, newTextAlphabeticalIndexMarkStartElement, newTextAuthorInitialsElement, newTextAuthorNameElement, newTextBibliographyMarkElement, newTextBookmarkElement, newTextBookmarkEndElement, newTextBookmarkRefElement, newTextBookmarkStartElement, newTextChangeElement, newTextChangeEndElement, newTextChangeStartElement, newTextChapterElement, newTextCharacterCountElement, newTextConditionalTextElement, newTextCreationDateElement, newTextCreationTimeElement, newTextCreatorElement, newTextDatabaseDisplayElement, newTextDatabaseNameElement, newTextDatabaseNextElement, newTextDatabaseRowNumberElement, newTextDatabaseRowSelectElement, newTextDateElement, newTextDdeConnectionElement, newTextDescriptionElement, newTextEditingCyclesElement, newTextEditingDurationElement, newTextExecuteMacroElement, newTextExpressionElement, newTextFileNameElement, newTextHiddenParagraphElement, newTextHiddenTextElement, newTextImageCountElement, newTextInitialCreatorElement, newTextKeywordsElement, newTextLineBreakElement, newTextMeasureElement, newTextMetaElement, newTextMetaFieldElement, newTextModificationDateElement, newTextModificationTimeElement, newTextNoteElement, newTextNoteRefElement, newTextObjectCountElement, newTextPageContinuationElement, newTextPageCountElement, newTextPageNumberElement, newTextPageVariableGetElement, newTextPageVariableSetElement, newTextParagraphCountElement, newTextPlaceholderElement, newTextPrintDateElement, newTextPrintedByElement, newTextPrintTimeElement, newTextReferenceMarkElement, newTextReferenceMarkEndElement, newTextReferenceMarkStartElement, newTextReferenceRefElement, newTextRubyElement, newTextScriptElement, newTextSElement, newTextSenderCityElement, newTextSenderCompanyElement, newTextSenderCountryElement, newTextSenderEmailElement, newTextSenderFaxElement, newTextSenderFirstnameElement, newTextSenderInitialsElement, newTextSenderLastnameElement, newTextSenderPhonePrivateElement, newTextSenderPhoneWorkElement, newTextSenderPositionElement, newTextSenderPostalCodeElement, newTextSenderStateOrProvinceElement, newTextSenderStreetElement, newTextSenderTitleElement, newTextSequenceElement, newTextSequenceRefElement, newTextSheetNameElement, newTextSoftPageBreakElement, newTextSpanElement, newTextSubjectElement, newTextTabElement, newTextTableCountElement, newTextTableFormulaElement, newTextTemplateNameElement, newTextTextInputElement, newTextTimeElement, newTextTitleElement, newTextTocMarkElement, newTextTocMarkEndElement, newTextTocMarkStartElement, newTextUserDefinedElement, newTextUserFieldGetElement, newTextUserFieldInputElement, newTextUserIndexMarkElement, newTextUserIndexMarkEndElement, newTextUserIndexMarkStartElement, newTextVariableGetElement, newTextVariableInputElement, newTextVariableSetElement, newTextWordCountElement, setTextClassNamesAttribute, setTextCondStyleNameAttribute, setTextIdAttribute, setTextStyleNameAttribute, setXhtmlAboutAttribute, setXhtmlContentAttribute, setXhtmlDatatypeAttribute, setXhtmlPropertyAttribute, setXmlIdAttribute

Methods inherited from class org.odftoolkit.odfdom.changes.TextContainingElement

appendTextSelection, getTextSelections

Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement

getAutomaticStyle, getAutomaticStyles, getDocumentStyle, getDocumentStyleName, getOrCreateAutomaticStyles, getOrCreateUnqiueAutomaticStyle, getOrCreateUnqiueAutomaticStyle, getProperties, getProperty, getStrictProperties, getStyleFamily, getStyleName, hasAutomaticStyle, hasDocumentStyle, hasProperty, removeProperty, reuseDocumentStyle, setAttributeNS, setDocumentStyle, setProperties, setProperty, setStyleName

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setUserData

Constructor Details

OdfTextHeading

public OdfTextHeading(OdfFileDom ownerDoc)

OdfTextHeading

public OdfTextHeading(OdfFileDom ownerDoc,
 String styleName)

Creates a new instance of this class with the given style name. If the style name is null or the null string, no style is added.

OdfTextHeading

public OdfTextHeading(OdfFileDom ownerDoc,
 String styleName,
 String content)

Creates an instance of this class with the given styleName and content. If the style name is null or the null string, no style is added. If the content is null or the null string, no content is added.

Parameters:

ownerDoc - the owner document DOM

styleName - the style:style-name value

content - the heading content

Method Details

addContent

public OdfTextHeading addContent(String content)

Add the given content to the paragraph. If the content is null or the null string, no content is added.

Parameters:

content - the heading content

Returns:

the heading object

addContentWhitespace

public OdfTextHeading addContentWhitespace(String content)

Add the given content to the heading. If the content is null or the null string, no content is added. Embedded \n are converted to <text:line-break> elements, and multiple blanks to <text:s

Parameters:

content - the heading content

Returns:

the heading object

addStyledContent

public OdfTextHeading addStyledContent(String styleName,
 String content)

Set a heading to have the given styleName and add the given content. If the style name is null or the null string, no style is added.

Parameters:

styleName - the style:style-name value

content - the heading content

Returns:

the heading object

addStyledContentWhitespace

public OdfTextHeading addStyledContentWhitespace(String styleName,
 String content)

Set a heading to have the given styleName and add the given content. If the style name is null or the null string, no style is added. Embedded \n are converted to <text:line-break> elements, and multiple blanks to <text:s

Parameters:

styleName - the style:style-name value

content - the heading content

Returns:

the heading object

addStyledSpan

public OdfTextHeading addStyledSpan(String styleName,
 String content)

Add a span with the given styleName and content to this heading. If the style name is null or the null string, no span is added. If the content is null or the null string, no span is added.

Parameters:

styleName -

content -

Returns:

the heading object

addStyledSpanWhitespace

public OdfTextHeading addStyledSpanWhitespace(String styleName,
 String content)

Add a span with the given styleName and content to this paragraph. If the style name is null or the null string, no span is added. If the content is null or the null string, no span is added.

Parameters:

styleName -

content -

Returns:

the heading object