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

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.odftoolkit.odfdom.dom.element.OdfElement
                          extended by org.odftoolkit.odfdom.dom.element.OdfStylableElement
                              extended by org.odftoolkit.odfdom.dom.element.draw.OdfPageElement
All Implemented Interfaces:
Serializable, Cloneable, OdfStylePropertySet, Element, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
OdfPage

public abstract class OdfPageElement
extends OdfStylableElement

DOM implementation of OpenDocument element draw:page.

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
OdfPageElement(OdfFileDom aOwnerDoc)
          Create the instance of OdfPageElement
 
Method Summary
 OdfAnimateColorElement createAnimateColorElement(String attributeName)
          Create child element anim:animateColor.
 OdfAnimateElement createAnimateElement(String attributeName)
          Create child element anim:animate.
 OdfAnimateMotionElement createAnimateMotionElement(String attributeName)
          Create child element anim:animateMotion.
 OdfAnimateTransformElement createAnimateTransformElement(String attributeName, OdfType type)
          Create child element anim:animateTransform.
 OdfAnimationsElement createAnimationsElement()
          Create child element presentation:animations.
 OdfAudioElement createAudioElement()
          Create child element anim:audio.
 OdfCaptionElement createCaptionElement()
          Create child element draw:caption.
 OdfCircleElement createCircleElement()
          Create child element draw:circle.
 OdfCommandElement createCommandElement(String command)
          Create child element anim:command.
 OdfConnectorElement createConnectorElement(Integer viewBox)
          Create child element draw:connector.
 OdfControlElement createControlElement(OdfId control)
          Create child element draw:control.
 OdfCustomShapeElement createCustomShapeElement()
          Create child element draw:custom-shape.
 OdfDescElement createDescElement()
          Create child element svg:desc.
 OdfHyperlinkElement createdrawHyperlinkElement(OdfAnyURI href)
          Create child element draw:a.
 OdfMeasureElement createdrawMeasureElement(OdfLength x1, OdfLength y1, OdfLength x2, OdfLength y2)
          Create child element draw:measure.
 OdfEllipseElement createEllipseElement()
          Create child element draw:ellipse.
 OdfFormElement createFormElement()
          Create child element form:form.
 OdfFrameElement createFrameElement()
          Create child element draw:frame.
 OdfGroupElement createGroupElement()
          Create child element draw:g.
 OdfIterateElement createIterateElement()
          Create child element anim:iterate.
 OdfLayerSetElement createLayerSetElement()
          Create child element draw:layer-set.
 OdfLineElement createLineElement(OdfLength x1, OdfLength y1, OdfLength x2, OdfLength y2)
          Create child element draw:line.
 OdfModelElement createModelElement()
          Create child element xforms:model.
 OdfNotesElement createNotesElement()
          Create child element presentation:notes.
 OdfPageThumbnailElement createPageThumbnailElement()
          Create child element draw:page-thumbnail.
 OdfParElement createParElement()
          Create child element anim:par.
 OdfPathElement createPathElement(String d, Integer viewBox)
          Create child element draw:path.
 OdfPolygonElement createPolygonElement(String points, Integer viewBox)
          Create child element draw:polygon.
 OdfPolylineElement createPolylineElement(String points, Integer viewBox)
          Create child element draw:polyline.
 OdfRectElement createRectElement()
          Create child element draw:rect.
 OdfRegularPolygonElement createRegularPolygonElement(OdfBoolean concave, OdfPositiveInteger corners)
          Create child element draw:regular-polygon.
 OdfRegularPolygonElement createRegularPolygonElement(OdfPositiveInteger corners, OdfBoolean concave)
          Create child element draw:regular-polygon.
 OdfSceneElement createSceneElement()
          Create child element dr3d:scene.
 OdfSeqElement createSeqElement()
          Create child element anim:seq.
 OdfSetElement createSetElement(String attributeName)
          Create child element anim:set.
 OdfTitleElement createTitleElement()
          Create child element svg:title.
 OdfTransitionFilterElement createTransitionFilterElement(String type)
          Create child element anim:transitionFilter.
 String getDrawid()
          Get value of attribute draw:id.
 String getDrawStyleName()
          Get value of attribute draw:style-name.
 String getMasterPageName()
          Get value of attribute draw:master-page-name.
 String getName()
          Get value of attribute draw:name.
 OdfIdRefs getNavOrder()
          Get value of attribute draw:nav-order.
 OdfName getOdfName()
          Get the element name
 String getPresentationPageLayoutName()
          Get value of attribute presentation:presentation-page-layout-name.
 String getUseDateTimeName()
          Get value of attribute presentation:use-date-time-name.
 String getUseFooterName()
          Get value of attribute presentation:use-footer-name.
 String getUseHeaderName()
          Get value of attribute presentation:use-header-name.
 OdfId getXmlid()
          Get value of attribute xml:id.
 void init(OdfStyleNameRef masterPageName)
          Initialization of the mandatory attributes of OdfPageElement
 void setDrawid(String drawid)
          Set value of attribute draw:id.
 void setDrawStyleName(OdfStyleNameRef drawStyleName)
          Set value of attribute draw:style-name.
 void setMasterPageName(OdfStyleNameRef masterPageName)
          Set value of attribute draw:master-page-name.
 void setName(String name)
          Set value of attribute draw:name.
 void setNavOrder(OdfIdRefs navOrder)
          Set value of attribute draw:nav-order.
 void setPresentationPageLayoutName(OdfStyleNameRef presentationPageLayoutName)
          Set value of attribute presentation:presentation-page-layout-name.
 void setUseDateTimeName(String useDateTimeName)
          Set value of attribute presentation:use-date-time-name.
 void setUseFooterName(String useFooterName)
          Set value of attribute presentation:use-footer-name.
 void setUseHeaderName(String useHeaderName)
          Set value of attribute presentation:use-header-name.
 void setXmlid(OdfId xmlid)
          Set value of attribute xml:id.
 
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, setAttributeNS, 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

OdfPageElement

public OdfPageElement(OdfFileDom aOwnerDoc)
Create the instance of OdfPageElement

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:page.

init

public void init(OdfStyleNameRef masterPageName)
Initialization of the mandatory attributes of OdfPageElement

Parameters:
masterPageName - The mandatory attribute draw:master-page-name"

getUseHeaderName

public String getUseHeaderName()
Get value of attribute presentation:use-header-name.

Returns:
return the attribute which type is String

setUseHeaderName

public void setUseHeaderName(String useHeaderName)
Set value of attribute presentation:use-header-name.

Parameters:
useHeaderName - the attribute's type is String

getUseFooterName

public String getUseFooterName()
Get value of attribute presentation:use-footer-name.

Returns:
return the attribute which type is String

setUseFooterName

public void setUseFooterName(String useFooterName)
Set value of attribute presentation:use-footer-name.

Parameters:
useFooterName - the attribute's type is String

getUseDateTimeName

public String getUseDateTimeName()
Get value of attribute presentation:use-date-time-name.

Returns:
return the attribute which type is String

setUseDateTimeName

public void setUseDateTimeName(String useDateTimeName)
Set value of attribute presentation:use-date-time-name.

Parameters:
useDateTimeName - the attribute's type is String

getName

public String getName()
Get value of attribute draw:name.

Returns:
return the attribute which type is String

setName

public void setName(String name)
Set value of attribute draw:name.

Parameters:
name - the attribute's type is String

getDrawStyleName

public String getDrawStyleName()
Get value of attribute draw:style-name.

Returns:
return the attribute which type is String

setDrawStyleName

public void setDrawStyleName(OdfStyleNameRef drawStyleName)
Set value of attribute draw:style-name.

Parameters:
drawStyleName - the attribute's type is OdfStyleNameRef

getMasterPageName

public String getMasterPageName()
Get value of attribute draw:master-page-name.

Returns:
return the attribute which type is String

setMasterPageName

public void setMasterPageName(OdfStyleNameRef masterPageName)
Set value of attribute draw:master-page-name.

Parameters:
masterPageName - the attribute's type is OdfStyleNameRef

getPresentationPageLayoutName

public String getPresentationPageLayoutName()
Get value of attribute presentation:presentation-page-layout-name.

Returns:
return the attribute which type is String

setPresentationPageLayoutName

public void setPresentationPageLayoutName(OdfStyleNameRef presentationPageLayoutName)
Set value of attribute presentation:presentation-page-layout-name.

Parameters:
presentationPageLayoutName - the attribute's type is OdfStyleNameRef

getDrawid

public String getDrawid()
Get value of attribute draw:id.

Returns:
return the attribute which type is String

setDrawid

public void setDrawid(String drawid)
Set value of attribute draw:id.

Parameters:
drawid - the attribute's type is String

getNavOrder

public OdfIdRefs getNavOrder()
Get value of attribute draw:nav-order.

Returns:
return the attribute which type is OdfIdRefs

setNavOrder

public void setNavOrder(OdfIdRefs navOrder)
Set value of attribute draw:nav-order.

Parameters:
navOrder - the attribute's type is OdfIdRefs

getXmlid

public OdfId getXmlid()
Get value of attribute xml:id.

Returns:
return the attribute which type is OdfId

setXmlid

public void setXmlid(OdfId xmlid)
Set value of attribute xml:id.

Parameters:
xmlid - the attribute's type is OdfId

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

createLayerSetElement

public OdfLayerSetElement createLayerSetElement()
Create child element draw:layer-set.

Returns:
return the element draw:layer-set

createFormElement

public OdfFormElement createFormElement()
Create child element form:form.

Returns:
return the element form:form

createModelElement

public OdfModelElement createModelElement()
Create child element xforms:model.

Returns:
return the element xforms:model

createRectElement

public OdfRectElement createRectElement()
Create child element draw:rect.

Returns:
return the element draw:rect

createLineElement

public OdfLineElement createLineElement(OdfLength x1,
                                        OdfLength y1,
                                        OdfLength x2,
                                        OdfLength y2)
Create child element draw:line.

Parameters:
x1 - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength
y1 - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength
x2 - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength
y2 - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfLength
Returns:
return the element draw:line

createPolylineElement

public OdfPolylineElement createPolylineElement(String points,
                                                Integer viewBox)
Create child element draw:polyline.

Parameters:
points - String
viewBox - Integer
Returns:
return the element draw:polyline

createPolygonElement

public OdfPolygonElement createPolygonElement(String points,
                                              Integer viewBox)
Create child element draw:polygon.

Parameters:
points - String
viewBox - Integer
Returns:
return the element draw:polygon

createRegularPolygonElement

public OdfRegularPolygonElement createRegularPolygonElement(OdfPositiveInteger corners,
                                                            OdfBoolean concave)
Create child element draw:regular-polygon.

Parameters:
corners - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfPositiveInteger
concave - the attribute's type is Boolean
Returns:
return the element draw:regular-polygon

createRegularPolygonElement

public OdfRegularPolygonElement createRegularPolygonElement(OdfBoolean concave,
                                                            OdfPositiveInteger corners)
Create child element draw:regular-polygon.

Parameters:
concave - the attribute's type is Boolean
corners - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfPositiveInteger
Returns:
return the element draw:regular-polygon

createPathElement

public OdfPathElement createPathElement(String d,
                                        Integer viewBox)
Create child element draw:path.

Parameters:
d - String
viewBox - Integer
Returns:
return the element draw:path

createCircleElement

public OdfCircleElement createCircleElement()
Create child element draw:circle.

Returns:
return the element draw:circle

createEllipseElement

public OdfEllipseElement createEllipseElement()
Create child element draw:ellipse.

Returns:
return the element draw:ellipse

createGroupElement

public OdfGroupElement createGroupElement()
Create child element draw:g.

Returns:
return the element draw:g

createPageThumbnailElement

public OdfPageThumbnailElement createPageThumbnailElement()
Create child element draw:page-thumbnail.

Returns:
return the element draw:page-thumbnail

createFrameElement

public OdfFrameElement createFrameElement()
Create child element draw:frame.

Returns:
return the element draw:frame

createdrawMeasureElement

public OdfMeasureElement createdrawMeasureElement(OdfLength x1,
                                                  OdfLength y1,
                                                  OdfLength x2,
                                                  OdfLength y2)
Create child element draw:measure.

Parameters:
x1 - the attribute's type is String
y1 - the attribute's type is String
x2 - the attribute's type is String
y2 - the attribute's type is String
Returns:
return the element draw:measure

createCaptionElement

public OdfCaptionElement createCaptionElement()
Create child element draw:caption.

Returns:
return the element draw:caption

createConnectorElement

public OdfConnectorElement createConnectorElement(Integer viewBox)
Create child element draw:connector.

Parameters:
viewBox - Integer
Returns:
return the element draw:connector

createControlElement

public OdfControlElement createControlElement(OdfId control)
Create child element draw:control.

Parameters:
control - the attribute's type is org.odftoolkit.odfdom.dom.type.OdfId
Returns:
return the element draw:control

createSceneElement

public OdfSceneElement createSceneElement()
Create child element dr3d:scene.

Returns:
return the element dr3d:scene

createCustomShapeElement

public OdfCustomShapeElement createCustomShapeElement()
Create child element draw:custom-shape.

Returns:
return the element draw:custom-shape

createdrawHyperlinkElement

public OdfHyperlinkElement createdrawHyperlinkElement(OdfAnyURI href)
Create child element draw:a.

Parameters:
href - the attribute's type is URI
Returns:
return the element draw:a

createAnimationsElement

public OdfAnimationsElement createAnimationsElement()
Create child element presentation:animations.

Returns:
return the element presentation:animations

createAnimateElement

public OdfAnimateElement createAnimateElement(String attributeName)
Create child element anim:animate.

Parameters:
attributeName - String
Returns:
return the element anim:animate

createSetElement

public OdfSetElement createSetElement(String attributeName)
Create child element anim:set.

Parameters:
attributeName - String
Returns:
return the element anim:set

createAnimateMotionElement

public OdfAnimateMotionElement createAnimateMotionElement(String attributeName)
Create child element anim:animateMotion.

Parameters:
attributeName - String
Returns:
return the element anim:animateMotion

createAnimateColorElement

public OdfAnimateColorElement createAnimateColorElement(String attributeName)
Create child element anim:animateColor.

Parameters:
attributeName - String
Returns:
return the element anim:animateColor

createAnimateTransformElement

public OdfAnimateTransformElement createAnimateTransformElement(String attributeName,
                                                                OdfType type)
Create child element anim:animateTransform.

Parameters:
attributeName - String
type - the attribute's type is OdfType, see svg:type at specification
Returns:
return the element anim:animateTransform

createTransitionFilterElement

public OdfTransitionFilterElement createTransitionFilterElement(String type)
Create child element anim:transitionFilter.

Parameters:
type - String
Returns:
return the element anim:transitionFilter

createParElement

public OdfParElement createParElement()
Create child element anim:par.

Returns:
return the element anim:par

createSeqElement

public OdfSeqElement createSeqElement()
Create child element anim:seq.

Returns:
return the element anim:seq

createIterateElement

public OdfIterateElement createIterateElement()
Create child element anim:iterate.

Returns:
return the element anim:iterate

createAudioElement

public OdfAudioElement createAudioElement()
Create child element anim:audio.

Returns:
return the element anim:audio

createCommandElement

public OdfCommandElement createCommandElement(String command)
Create child element anim:command.

Parameters:
command - String
Returns:
return the element anim:command

createNotesElement

public OdfNotesElement createNotesElement()
Create child element presentation:notes.

Returns:
return the element presentation:notes


Copyright © 2009. All Rights Reserved.