Class TextHElement
java.lang.Object
- All Implemented Interfaces:
Serializable
,Cloneable
,OdfStylePropertySet
,Element
,ElementTraversal
,EventTarget
,Node
,NodeList
,TypeInfo
- Direct Known Subclasses:
OdfTextHeading
DOM implementation of OpenDocument element <text:h>.
- See Also:
-
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ElementVisitor visitor) Accept an visitor instance to allow the visitor to do some operations.Get the element nameReceives the value of the ODFDOM attribute representationTextIsListHeaderAttribute
, See @text:is-list-headerReceives the value of the ODFDOM attribute representationTextOutlineLevelAttribute
, See @text:outline-levelReceives the value of the ODFDOM attribute representationTextRestartNumberingAttribute
, See @text:restart-numberingReceives the value of the ODFDOM attribute representationTextStartValueAttribute
, See @text:start-valueboolean
void
newTextNode
(String content) Add text content.Create child element <text:number>.protected void
protected void
void
setTextContent
(String content) Replaces all content with given text content.void
setTextIsListHeaderAttribute
(Boolean textIsListHeaderValue) Sets the value of ODFDOM attribute representationTextIsListHeaderAttribute
, See @text:is-list-headervoid
setTextOutlineLevelAttribute
(Integer textOutlineLevelValue) Sets the value of ODFDOM attribute representationTextOutlineLevelAttribute
, See @text:outline-levelvoid
setTextRestartNumberingAttribute
(Boolean textRestartNumberingValue) Sets the value of ODFDOM attribute representationTextRestartNumberingAttribute
, See @text:restart-numberingvoid
setTextStartValueAttribute
(Integer textStartValueValue) Sets the value of ODFDOM attribute representationTextStartValueAttribute
, See @text:start-valuesplit
(int posStart) Splitting the element at the given position into two halvesMethods 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
-
Field Details
-
ELEMENT_NAME
-
-
Constructor Details
-
TextHElement
Create the instance ofTextHElement
- Parameters:
ownerDoc
- The type isOdfFileDom
-
-
Method Details
-
getOdfName
Get the element name- Overrides:
getOdfName
in classTextContainingElement
- Returns:
- return
OdfName
the name of element <text:h>.
-
getTextIsListHeaderAttribute
Receives the value of the ODFDOM attribute representationTextIsListHeaderAttribute
, See @text:is-list-header- Returns:
- - the
Boolean
, the value ornull
, if the attribute is not set and no default value defined.
-
setTextIsListHeaderAttribute
Sets the value of ODFDOM attribute representationTextIsListHeaderAttribute
, See @text:is-list-header- Parameters:
textIsListHeaderValue
- The type isBoolean
-
getTextOutlineLevelAttribute
Receives the value of the ODFDOM attribute representationTextOutlineLevelAttribute
, See @text:outline-levelAttribute is mandatory.
- Returns:
- - the
Integer
, the value ornull
, if the attribute is not set and no default value defined.
-
setTextOutlineLevelAttribute
Sets the value of ODFDOM attribute representationTextOutlineLevelAttribute
, See @text:outline-level- Parameters:
textOutlineLevelValue
- The type isInteger
-
getTextRestartNumberingAttribute
Receives the value of the ODFDOM attribute representationTextRestartNumberingAttribute
, See @text:restart-numbering- Returns:
- - the
Boolean
, the value ornull
, if the attribute is not set and no default value defined.
-
setTextRestartNumberingAttribute
Sets the value of ODFDOM attribute representationTextRestartNumberingAttribute
, See @text:restart-numbering- Parameters:
textRestartNumberingValue
- The type isBoolean
-
getTextStartValueAttribute
Receives the value of the ODFDOM attribute representationTextStartValueAttribute
, See @text:start-value- Returns:
- - the
Integer
, the value ornull
, if the attribute is not set and no default value defined.
-
setTextStartValueAttribute
Sets the value of ODFDOM attribute representationTextStartValueAttribute
, See @text:start-value- Parameters:
textStartValueValue
- The type isInteger
-
newTextNumberElement
Create child element <text:number>.- Returns:
- the element <text:number>
-
accept
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 classOdfElement
- Parameters:
visitor
- an instance of DefaultElementVisitor
-
newTextNode
Add text content. Only elements which are allowed to have text content offer this method. -
setTextContent
Replaces all content with given text content. Only elements which are allowed to have text content offer this method.- Specified by:
setTextContent
in interfaceNode
- Overrides:
setTextContent
in classParentNode
- Parameters:
new
- text content to replace the existing children (or removes all if null)
-
onRemoveNode
protected void onRemoveNode()- Overrides:
onRemoveNode
in classOdfStylableElement
-
onInsertNode
protected void onInsertNode()- Overrides:
onInsertNode
in classOdfStylableElement
-
isComponentRoot
public boolean isComponentRoot()- Overrides:
isComponentRoot
in classOdfElement
-
split
Splitting the element at the given position into two halvesIf 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 classOdfElement
- 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
-