org.odftoolkit.odfdom.pkg
Class OdfElement
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
- All Implemented Interfaces:
- Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo
- Direct Known Subclasses:
- AnimAnimateColorElement, AnimAnimateElement, AnimAnimateMotionElement, AnimAnimateTransformElement, AnimAudioElement, AnimCommandElement, AnimIterateElement, AnimParamElement, AnimParElement, AnimSeqElement, AnimSetElement, AnimTransitionFilterElement, ChartCategoriesElement, ChartDataLabelElement, ChartDomainElement, ChartEquationElement, ChartLabelSeparatorElement, ChartSymbolImageElement, ConfigConfigItemElement, ConfigConfigItemMapEntryElement, ConfigConfigItemMapIndexedElement, ConfigConfigItemMapNamedElement, ConfigConfigItemSetElement, DbApplicationConnectionSettingsElement, DbAutoIncrementElement, DbCharacterSetElement, DbColumnDefinitionElement, DbColumnDefinitionsElement, DbColumnElement, DbColumnsElement, DbComponentCollectionElement, DbComponentElement, DbConnectionDataElement, DbConnectionResourceElement, DbDatabaseDescriptionElement, DbDataSourceElement, DbDataSourceSettingElement, DbDataSourceSettingsElement, DbDataSourceSettingValueElement, DbDelimiterElement, DbDriverSettingsElement, DbFileBasedDatabaseElement, DbFilterStatementElement, DbFormsElement, DbIndexColumnElement, DbIndexColumnsElement, DbIndexElement, DbIndicesElement, DbKeyColumnElement, DbKeyColumnsElement, DbKeyElement, DbKeysElement, DbLoginElement, DbOrderStatementElement, DbQueriesElement, DbQueryCollectionElement, DbQueryElement, DbReportsElement, DbSchemaDefinitionElement, DbServerDatabaseElement, DbTableDefinitionElement, DbTableDefinitionsElement, DbTableExcludeFilterElement, DbTableFilterElement, DbTableFilterPatternElement, DbTableIncludeFilterElement, DbTableRepresentationElement, DbTableRepresentationsElement, DbTableSettingElement, DbTableSettingsElement, DbTableTypeElement, DbTableTypeFilterElement, DbUpdateTableElement, DcCreatorElement, DcDateElement, DcDescriptionElement, DcLanguageElement, DcSubjectElement, DcTitleElement, Dr3dLightElement, DrawAElement, DrawAppletElement, DrawAreaCircleElement, DrawAreaPolygonElement, DrawAreaRectangleElement, DrawContourPathElement, DrawContourPolygonElement, DrawEnhancedGeometryElement, DrawEquationElement, DrawFillImageElement, DrawFloatingFrameElement, DrawGluePointElement, DrawGradientElement, DrawHandleElement, DrawHatchElement, DrawImageElement, DrawImageMapElement, DrawLayerElement, DrawLayerSetElement, DrawMarkerElement, DrawObjectElement, DrawObjectOleElement, DrawOpacityElement, DrawParamElement, DrawPluginElement, DrawStrokeDashElement, DrawTextBoxElement, FormButtonElement, FormCheckboxElement, FormColumnElement, FormComboboxElement, FormConnectionResourceElement, FormDateElement, FormFileElement, FormFixedTextElement, FormFormattedTextElement, FormFormElement, FormFrameElement, FormGenericControlElement, FormGridElement, FormHiddenElement, FormImageElement, FormImageFrameElement, FormItemElement, FormListboxElement, FormListPropertyElement, FormListValueElement, FormNumberElement, FormOptionElement, FormPasswordElement, FormPropertiesElement, FormPropertyElement, FormRadioElement, FormTextareaElement, FormTextElement, FormTimeElement, FormValueRangeElement, MathMathElement, MetaAutoReloadElement, MetaCreationDateElement, MetaDateStringElement, MetaDocumentStatisticElement, MetaEditingCyclesElement, MetaEditingDurationElement, MetaGeneratorElement, MetaHyperlinkBehaviourElement, MetaInitialCreatorElement, MetaKeywordElement, MetaPrintDateElement, MetaPrintedByElement, MetaTemplateElement, MetaUserDefinedElement, NumberAmPmElement, NumberBooleanElement, NumberBooleanStyleElement, NumberCurrencyStyleElement, NumberCurrencySymbolElement, NumberDateStyleElement, NumberDayElement, NumberDayOfWeekElement, NumberEmbeddedTextElement, NumberEraElement, NumberFractionElement, NumberHoursElement, NumberMinutesElement, NumberMonthElement, NumberNumberElement, NumberNumberStyleElement, NumberPercentageStyleElement, NumberQuarterElement, NumberScientificNumberElement, NumberSecondsElement, NumberTextContentElement, NumberTextElement, NumberTextStyleElement, NumberTimeStyleElement, NumberWeekOfYearElement, NumberYearElement, OdfAlienElement, OdfContainerElementBase, OdfStylableElement, OdfStylePropertiesBase, OfficeAnnotationEndElement, OfficeBinaryDataElement, OfficeBodyElement, OfficeChangeInfoElement, OfficeChartElement, OfficeDatabaseElement, OfficeDdeSourceElement, OfficeDocumentContentElement, OfficeDocumentElement, OfficeDocumentMetaElement, OfficeDocumentSettingsElement, OfficeDocumentStylesElement, OfficeDrawingElement, OfficeEventListenersElement, OfficeFontFaceDeclsElement, OfficeFormsElement, OfficeImageElement, OfficeMetaElement, OfficePresentationElement, OfficeScriptElement, OfficeScriptsElement, OfficeSettingsElement, OfficeSpreadsheetElement, OfficeTextElement, PresentationAnimationGroupElement, PresentationAnimationsElement, PresentationDateTimeDeclElement, PresentationDateTimeElement, PresentationDimElement, PresentationEventListenerElement, PresentationFooterDeclElement, PresentationFooterElement, PresentationHeaderDeclElement, PresentationHeaderElement, PresentationHideShapeElement, PresentationHideTextElement, PresentationPlaceholderElement, PresentationPlayElement, PresentationSettingsElement, PresentationShowElement, PresentationShowShapeElement, PresentationShowTextElement, PresentationSoundElement, ScriptEventListenerElement, StyleBackgroundImageElement, StyleColumnElement, StyleColumnsElement, StyleColumnSepElement, StyleDefaultPageLayoutElement, StyleFontFaceElement, StyleFooterElement, StyleFooterLeftElement, StyleFootnoteSepElement, StyleHeaderElement, StyleHeaderLeftElement, StyleListLevelLabelAlignmentElement, StyleMapElement, StylePresentationPageLayoutElement, StyleRegionCenterElement, StyleRegionLeftElement, StyleRegionRightElement, StyleTabStopElement, StyleTabStopsElement, SvgDefinitionSrcElement, SvgDescElement, SvgFontFaceFormatElement, SvgFontFaceNameElement, SvgFontFaceSrcElement, SvgFontFaceUriElement, SvgLinearGradientElement, SvgRadialGradientElement, SvgStopElement, SvgTitleElement, TableBackgroundElement, TableCalculationSettingsElement, TableCellAddressElement, TableCellContentChangeElement, TableCellContentDeletionElement, TableCellRangeSourceElement, TableChangeDeletionElement, TableChangeTrackTableCellElement, TableConsolidationElement, TableContentValidationElement, TableContentValidationsElement, TableCutOffsElement, TableDatabaseRangeElement, TableDatabaseRangesElement, TableDatabaseSourceQueryElement, TableDatabaseSourceSqlElement, TableDatabaseSourceTableElement, TableDataPilotDisplayInfoElement, TableDataPilotFieldElement, TableDataPilotFieldReferenceElement, TableDataPilotGroupElement, TableDataPilotGroupMemberElement, TableDataPilotGroupsElement, TableDataPilotLayoutInfoElement, TableDataPilotLevelElement, TableDataPilotMemberElement, TableDataPilotMembersElement, TableDataPilotSortInfoElement, TableDataPilotSubtotalElement, TableDataPilotSubtotalsElement, TableDataPilotTableElement, TableDataPilotTablesElement, TableDdeLinkElement, TableDdeLinksElement, TableDeletionElement, TableDeletionsElement, TableDependenciesElement, TableDependencyElement, TableDescElement, TableDetectiveElement, TableErrorMacroElement, TableErrorMessageElement, TableFilterAndElement, TableFilterConditionElement, TableFilterElement, TableFilterOrElement, TableFilterSetItemElement, TableHelpMessageElement, TableHighlightedRangeElement, TableInsertionCutOffElement, TableInsertionElement, TableIterationElement, TableLabelRangeElement, TableLabelRangesElement, TableMovementCutOffElement, TableMovementElement, TableNamedExpressionElement, TableNamedExpressionsElement, TableNamedRangeElement, TableNullDateElement, TableOperationElement, TablePreviousElement, TableScenarioElement, TableShapesElement, TableSortByElement, TableSortElement, TableSortGroupsElement, TableSourceCellRangeElement, TableSourceRangeAddressElement, TableSourceServiceElement, TableSubtotalFieldElement, TableSubtotalRuleElement, TableSubtotalRulesElement, TableTableColumnGroupElement, TableTableColumnsElement, TableTableHeaderColumnsElement, TableTableHeaderRowsElement, TableTableRowGroupElement, TableTableRowsElement, TableTableSourceElement, TableTableTemplateElement, TableTargetRangeAddressElement, TableTitleElement, TableTrackedChangesElement, TextAlphabeticalIndexAutoMarkFileElement, TextAlphabeticalIndexMarkElement, TextAlphabeticalIndexMarkEndElement, TextAlphabeticalIndexMarkStartElement, TextAlphabeticalIndexSourceElement, TextAuthorInitialsElement, TextAuthorNameElement, TextBibliographyConfigurationElement, TextBibliographyMarkElement, TextBibliographySourceElement, TextBookmarkElement, TextBookmarkEndElement, TextBookmarkRefElement, TextBookmarkStartElement, TextChangedRegionElement, TextChangeElement, TextChangeEndElement, TextChangeStartElement, TextChapterElement, TextCharacterCountElement, TextConditionalTextElement, TextCreationDateElement, TextCreationTimeElement, TextCreatorElement, TextDatabaseDisplayElement, TextDatabaseNameElement, TextDatabaseNextElement, TextDatabaseRowNumberElement, TextDatabaseRowSelectElement, TextDateElement, TextDdeConnectionDeclElement, TextDdeConnectionDeclsElement, TextDdeConnectionElement, TextDeletionElement, TextDescriptionElement, TextEditingCyclesElement, TextEditingDurationElement, TextExecuteMacroElement, TextExpressionElement, TextFileNameElement, TextFormatChangeElement, TextHiddenParagraphElement, TextHiddenTextElement, TextIllustrationIndexSourceElement, TextImageCountElement, TextIndexBodyElement, TextIndexSourceStylesElement, TextInitialCreatorElement, TextInsertionElement, TextKeywordsElement, TextLineBreakElement, TextLinenumberingSeparatorElement, TextListElement, TextListHeaderElement, TextListItemElement, TextMeasureElement, TextMetaElement, TextMetaFieldElement, TextModificationDateElement, TextModificationTimeElement, TextNoteBodyElement, TextNoteCitationElement, TextNoteContinuationNoticeBackwardElement, TextNoteContinuationNoticeForwardElement, TextNoteElement, TextNoteRefElement, TextNotesConfigurationElement, TextNumberElement, TextObjectCountElement, TextObjectIndexSourceElement, TextOutlineStyleElement, TextPageContinuationElement, TextPageCountElement, TextPageElement, TextPageNumberElement, TextPageSequenceElement, TextPageVariableGetElement, TextPageVariableSetElement, TextParagraphCountElement, TextPlaceholderElement, TextPrintDateElement, TextPrintedByElement, TextPrintTimeElement, TextReferenceMarkElement, TextReferenceMarkEndElement, TextReferenceMarkStartElement, TextReferenceRefElement, TextRubyBaseElement, TextScriptElement, TextSectionSourceElement, TextSElement, TextSenderCityElement, TextSenderCompanyElement, TextSenderCountryElement, TextSenderEmailElement, TextSenderFaxElement, TextSenderFirstnameElement, TextSenderInitialsElement, TextSenderLastnameElement, TextSenderPhonePrivateElement, TextSenderPhoneWorkElement, TextSenderPositionElement, TextSenderPostalCodeElement, TextSenderStateOrProvinceElement, TextSenderStreetElement, TextSenderTitleElement, TextSequenceDeclElement, TextSequenceDeclsElement, TextSequenceElement, TextSequenceRefElement, TextSheetNameElement, TextSoftPageBreakElement, TextSortKeyElement, TextSubjectElement, TextTabElement, TextTableCountElement, TextTableFormulaElement, TextTableIndexSourceElement, TextTableOfContentSourceElement, TextTemplateNameElement, TextTextInputElement, TextTimeElement, TextTitleElement, TextTocMarkElement, TextTocMarkEndElement, TextTocMarkStartElement, TextTrackedChangesElement, TextUserDefinedElement, TextUserFieldDeclElement, TextUserFieldDeclsElement, TextUserFieldGetElement, TextUserFieldInputElement, TextUserIndexMarkElement, TextUserIndexMarkEndElement, TextUserIndexMarkStartElement, TextUserIndexSourceElement, TextVariableDeclElement, TextVariableDeclsElement, TextVariableGetElement, TextVariableInputElement, TextVariableSetElement, TextWordCountElement, XformsModelElement
public abstract class OdfElement
- extends ElementNSImpl
- See Also:
- Serialized Form
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 |
Methods inherited from class org.apache.xerces.dom.ElementImpl |
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, 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, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
addEventListener, appendChild, 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 interface org.w3c.dom.Node |
appendChild, compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData |
OdfElement
public OdfElement(OdfFileDom ownerDocument,
String namespaceURI,
String qualifiedName)
throws DOMException
- Creates a new instance of OdfElement
- Throws:
DOMException
OdfElement
public OdfElement(OdfFileDom ownerDocument,
OdfName aName)
throws DOMException
- Creates a new instance of OdfElement
- Throws:
DOMException
getOdfName
public abstract OdfName getOdfName()
getParentAs
protected <T extends OdfElement> T getParentAs(Class<T> clazz)
getAncestorAs
protected <T extends OdfElement> T getAncestorAs(Class<T> clazz)
toString
public String toString()
- Overrides:
toString
in class NodeImpl
setOdfAttributeValue
public void setOdfAttributeValue(OdfName name,
String value)
- Set the value of an ODF attribute by
OdfName
.
- Parameters:
name
- The qualified name of the ODF attribute.value
- The value to be set in String
form
setOdfAttribute
public void setOdfAttribute(OdfAttribute attribute)
- Set an ODF attribute to this element
- Parameters:
attribute
- the attribute to be set
getOdfAttributeValue
public String getOdfAttributeValue(OdfName name)
- Retrieves a value of an ODF attribute by
OdfName
.
- Parameters:
name
- The qualified name of the ODF attribute.
- Returns:
- The value of the attribute as
String
or
null
if the attribute does not exist.
getOdfAttribute
public OdfAttribute getOdfAttribute(OdfName name)
- Retrieves an ODF attribute by
OdfName
.
- Parameters:
name
- The qualified name of the ODF attribute.
- Returns:
- The
OdfAttribute
or null
if the
attribute does not exist.
getOdfAttribute
public OdfAttribute getOdfAttribute(NamespaceName namespace,
String localname)
- Retrieves an ODF attribute by
NamespaceName
, and local name.
- Parameters:
namespace
- The namespace of the ODF attribute.localname
- The local name of the ODF attribute.
- Returns:
- The
OdfAttribute
or null
if the
attribute does not exist.
hasOdfAttribute
public boolean hasOdfAttribute(OdfName name)
- Determines if an ODF attribute exists.
- Parameters:
name
- The qualified name of the ODF attribute.
- Returns:
- True if the attribute exists.
findFirstChildNode
public static <T extends OdfElement> T findFirstChildNode(Class<T> clazz,
Node parentNode)
- returns the first child node that implements the given class.
- Type Parameters:
T
- The type of the ODF element to be found.- Parameters:
clazz
- is a class that extends OdfElement.parentNode
- is the parent O of the children to be found.
- Returns:
- the first child node of the given parentNode that is a clazz or
null if none is found.
findNextChildNode
public static <T extends OdfElement> T findNextChildNode(Class<T> clazz,
Node refNode)
- returns the first sibling after the given reference node that implements
the given class.
- Type Parameters:
T
- The type of the ODF element to be found.- Parameters:
clazz
- is a class that extends OdfElement.refNode
- the reference node of the siblings to be found.
- Returns:
- the first sibbling of the given reference node that is a clazz or
null if none is found.
findPreviousChildNode
public static <T extends OdfElement> T findPreviousChildNode(Class<T> clazz,
Node refNode)
- returns the first previous sibling before the given reference node that
implements the given class.
- Parameters:
clazz
- is a class that extends OdfElement.refNode
- the reference node which siblings are to be searched.
- Returns:
- the first previous sibbling of the given reference node that is a
clazz or null if none is found.
cloneNode
public Node cloneNode(boolean deep)
- Specified by:
cloneNode
in interface Node
- Overrides:
cloneNode
in class ElementImpl
equals
public boolean equals(Object obj)
- indicates if some other object is equal to this one.
- Overrides:
equals
in class Object
- Parameters:
obj
- - the reference object with which to compare.
- Returns:
- true if this object is the same as the obj argument; false
otherwise.
onRemoveNode
protected void onRemoveNode(Node node)
onInsertNode
protected void onInsertNode(Node node)
onRemoveNode
protected void onRemoveNode()
onInsertNode
protected void onInsertNode()
insertBefore
public Node insertBefore(Node newChild,
Node refChild)
throws DOMException
- Specified by:
insertBefore
in interface Node
- Overrides:
insertBefore
in class ParentNode
- Throws:
DOMException
removeChild
public Node removeChild(Node oldChild)
throws DOMException
- Specified by:
removeChild
in interface Node
- Overrides:
removeChild
in class ParentNode
- Throws:
DOMException
replaceChild
public Node replaceChild(Node newChild,
Node oldChild)
throws DOMException
- Specified by:
replaceChild
in interface Node
- Overrides:
replaceChild
in class ParentNode
- Throws:
DOMException
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.
- Parameters:
visitor
- an instance of DefaultElementVisitor
Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.