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

Class OdfTextSpan

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.dom.element.text.TextSpanElement

org.odftoolkit.odfdom.incubator.doc.text.OdfTextSpan

All Implemented Interfaces:

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

public class OdfTextSpan
extends TextSpanElement

Convenient functionality for the parent ODF OpenDocument element

See Also:

Serialized Form

Field Summary

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

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
OdfTextSpan(OdfFileDom ownerDoc)
OdfTextSpan(OdfFileDom ownerDoc, String styleName)	Creates a new instance of this class with the given style name.
OdfTextSpan(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
OdfTextSpan	addContent(String content)	Add the given content to the paragraph.
OdfTextSpan	addContentWhitespace(String content)	Add the given content to the paragraph.
OdfTextSpan	addStyledContent(String styleName, String content)	Set a span to have the given styleName and add the given content.
OdfTextSpan	addStyledContentWhitespace(String styleName, String content)	Set a span to have the given styleName and add the given content.

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

accept, getOdfName, getTextClassNamesAttribute, getTextStyleNameAttribute, 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, newTextNode, 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, setTextStyleNameAttribute

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, onInsertNode, onRemoveNode, 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, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, split, 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, setTextContent, 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, setTextContent, setUserData

Constructor Detail

OdfTextSpan

public OdfTextSpan(OdfFileDom ownerDoc)

OdfTextSpan

public OdfTextSpan(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.

Parameters:

ownerDoc - the XML file the Span belongs to

styleName - the name of the style to be applied to the span

OdfTextSpan

public OdfTextSpan(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 span content

Method Detail

addContent

public OdfTextSpan 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 span content

Returns:

the span object

addContentWhitespace

public OdfTextSpan addContentWhitespace(String content)

Add the given content to the paragraph. 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 span content

Returns:

the span object

addStyledContent

public OdfTextSpan addStyledContent(String styleName,
                                    String content)

Set a span 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 span content

Returns:

the span object

addStyledContentWhitespace

public OdfTextSpan addStyledContentWhitespace(String styleName,
                                              String content)

Set a span 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 span content

Returns:

the span object