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

Class TextNotesConfigurationElement

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.text.TextNotesConfigurationElement

All Implemented Interfaces:

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

public class TextNotesConfigurationElement
extends OdfElement

DOM implementation of OpenDocument element <text:notes-configuration>.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static OdfName	ELEMENT_NAME

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
TextNotesConfigurationElement(OdfFileDom ownerDoc)	Create the instance of TextNotesConfigurationElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
OdfName	getOdfName()	Get the element name
String	getStyleNumFormatAttribute()	Receives the value of the ODFDOM attribute representation StyleNumFormatAttribute , See @style:num-format
Boolean	getStyleNumLetterSyncAttribute()	Receives the value of the ODFDOM attribute representation StyleNumLetterSyncAttribute , See @style:num-letter-sync
String	getStyleNumPrefixAttribute()	Receives the value of the ODFDOM attribute representation StyleNumPrefixAttribute , See @style:num-prefix
String	getStyleNumSuffixAttribute()	Receives the value of the ODFDOM attribute representation StyleNumSuffixAttribute , See @style:num-suffix
String	getTextCitationBodyStyleNameAttribute()	Receives the value of the ODFDOM attribute representation TextCitationBodyStyleNameAttribute , See @text:citation-body-style-name
String	getTextCitationStyleNameAttribute()	Receives the value of the ODFDOM attribute representation TextCitationStyleNameAttribute , See @text:citation-style-name
String	getTextDefaultStyleNameAttribute()	Receives the value of the ODFDOM attribute representation TextDefaultStyleNameAttribute , See @text:default-style-name
String	getTextFootnotesPositionAttribute()	Receives the value of the ODFDOM attribute representation TextFootnotesPositionAttribute , See @text:footnotes-position
String	getTextMasterPageNameAttribute()	Receives the value of the ODFDOM attribute representation TextMasterPageNameAttribute , See @text:master-page-name
String	getTextNoteClassAttribute()	Receives the value of the ODFDOM attribute representation TextNoteClassAttribute , See @text:note-class
String	getTextStartNumberingAtAttribute()	Receives the value of the ODFDOM attribute representation TextStartNumberingAtAttribute , See @text:start-numbering-at
Integer	getTextStartValueAttribute()	Receives the value of the ODFDOM attribute representation TextStartValueAttribute , See @text:start-value
TextNoteContinuationNoticeBackwardElement	newTextNoteContinuationNoticeBackwardElement()	Create child element <text:note-continuation-notice-backward>.
TextNoteContinuationNoticeForwardElement	newTextNoteContinuationNoticeForwardElement()	Create child element <text:note-continuation-notice-forward>.
void	setStyleNumFormatAttribute(String styleNumFormatValue)	Sets the value of ODFDOM attribute representation StyleNumFormatAttribute , See @style:num-format
void	setStyleNumLetterSyncAttribute(Boolean styleNumLetterSyncValue)	Sets the value of ODFDOM attribute representation StyleNumLetterSyncAttribute , See @style:num-letter-sync
void	setStyleNumPrefixAttribute(String styleNumPrefixValue)	Sets the value of ODFDOM attribute representation StyleNumPrefixAttribute , See @style:num-prefix
void	setStyleNumSuffixAttribute(String styleNumSuffixValue)	Sets the value of ODFDOM attribute representation StyleNumSuffixAttribute , See @style:num-suffix
void	setTextCitationBodyStyleNameAttribute(String textCitationBodyStyleNameValue)	Sets the value of ODFDOM attribute representation TextCitationBodyStyleNameAttribute , See @text:citation-body-style-name
void	setTextCitationStyleNameAttribute(String textCitationStyleNameValue)	Sets the value of ODFDOM attribute representation TextCitationStyleNameAttribute , See @text:citation-style-name
void	setTextDefaultStyleNameAttribute(String textDefaultStyleNameValue)	Sets the value of ODFDOM attribute representation TextDefaultStyleNameAttribute , See @text:default-style-name
void	setTextFootnotesPositionAttribute(String textFootnotesPositionValue)	Sets the value of ODFDOM attribute representation TextFootnotesPositionAttribute , See @text:footnotes-position
void	setTextMasterPageNameAttribute(String textMasterPageNameValue)	Sets the value of ODFDOM attribute representation TextMasterPageNameAttribute , See @text:master-page-name
void	setTextNoteClassAttribute(String textNoteClassValue)	Sets the value of ODFDOM attribute representation TextNoteClassAttribute , See @text:note-class
void	setTextStartNumberingAtAttribute(String textStartNumberingAtValue)	Sets the value of ODFDOM attribute representation TextStartNumberingAtAttribute , See @text:start-numbering-at
void	setTextStartValueAttribute(Integer textStartValueValue)	Sets the value of ODFDOM attribute representation TextStartValueAttribute , See @text:start-value

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, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, 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, setAttributeNS, 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

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

TextNotesConfigurationElement

public TextNotesConfigurationElement(OdfFileDom ownerDoc)

Create the instance of TextNotesConfigurationElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Detail

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <text:notes-configuration>.

getStyleNumFormatAttribute

public String getStyleNumFormatAttribute()

Receives the value of the ODFDOM attribute representation StyleNumFormatAttribute , See @style:num-format

Attribute is mandatory.

Returns:

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

setStyleNumFormatAttribute

public void setStyleNumFormatAttribute(String styleNumFormatValue)

Sets the value of ODFDOM attribute representation StyleNumFormatAttribute , See @style:num-format

Parameters:

styleNumFormatValue - The type is String

getStyleNumLetterSyncAttribute

public Boolean getStyleNumLetterSyncAttribute()

Receives the value of the ODFDOM attribute representation StyleNumLetterSyncAttribute , See @style:num-letter-sync

Returns:

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

setStyleNumLetterSyncAttribute

public void setStyleNumLetterSyncAttribute(Boolean styleNumLetterSyncValue)

Sets the value of ODFDOM attribute representation StyleNumLetterSyncAttribute , See @style:num-letter-sync

Parameters:

styleNumLetterSyncValue - The type is Boolean

getStyleNumPrefixAttribute

public String getStyleNumPrefixAttribute()

Receives the value of the ODFDOM attribute representation StyleNumPrefixAttribute , See @style:num-prefix

Returns:

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

setStyleNumPrefixAttribute

public void setStyleNumPrefixAttribute(String styleNumPrefixValue)

Sets the value of ODFDOM attribute representation StyleNumPrefixAttribute , See @style:num-prefix

Parameters:

styleNumPrefixValue - The type is String

getStyleNumSuffixAttribute

public String getStyleNumSuffixAttribute()

Receives the value of the ODFDOM attribute representation StyleNumSuffixAttribute , See @style:num-suffix

Returns:

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

setStyleNumSuffixAttribute

public void setStyleNumSuffixAttribute(String styleNumSuffixValue)

Sets the value of ODFDOM attribute representation StyleNumSuffixAttribute , See @style:num-suffix

Parameters:

styleNumSuffixValue - The type is String

getTextCitationBodyStyleNameAttribute

public String getTextCitationBodyStyleNameAttribute()

Receives the value of the ODFDOM attribute representation TextCitationBodyStyleNameAttribute , See @text:citation-body-style-name

Returns:

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

setTextCitationBodyStyleNameAttribute

public void setTextCitationBodyStyleNameAttribute(String textCitationBodyStyleNameValue)

Sets the value of ODFDOM attribute representation TextCitationBodyStyleNameAttribute , See @text:citation-body-style-name

Parameters:

textCitationBodyStyleNameValue - The type is String

getTextCitationStyleNameAttribute

public String getTextCitationStyleNameAttribute()

Receives the value of the ODFDOM attribute representation TextCitationStyleNameAttribute , See @text:citation-style-name

Returns:

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

setTextCitationStyleNameAttribute

public void setTextCitationStyleNameAttribute(String textCitationStyleNameValue)

Sets the value of ODFDOM attribute representation TextCitationStyleNameAttribute , See @text:citation-style-name

Parameters:

textCitationStyleNameValue - The type is String

getTextDefaultStyleNameAttribute

public String getTextDefaultStyleNameAttribute()

Receives the value of the ODFDOM attribute representation TextDefaultStyleNameAttribute , See @text:default-style-name

Returns:

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

setTextDefaultStyleNameAttribute

public void setTextDefaultStyleNameAttribute(String textDefaultStyleNameValue)

Sets the value of ODFDOM attribute representation TextDefaultStyleNameAttribute , See @text:default-style-name

Parameters:

textDefaultStyleNameValue - The type is String

getTextFootnotesPositionAttribute

public String getTextFootnotesPositionAttribute()

Receives the value of the ODFDOM attribute representation TextFootnotesPositionAttribute , See @text:footnotes-position

Returns:

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

setTextFootnotesPositionAttribute

public void setTextFootnotesPositionAttribute(String textFootnotesPositionValue)

Sets the value of ODFDOM attribute representation TextFootnotesPositionAttribute , See @text:footnotes-position

Parameters:

textFootnotesPositionValue - The type is String

getTextMasterPageNameAttribute

public String getTextMasterPageNameAttribute()

Receives the value of the ODFDOM attribute representation TextMasterPageNameAttribute , See @text:master-page-name

Returns:

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

setTextMasterPageNameAttribute

public void setTextMasterPageNameAttribute(String textMasterPageNameValue)

Sets the value of ODFDOM attribute representation TextMasterPageNameAttribute , See @text:master-page-name

Parameters:

textMasterPageNameValue - The type is String

getTextNoteClassAttribute

public String getTextNoteClassAttribute()

Receives the value of the ODFDOM attribute representation TextNoteClassAttribute , See @text:note-class

Attribute is mandatory.

Returns:

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

setTextNoteClassAttribute

public void setTextNoteClassAttribute(String textNoteClassValue)

Sets the value of ODFDOM attribute representation TextNoteClassAttribute , See @text:note-class

Parameters:

textNoteClassValue - The type is String

getTextStartNumberingAtAttribute

public String getTextStartNumberingAtAttribute()

Receives the value of the ODFDOM attribute representation TextStartNumberingAtAttribute , See @text:start-numbering-at

Returns:

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

setTextStartNumberingAtAttribute

public void setTextStartNumberingAtAttribute(String textStartNumberingAtValue)

Sets the value of ODFDOM attribute representation TextStartNumberingAtAttribute , See @text:start-numbering-at

Parameters:

textStartNumberingAtValue - The type is String

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

newTextNoteContinuationNoticeBackwardElement

public TextNoteContinuationNoticeBackwardElement newTextNoteContinuationNoticeBackwardElement()

Create child element <text:note-continuation-notice-backward>.

Returns:

the element <text:note-continuation-notice-backward>

newTextNoteContinuationNoticeForwardElement

public TextNoteContinuationNoticeForwardElement newTextNoteContinuationNoticeForwardElement()

Create child element <text:note-continuation-notice-forward>.

Returns:

the element <text:note-continuation-notice-forward>

accept

public void accept(ElementVisitor visitor)

Description copied from class: OdfElement

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