org.odftoolkit.odfdom.dom.element.draw
Class OdfFrameElement

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.dom.element.OdfElement
                          org.odftoolkit.odfdom.dom.element.OdfStylableElement
                              org.odftoolkit.odfdom.dom.element.OdfStyleablePresentationElement
                                  org.odftoolkit.odfdom.dom.element.draw.OdfShapeElementBase
                                      org.odftoolkit.odfdom.dom.element.draw.OdfFrameElement

All Implemented Interfaces:

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

Direct Known Subclasses:

OdfFrame

public abstract class OdfFrameElement
extends OdfShapeElementBase

DOM implementation of OpenDocument element draw:frame.

See Also:

Serialized Form

Field Summary

static OdfName

ELEMENT_NAME

Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement

mFamily, mStyleNameAttrib

Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfElement

mOdfDocument

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

OdfFrameElement(OdfFileDom aOwnerDoc)
Create the instance of OdfFrameElement

Method Summary

OdfAppletElement	createAppletElement() Create child element draw:applet.
OdfContourPathElement	createContourPathElement(OdfBoolean recreateOnEdit, Integer viewBox, String d) Create child element draw:contour-path.
OdfContourPolygonElement	createContourPolygonElement(OdfBoolean recreateOnEdit, Integer viewBox, String points) Create child element draw:contour-polygon.
OdfDescElement	createDescElement() Create child element svg:desc.
OdfEventListenersElement	createEventListenersElement() Create child element office:event-listeners.
OdfFloatingFrameElement	createFloatingFrameElement() Create child element draw:floating-frame.
OdfGluePointElement	createGluePointElement(OdfNonNegativeInteger drawid, OdfLength x, OdfLength y, OdfEscapeDirectionType escapeDirection) Create child element draw:glue-point.
OdfImageElement	createImageElement() Create child element draw:image.
OdfImageMapElement	createImageMapElement() Create child element draw:image-map.
OdfObjectElement	createObjectElement() Create child element draw:object.
OdfObjectOleElement	createObjectOleElement() Create child element draw:object-ole.
OdfPluginElement	createPluginElement() Create child element draw:plugin.
OdfTableElement	createTableElement() Create child element table:table.
OdfTextBoxElement	createTextBoxElement() Create child element draw:text-box.
OdfTitleElement	createTitleElement() Create child element svg:title.
OdfId	getCaptionId() Get value of attribute draw:caption-id.
String	getCopyOf() Get value of attribute draw:copy-of.
OdfLength	getHeight() Get value of attribute svg:height.
String	getLayer() Get value of attribute draw:layer.
OdfName	getOdfName() Get the element name
OdfBoolean	getPlaceholder() Get value of attribute presentation:placeholder.
OdfPresentationClasses	getPresentationClass() Get value of attribute presentation:class.
OdfPercent	getRelHeight() Get value of attribute style:rel-height.
OdfPercent	getRelWidth() Get value of attribute style:rel-width.
String	getTextStyleName() Get value of attribute draw:text-style-name.
String	getTransform() Get value of attribute draw:transform.
OdfBoolean	getUserTransformed() Get value of attribute presentation:user-transformed.
OdfLength	getWidth() Get value of attribute svg:width.
OdfLength	getX() Get value of attribute svg:x.
OdfLength	getY() Get value of attribute svg:y.
void	setCaptionId(OdfId captionId) Set value of attribute draw:caption-id.
void	setCopyOf(String copyOf) Set value of attribute draw:copy-of.
void	setHeight(OdfLength height) Set value of attribute svg:height.
void	setLayer(String layer) Set value of attribute draw:layer.
void	setPlaceholder(OdfBoolean isPlaceholder) Set value of attribute presentation:placeholder.
void	setPresentationClass(OdfPresentationClasses presentationClass) Set value of attribute presentation:class.
void	setRelHeight(OdfPercent relHeight) Set value of attribute style:rel-height.
void	setRelWidth(OdfPercent relWidth) Set value of attribute style:rel-width.
void	setTextStyleName(OdfStyleNameRef textStyleName) Set value of attribute draw:text-style-name.
void	setTransform(String transform) Set value of attribute draw:transform.
void	setUserTransformed(OdfBoolean isUserTransformed) Set value of attribute presentation:user-transformed.
void	setWidth(OdfLength width) Set value of attribute svg:width.
void	setX(OdfLength x) Set value of attribute svg:x.
void	setY(OdfLength y) Set value of attribute svg:y.

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

getAnchorPageNumber, getAnchorType, getDrawClassNames, getDrawid, getDrawStyleName, getEndCellAddress, getEndX, getEndY, getName, getPresentationClassNames, getPresentationStyleName, getTableBackground, getXmlid, getZIndex, init, setAnchorPageNumber, setAnchorType, setDrawClassNames, setDrawid, setDrawStyleName, setEndCellAddress, setEndX, setEndY, setName, setPresentationClassNames, setPresentationStyleName, setTableBackground, setXmlid, setZIndex

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

setAttributeNS

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

getAutomaticStyle, getAutomaticStyles, getDocumentStyle, getOrCreateUnqiueAutomaticStyle, getProperties, getProperty, getStrictProperties, getStyleFamily, getStyleName, hasAutomaticStyle, hasDocumentStyle, hasProperty, onInsertNode, onRemoveNode, removeProperty, reuseDocumentStyle, setDocumentStyle, setProperties, setProperty, setStyleName

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

cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues

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, 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.ChildNode

getNextSibling, getParentNode, getPreviousSibling

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 class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

OdfFrameElement

public OdfFrameElement(OdfFileDom aOwnerDoc)

Create the instance of OdfFrameElement

Parameters:

aOwnerDoc - The type is OdfFileDom

Method Detail

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return the name of element draw:frame.

getLayer

public String getLayer()

Get value of attribute draw:layer.

Returns:

return the attribute which type is String

setLayer

public void setLayer(String layer)

Set value of attribute draw:layer.

Parameters:

layer - the attribute's type is String

getTransform

public String getTransform()

Get value of attribute draw:transform.

Returns:

return the attribute which type is String

setTransform

public void setTransform(String transform)

Set value of attribute draw:transform.

Parameters:

transform - the attribute's type is String

getTextStyleName

public String getTextStyleName()

Get value of attribute draw:text-style-name.

Returns:

return the attribute which type is String

setTextStyleName

public void setTextStyleName(OdfStyleNameRef textStyleName)

Set value of attribute draw:text-style-name.

Parameters:

textStyleName - the attribute's type is OdfStyleNameRef

getX

public OdfLength getX()

Get value of attribute svg:x.

Returns:

return the attribute which type is OdfLength

setX

public void setX(OdfLength x)

Set value of attribute svg:x.

Parameters:

x - the attribute's type is OdfLength

getY

public OdfLength getY()

Get value of attribute svg:y.

Returns:

return the attribute which type is OdfLength

setY

public void setY(OdfLength y)

Set value of attribute svg:y.

Parameters:

y - the attribute's type is OdfLength

getWidth

public OdfLength getWidth()

Get value of attribute svg:width.

Returns:

return the attribute which type is OdfLength

setWidth

public void setWidth(OdfLength width)

Set value of attribute svg:width.

Parameters:

width - the attribute's type is OdfLength

getHeight

public OdfLength getHeight()

Get value of attribute svg:height.

Returns:

return the attribute which type is OdfLength

setHeight

public void setHeight(OdfLength height)

Set value of attribute svg:height.

Parameters:

height - the attribute's type is OdfLength

getRelWidth

public OdfPercent getRelWidth()

Get value of attribute style:rel-width.

Returns:

return the attribute which type is OdfPercent

setRelWidth

public void setRelWidth(OdfPercent relWidth)

Set value of attribute style:rel-width.

Parameters:

relWidth - the attribute's type is OdfPercent

getRelHeight

public OdfPercent getRelHeight()

Get value of attribute style:rel-height.

Returns:

return the attribute which type is OdfPercent

setRelHeight

public void setRelHeight(OdfPercent relHeight)

Set value of attribute style:rel-height.

Parameters:

relHeight - the attribute's type is OdfPercent

getCaptionId

public OdfId getCaptionId()

Get value of attribute draw:caption-id.

Returns:

return the attribute which type is OdfId

setCaptionId

public void setCaptionId(OdfId captionId)

Set value of attribute draw:caption-id.

Parameters:

captionId - the attribute's type is OdfId

getPresentationClass

public OdfPresentationClasses getPresentationClass()

Get value of attribute presentation:class.

Returns:

return the attribute which type is OdfPresentationClasses

setPresentationClass

public void setPresentationClass(OdfPresentationClasses presentationClass)

Set value of attribute presentation:class.

Parameters:

presentationClass - the attribute's type is OdfPresentationClasses

getPlaceholder

public OdfBoolean getPlaceholder()

Get value of attribute presentation:placeholder.

Returns:

return the attribute which type is OdfBoolean

setPlaceholder

public void setPlaceholder(OdfBoolean isPlaceholder)

Set value of attribute presentation:placeholder.

Parameters:

isPlaceholder - the attribute's type is OdfBoolean

getUserTransformed

public OdfBoolean getUserTransformed()

Get value of attribute presentation:user-transformed.

Returns:

return the attribute which type is OdfBoolean

setUserTransformed

public void setUserTransformed(OdfBoolean isUserTransformed)

Set value of attribute presentation:user-transformed.

Parameters:

isUserTransformed - the attribute's type is OdfBoolean

getCopyOf

public String getCopyOf()

Get value of attribute draw:copy-of.

Returns:

return the attribute which type is String

setCopyOf

public void setCopyOf(String copyOf)

Set value of attribute draw:copy-of.

Parameters:

copyOf - the attribute's type is String

createTextBoxElement

public OdfTextBoxElement createTextBoxElement()

Create child element draw:text-box.

Returns:

return the element draw:text-box

createImageElement

public OdfImageElement createImageElement()

Create child element draw:image.

Returns:

return the element draw:image

createObjectElement

public OdfObjectElement createObjectElement()

Create child element draw:object.

Returns:

return the element draw:object

createObjectOleElement

public OdfObjectOleElement createObjectOleElement()

Create child element draw:object-ole.

Returns:

return the element draw:object-ole

createAppletElement

public OdfAppletElement createAppletElement()

Create child element draw:applet.

Returns:

return the element draw:applet

createFloatingFrameElement

public OdfFloatingFrameElement createFloatingFrameElement()

Create child element draw:floating-frame.

Returns:

return the element draw:floating-frame

createPluginElement

public OdfPluginElement createPluginElement()

Create child element draw:plugin.

Returns:

return the element draw:plugin

createTableElement

public OdfTableElement createTableElement()

Create child element table:table.

Returns:

return the element table:table

createEventListenersElement

public OdfEventListenersElement createEventListenersElement()

Create child element office:event-listeners.

Returns:

return the element office:event-listeners

createGluePointElement

public OdfGluePointElement createGluePointElement(OdfNonNegativeInteger drawid,
                                                  OdfLength x,
                                                  OdfLength y,
                                                  OdfEscapeDirectionType escapeDirection)

Create child element draw:glue-point.

Parameters:

drawid - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfNonNegativeInteger

x - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength

y - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength

escapeDirection - the attribute's type is OdfEscapeDirectionType, see draw:escape-direction at specification

Returns:

return the element draw:glue-point

createImageMapElement

public OdfImageMapElement createImageMapElement()

Create child element draw:image-map.

Returns:

return the element draw:image-map

createTitleElement

public OdfTitleElement createTitleElement()

Create child element svg:title.

Returns:

return the element svg:title

createDescElement

public OdfDescElement createDescElement()

Create child element svg:desc.

Returns:

return the element svg:desc

createContourPolygonElement

public OdfContourPolygonElement createContourPolygonElement(OdfBoolean recreateOnEdit,
                                                            Integer viewBox,
                                                            String points)

Create child element draw:contour-polygon.

Parameters:

recreateOnEdit - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfBoolean

viewBox - Integer

points - String

Returns:

return the element draw:contour-polygon

createContourPathElement

public OdfContourPathElement createContourPathElement(OdfBoolean recreateOnEdit,
                                                      Integer viewBox,
                                                      String d)

Create child element draw:contour-path.

Parameters:

recreateOnEdit - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfBoolean

viewBox - Integer

d - String

Returns:

return the element draw:contour-path