Package org.odftoolkit.odfdom.dom.element.draw

Class DrawCaptionElement

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.OdfStyleableShapeElement

org.odftoolkit.odfdom.dom.element.draw.DrawShapeElementBase

org.odftoolkit.odfdom.dom.element.draw.DrawCaptionElement

All Implemented Interfaces:

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

public class DrawCaptionElement
extends DrawShapeElementBase

DOM implementation of OpenDocument element <draw:caption>.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static OdfName	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
DrawCaptionElement(OdfFileDom ownerDoc)	Create the instance of DrawCaptionElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
String	getDrawCaptionIdAttribute()	Receives the value of the ODFDOM attribute representation DrawCaptionIdAttribute , See @draw:caption-id
String	getDrawCaptionPointXAttribute()	Receives the value of the ODFDOM attribute representation DrawCaptionPointXAttribute , See @draw:caption-point-x
String	getDrawCaptionPointYAttribute()	Receives the value of the ODFDOM attribute representation DrawCaptionPointYAttribute , See @draw:caption-point-y
String	getDrawCornerRadiusAttribute()	Receives the value of the ODFDOM attribute representation DrawCornerRadiusAttribute , See @draw:corner-radius
String	getDrawLayerAttribute()	Receives the value of the ODFDOM attribute representation DrawLayerAttribute , See @draw:layer
String	getDrawTextStyleNameAttribute()	Receives the value of the ODFDOM attribute representation DrawTextStyleNameAttribute , See @draw:text-style-name
String	getDrawTransformAttribute()	Receives the value of the ODFDOM attribute representation DrawTransformAttribute , See @draw:transform
OdfName	getOdfName()	Get the element name
String	getSvgHeightAttribute()	Receives the value of the ODFDOM attribute representation SvgHeightAttribute , See @svg:height
String	getSvgWidthAttribute()	Receives the value of the ODFDOM attribute representation SvgWidthAttribute , See @svg:width
String	getSvgXAttribute()	Receives the value of the ODFDOM attribute representation SvgXAttribute , See @svg:x
String	getSvgYAttribute()	Receives the value of the ODFDOM attribute representation SvgYAttribute , See @svg:y
DrawGluePointElement	newDrawGluePointElement(String drawEscapeDirectionValue, String drawIdValue, String svgXValue, String svgYValue)	Create child element <draw:glue-point>.
OfficeEventListenersElement	newOfficeEventListenersElement()	Create child element <office:event-listeners>.
SvgDescElement	newSvgDescElement()	Create child element <svg:desc>.
SvgTitleElement	newSvgTitleElement()	Create child element <svg:title>.
TextListElement	newTextListElement()	Create child element <text:list>.
TextPElement	newTextPElement()	Create child element <text:p>.
void	setDrawCaptionIdAttribute(String drawCaptionIdValue)	Sets the value of ODFDOM attribute representation DrawCaptionIdAttribute , See @draw:caption-id
void	setDrawCaptionPointXAttribute(String drawCaptionPointXValue)	Sets the value of ODFDOM attribute representation DrawCaptionPointXAttribute , See @draw:caption-point-x
void	setDrawCaptionPointYAttribute(String drawCaptionPointYValue)	Sets the value of ODFDOM attribute representation DrawCaptionPointYAttribute , See @draw:caption-point-y
void	setDrawCornerRadiusAttribute(String drawCornerRadiusValue)	Sets the value of ODFDOM attribute representation DrawCornerRadiusAttribute , See @draw:corner-radius
void	setDrawLayerAttribute(String drawLayerValue)	Sets the value of ODFDOM attribute representation DrawLayerAttribute , See @draw:layer
void	setDrawTextStyleNameAttribute(String drawTextStyleNameValue)	Sets the value of ODFDOM attribute representation DrawTextStyleNameAttribute , See @draw:text-style-name
void	setDrawTransformAttribute(String drawTransformValue)	Sets the value of ODFDOM attribute representation DrawTransformAttribute , See @draw:transform
void	setSvgHeightAttribute(String svgHeightValue)	Sets the value of ODFDOM attribute representation SvgHeightAttribute , See @svg:height
void	setSvgWidthAttribute(String svgWidthValue)	Sets the value of ODFDOM attribute representation SvgWidthAttribute , See @svg:width
void	setSvgXAttribute(String svgXValue)	Sets the value of ODFDOM attribute representation SvgXAttribute , See @svg:x
void	setSvgYAttribute(String svgYValue)	Sets the value of ODFDOM attribute representation SvgYAttribute , See @svg:y

Methods inherited from class org.odftoolkit.odfdom.dom.element.draw.DrawShapeElementBase

getDrawClassNamesAttribute, getDrawIdAttribute, getDrawNameAttribute, getDrawStyleNameAttribute, getDrawZIndexAttribute, getPresentationClassNamesAttribute, getPresentationStyleNameAttribute, getTableEndCellAddressAttribute, getTableEndXAttribute, getTableEndYAttribute, getTableTableBackgroundAttribute, getTextAnchorPageNumberAttribute, getTextAnchorTypeAttribute, getXmlIdAttribute, setDrawClassNamesAttribute, setDrawIdAttribute, setDrawNameAttribute, setDrawStyleNameAttribute, setDrawZIndexAttribute, setPresentationClassNamesAttribute, setPresentationStyleNameAttribute, setTableEndCellAddressAttribute, setTableEndXAttribute, setTableEndYAttribute, setTableTableBackgroundAttribute, setTextAnchorPageNumberAttribute, setTextAnchorTypeAttribute, setXmlIdAttribute

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

adjustStyleNameAttrib, setAttributeNodeNS, setAttributeNS

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, 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, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, 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, 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

DrawCaptionElement

public DrawCaptionElement(OdfFileDom ownerDoc)

Create the instance of DrawCaptionElement

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 <draw:caption>.

getDrawCaptionIdAttribute

public String getDrawCaptionIdAttribute()

Receives the value of the ODFDOM attribute representation DrawCaptionIdAttribute , See @draw:caption-id

Returns:

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

setDrawCaptionIdAttribute

public void setDrawCaptionIdAttribute(String drawCaptionIdValue)

Sets the value of ODFDOM attribute representation DrawCaptionIdAttribute , See @draw:caption-id

Parameters:

drawCaptionIdValue - The type is String

getDrawCaptionPointXAttribute

public String getDrawCaptionPointXAttribute()

Receives the value of the ODFDOM attribute representation DrawCaptionPointXAttribute , See @draw:caption-point-x

Returns:

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

setDrawCaptionPointXAttribute

public void setDrawCaptionPointXAttribute(String drawCaptionPointXValue)

Sets the value of ODFDOM attribute representation DrawCaptionPointXAttribute , See @draw:caption-point-x

Parameters:

drawCaptionPointXValue - The type is String

getDrawCaptionPointYAttribute

public String getDrawCaptionPointYAttribute()

Receives the value of the ODFDOM attribute representation DrawCaptionPointYAttribute , See @draw:caption-point-y

Returns:

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

setDrawCaptionPointYAttribute

public void setDrawCaptionPointYAttribute(String drawCaptionPointYValue)

Sets the value of ODFDOM attribute representation DrawCaptionPointYAttribute , See @draw:caption-point-y

Parameters:

drawCaptionPointYValue - The type is String

getDrawCornerRadiusAttribute

public String getDrawCornerRadiusAttribute()

Receives the value of the ODFDOM attribute representation DrawCornerRadiusAttribute , See @draw:corner-radius

Returns:

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

setDrawCornerRadiusAttribute

public void setDrawCornerRadiusAttribute(String drawCornerRadiusValue)

Sets the value of ODFDOM attribute representation DrawCornerRadiusAttribute , See @draw:corner-radius

Parameters:

drawCornerRadiusValue - The type is String

getDrawLayerAttribute

public String getDrawLayerAttribute()

Receives the value of the ODFDOM attribute representation DrawLayerAttribute , See @draw:layer

Returns:

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

setDrawLayerAttribute

public void setDrawLayerAttribute(String drawLayerValue)

Sets the value of ODFDOM attribute representation DrawLayerAttribute , See @draw:layer

Parameters:

drawLayerValue - The type is String

getDrawTextStyleNameAttribute

public String getDrawTextStyleNameAttribute()

Receives the value of the ODFDOM attribute representation DrawTextStyleNameAttribute , See @draw:text-style-name

Returns:

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

setDrawTextStyleNameAttribute

public void setDrawTextStyleNameAttribute(String drawTextStyleNameValue)

Sets the value of ODFDOM attribute representation DrawTextStyleNameAttribute , See @draw:text-style-name

Parameters:

drawTextStyleNameValue - The type is String

getDrawTransformAttribute

public String getDrawTransformAttribute()

Receives the value of the ODFDOM attribute representation DrawTransformAttribute , See @draw:transform

Returns:

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

setDrawTransformAttribute

public void setDrawTransformAttribute(String drawTransformValue)

Sets the value of ODFDOM attribute representation DrawTransformAttribute , See @draw:transform

Parameters:

drawTransformValue - The type is String

getSvgHeightAttribute

public String getSvgHeightAttribute()

Receives the value of the ODFDOM attribute representation SvgHeightAttribute , See @svg:height

Overrides:

getSvgHeightAttribute in class DrawShapeElementBase

Returns:

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

setSvgHeightAttribute

public void setSvgHeightAttribute(String svgHeightValue)

Sets the value of ODFDOM attribute representation SvgHeightAttribute , See @svg:height

Overrides:

setSvgHeightAttribute in class DrawShapeElementBase

Parameters:

svgHeightValue - The type is String

getSvgWidthAttribute

public String getSvgWidthAttribute()

Receives the value of the ODFDOM attribute representation SvgWidthAttribute , See @svg:width

Overrides:

getSvgWidthAttribute in class DrawShapeElementBase

Returns:

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

setSvgWidthAttribute

public void setSvgWidthAttribute(String svgWidthValue)

Sets the value of ODFDOM attribute representation SvgWidthAttribute , See @svg:width

Overrides:

setSvgWidthAttribute in class DrawShapeElementBase

Parameters:

svgWidthValue - The type is String

getSvgXAttribute

public String getSvgXAttribute()

Receives the value of the ODFDOM attribute representation SvgXAttribute , See @svg:x

Overrides:

getSvgXAttribute in class DrawShapeElementBase

Returns:

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

setSvgXAttribute

public void setSvgXAttribute(String svgXValue)

Sets the value of ODFDOM attribute representation SvgXAttribute , See @svg:x

Overrides:

setSvgXAttribute in class DrawShapeElementBase

Parameters:

svgXValue - The type is String

getSvgYAttribute

public String getSvgYAttribute()

Receives the value of the ODFDOM attribute representation SvgYAttribute , See @svg:y

Overrides:

getSvgYAttribute in class DrawShapeElementBase

Returns:

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

setSvgYAttribute

public void setSvgYAttribute(String svgYValue)

Sets the value of ODFDOM attribute representation SvgYAttribute , See @svg:y

Overrides:

setSvgYAttribute in class DrawShapeElementBase

Parameters:

svgYValue - The type is String

newDrawGluePointElement

public DrawGluePointElement newDrawGluePointElement(String drawEscapeDirectionValue,
                                                    String drawIdValue,
                                                    String svgXValue,
                                                    String svgYValue)

Create child element <draw:glue-point>.

Parameters:

drawEscapeDirectionValue - the String value of DrawEscapeDirectionAttribute, see @draw:escape-direction at specification

drawIdValue - the String value of DrawIdAttribute, see @draw:id at specification

svgXValue - the String value of SvgXAttribute, see @svg:x at specification

svgYValue - the String value of SvgYAttribute, see @svg:y at specification

Returns:

the element <draw:glue-point>

newOfficeEventListenersElement

public OfficeEventListenersElement newOfficeEventListenersElement()

Create child element <office:event-listeners>.

Returns:

the element <office:event-listeners>

newSvgDescElement

public SvgDescElement newSvgDescElement()

Create child element <svg:desc>.

Returns:

the element <svg:desc>

newSvgTitleElement

public SvgTitleElement newSvgTitleElement()

Create child element <svg:title>.

Returns:

the element <svg:title>

newTextListElement

public TextListElement newTextListElement()

Create child element <text:list>.

Returns:

the element <text:list>

newTextPElement

public TextPElement newTextPElement()

Create child element <text:p>.

Returns:

the element <text:p>

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