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

Class DrawPageElement

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.draw.DrawPageElement
All Implemented Interfaces:
Serializable, Cloneable, OdfStylePropertySet, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class DrawPageElement extends OdfStylableElement
DOM implementation of OpenDocument element <draw:page>.
See Also:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • DrawPageElement

      public DrawPageElement(OdfFileDom ownerDoc)
      Create the instance of DrawPageElement
      Parameters:
      ownerDoc - The type is OdfFileDom

  • Method Details

    • getOdfName

      public OdfName getOdfName()
      Get the element name
      Specified by:
      getOdfName in class OdfElement
      Returns:
      return OdfName the name of element <draw:page>.

    • getDrawIdAttribute

      public String getDrawIdAttribute()
      Receives the value of the ODFDOM attribute representation DrawIdAttribute , See @draw:id
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setDrawIdAttribute

      public void setDrawIdAttribute(String drawIdValue)
      Sets the value of ODFDOM attribute representation DrawIdAttribute , See @draw:id
      Parameters:
      drawIdValue - The type is String

    • getDrawMasterPageNameAttribute

      public String getDrawMasterPageNameAttribute()
      Receives the value of the ODFDOM attribute representation DrawMasterPageNameAttribute , See @draw:master-page-name

      Attribute is mandatory.

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

    • setDrawMasterPageNameAttribute

      public void setDrawMasterPageNameAttribute(String drawMasterPageNameValue)
      Sets the value of ODFDOM attribute representation DrawMasterPageNameAttribute , See @draw:master-page-name
      Parameters:
      drawMasterPageNameValue - The type is String

    • getDrawNameAttribute

      public String getDrawNameAttribute()
      Receives the value of the ODFDOM attribute representation DrawNameAttribute , See @draw:name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setDrawNameAttribute

      public void setDrawNameAttribute(String drawNameValue)
      Sets the value of ODFDOM attribute representation DrawNameAttribute , See @draw:name
      Parameters:
      drawNameValue - The type is String

    • getDrawNavOrderAttribute

      public String getDrawNavOrderAttribute()
      Receives the value of the ODFDOM attribute representation DrawNavOrderAttribute , See @draw:nav-order
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setDrawNavOrderAttribute

      public void setDrawNavOrderAttribute(String drawNavOrderValue)
      Sets the value of ODFDOM attribute representation DrawNavOrderAttribute , See @draw:nav-order
      Parameters:
      drawNavOrderValue - The type is String

    • getDrawStyleNameAttribute

      public String getDrawStyleNameAttribute()
      Receives the value of the ODFDOM attribute representation DrawStyleNameAttribute , See @draw:style-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setDrawStyleNameAttribute

      public void setDrawStyleNameAttribute(String drawStyleNameValue)
      Sets the value of ODFDOM attribute representation DrawStyleNameAttribute , See @draw:style-name
      Parameters:
      drawStyleNameValue - The type is String

    • getPresentationPresentationPageLayoutNameAttribute

      public String getPresentationPresentationPageLayoutNameAttribute()
      Receives the value of the ODFDOM attribute representation PresentationPresentationPageLayoutNameAttribute , See @presentation:presentation-page-layout-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setPresentationPresentationPageLayoutNameAttribute

      public void setPresentationPresentationPageLayoutNameAttribute(String presentationPresentationPageLayoutNameValue)
      Sets the value of ODFDOM attribute representation PresentationPresentationPageLayoutNameAttribute , See @presentation:presentation-page-layout-name
      Parameters:
      presentationPresentationPageLayoutNameValue - The type is String

    • getPresentationUseDateTimeNameAttribute

      public String getPresentationUseDateTimeNameAttribute()
      Receives the value of the ODFDOM attribute representation PresentationUseDateTimeNameAttribute , See @presentation:use-date-time-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setPresentationUseDateTimeNameAttribute

      public void setPresentationUseDateTimeNameAttribute(String presentationUseDateTimeNameValue)
      Sets the value of ODFDOM attribute representation PresentationUseDateTimeNameAttribute , See @presentation:use-date-time-name
      Parameters:
      presentationUseDateTimeNameValue - The type is String

    • getPresentationUseFooterNameAttribute

      public String getPresentationUseFooterNameAttribute()
      Receives the value of the ODFDOM attribute representation PresentationUseFooterNameAttribute , See @presentation:use-footer-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setPresentationUseFooterNameAttribute

      public void setPresentationUseFooterNameAttribute(String presentationUseFooterNameValue)
      Sets the value of ODFDOM attribute representation PresentationUseFooterNameAttribute , See @presentation:use-footer-name
      Parameters:
      presentationUseFooterNameValue - The type is String

    • getPresentationUseHeaderNameAttribute

      public String getPresentationUseHeaderNameAttribute()
      Receives the value of the ODFDOM attribute representation PresentationUseHeaderNameAttribute , See @presentation:use-header-name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setPresentationUseHeaderNameAttribute

      public void setPresentationUseHeaderNameAttribute(String presentationUseHeaderNameValue)
      Sets the value of ODFDOM attribute representation PresentationUseHeaderNameAttribute , See @presentation:use-header-name
      Parameters:
      presentationUseHeaderNameValue - The type is String

    • getXmlIdAttribute

      public String getXmlIdAttribute()
      Receives the value of the ODFDOM attribute representation XmlIdAttribute , See @xml:id
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setXmlIdAttribute

      public void setXmlIdAttribute(String xmlIdValue)
      Sets the value of ODFDOM attribute representation XmlIdAttribute , See @xml:id
      Parameters:
      xmlIdValue - The type is String

    • newAnimAnimateElement

      public AnimAnimateElement newAnimAnimateElement(String smilAttributeNameValue)
      Create child element <anim:animate>.
      Parameters:
      smilAttributeNameValue - the String value of SmilAttributeNameAttribute , see @smil:attributeName at specification
      Returns:
      the element <anim:animate>

    • newAnimAnimateColorElement

      public AnimAnimateColorElement newAnimAnimateColorElement(String smilAttributeNameValue)
      Create child element <anim:animateColor>.
      Parameters:
      smilAttributeNameValue - the String value of SmilAttributeNameAttribute , see @smil:attributeName at specification
      Returns:
      the element <anim:animateColor>

    • newAnimAnimateMotionElement

      public AnimAnimateMotionElement newAnimAnimateMotionElement(String smilAttributeNameValue)
      Create child element <anim:animateMotion>.
      Parameters:
      smilAttributeNameValue - the String value of SmilAttributeNameAttribute , see @smil:attributeName at specification
      Returns:
      the element <anim:animateMotion>

    • newAnimAnimateTransformElement

      public AnimAnimateTransformElement newAnimAnimateTransformElement(String smilAttributeNameValue, String svgTypeValue)
      Create child element <anim:animateTransform>.
      Parameters:
      smilAttributeNameValue - the String value of SmilAttributeNameAttribute , see @smil:attributeName at specification
      svgTypeValue - the String value of SvgTypeAttribute, see @svg:type at specification
      Returns:
      the element <anim:animateTransform>

    • newAnimAudioElement

      public AnimAudioElement newAnimAudioElement()
      Create child element <anim:audio>.
      Returns:
      the element <anim:audio>

    • newAnimCommandElement

      public AnimCommandElement newAnimCommandElement(String animCommandValue)
      Create child element <anim:command>.
      Parameters:
      animCommandValue - the String value of AnimCommandAttribute, see @anim:command at specification
      Returns:
      the element <anim:command>

    • newAnimIterateElement

      public AnimIterateElement newAnimIterateElement()
      Create child element <anim:iterate>.
      Returns:
      the element <anim:iterate>

    • newAnimParElement

      public AnimParElement newAnimParElement()
      Create child element <anim:par>.
      Returns:
      the element <anim:par>

    • newAnimSeqElement

      public AnimSeqElement newAnimSeqElement()
      Create child element <anim:seq>.
      Returns:
      the element <anim:seq>

    • newAnimSetElement

      public AnimSetElement newAnimSetElement(String smilAttributeNameValue)
      Create child element <anim:set>.
      Parameters:
      smilAttributeNameValue - the String value of SmilAttributeNameAttribute , see @smil:attributeName at specification
      Returns:
      the element <anim:set>

    • newAnimTransitionFilterElement

      public AnimTransitionFilterElement newAnimTransitionFilterElement(String smilTypeValue)
      Create child element <anim:transitionFilter>.
      Parameters:
      smilTypeValue - the String value of SmilTypeAttribute, see @smil:type at specification
      Returns:
      the element <anim:transitionFilter>

    • newDr3dSceneElement

      public Dr3dSceneElement newDr3dSceneElement()
      Create child element <dr3d:scene>.
      Returns:
      the element <dr3d:scene>

    • newDrawAElement

      public DrawAElement newDrawAElement(String xlinkHrefValue, String xlinkTypeValue)
      Create child element <draw:a>.
      Parameters:
      xlinkHrefValue - the String value of XlinkHrefAttribute, see @xlink:href at specification
      xlinkTypeValue - the String value of XlinkTypeAttribute, see @xlink:type at specification Child element was added in ODF 1.2
      Returns:
      the element <draw:a>

    • newDrawCaptionElement

      public DrawCaptionElement newDrawCaptionElement()
      Create child element <draw:caption>.
      Returns:
      the element <draw:caption>

    • newDrawCircleElement

      public DrawCircleElement newDrawCircleElement()
      Create child element <draw:circle>.
      Returns:
      the element <draw:circle>

    • newDrawConnectorElement

      public DrawConnectorElement newDrawConnectorElement(int svgViewBoxValue)
      Create child element <draw:connector>.
      Parameters:
      svgViewBoxValue - the Integer value of SvgViewBoxAttribute, see @svg:viewBox at specification
      Returns:
      the element <draw:connector>

    • newDrawControlElement

      public DrawControlElement newDrawControlElement(String drawControlValue)
      Create child element <draw:control>.
      Parameters:
      drawControlValue - the String value of DrawControlAttribute, see @draw:control at specification
      Returns:
      the element <draw:control>

    • newDrawCustomShapeElement

      public DrawCustomShapeElement newDrawCustomShapeElement()
      Create child element <draw:custom-shape>.
      Returns:
      the element <draw:custom-shape>

    • newDrawEllipseElement

      public DrawEllipseElement newDrawEllipseElement()
      Create child element <draw:ellipse>.
      Returns:
      the element <draw:ellipse>

    • newDrawFrameElement

      public DrawFrameElement newDrawFrameElement()
      Create child element <draw:frame>.
      Returns:
      the element <draw:frame>

    • newDrawGElement

      public DrawGElement newDrawGElement()
      Create child element <draw:g>.
      Returns:
      the element <draw:g>

    • newDrawLayerSetElement

      public DrawLayerSetElement newDrawLayerSetElement()
      Create child element <draw:layer-set>.

      Child element was added in ODF 1.2

      Returns:
      the element <draw:layer-set>

    • newDrawLineElement

      public DrawLineElement newDrawLineElement(String svgX1Value, String svgX2Value, String svgY1Value, String svgY2Value)
      Create child element <draw:line>.
      Parameters:
      svgX1Value - the String value of SvgX1Attribute, see @svg:x1 at specification
      svgX2Value - the String value of SvgX2Attribute, see @svg:x2 at specification
      svgY1Value - the String value of SvgY1Attribute, see @svg:y1 at specification
      svgY2Value - the String value of SvgY2Attribute, see @svg:y2 at specification
      Returns:
      the element <draw:line>

    • newDrawMeasureElement

      public DrawMeasureElement newDrawMeasureElement(String svgX1Value, String svgX2Value, String svgY1Value, String svgY2Value)
      Create child element <draw:measure>.
      Parameters:
      svgX1Value - the String value of SvgX1Attribute, see @svg:x1 at specification
      svgX2Value - the String value of SvgX2Attribute, see @svg:x2 at specification
      svgY1Value - the String value of SvgY1Attribute, see @svg:y1 at specification
      svgY2Value - the String value of SvgY2Attribute, see @svg:y2 at specification
      Returns:
      the element <draw:measure>

    • newDrawPageThumbnailElement

      public DrawPageThumbnailElement newDrawPageThumbnailElement()
      Create child element <draw:page-thumbnail>.
      Returns:
      the element <draw:page-thumbnail>

    • newDrawPathElement

      public DrawPathElement newDrawPathElement(String svgDValue, int svgViewBoxValue)
      Create child element <draw:path>.
      Parameters:
      svgDValue - the String value of SvgDAttribute, see @svg:d at specification
      svgViewBoxValue - the Integer value of SvgViewBoxAttribute, see @svg:viewBox at specification
      Returns:
      the element <draw:path>

    • newDrawPolygonElement

      public DrawPolygonElement newDrawPolygonElement(String drawPointsValue, int svgViewBoxValue)
      Create child element <draw:polygon>.
      Parameters:
      drawPointsValue - the String value of DrawPointsAttribute, see @draw:points at specification
      svgViewBoxValue - the Integer value of SvgViewBoxAttribute, see @svg:viewBox at specification
      Returns:
      the element <draw:polygon>

    • newDrawPolylineElement

      public DrawPolylineElement newDrawPolylineElement(String drawPointsValue, int svgViewBoxValue)
      Create child element <draw:polyline>.
      Parameters:
      drawPointsValue - the String value of DrawPointsAttribute, see @draw:points at specification
      svgViewBoxValue - the Integer value of SvgViewBoxAttribute, see @svg:viewBox at specification
      Returns:
      the element <draw:polyline>

    • newDrawRectElement

      public DrawRectElement newDrawRectElement()
      Create child element <draw:rect>.
      Returns:
      the element <draw:rect>

    • newDrawRegularPolygonElement

      public DrawRegularPolygonElement newDrawRegularPolygonElement(boolean drawConcaveValue, int drawCornersValue)
      Create child element <draw:regular-polygon>.
      Parameters:
      drawConcaveValue - the Boolean value of DrawConcaveAttribute, see @draw:concave at specification
      drawCornersValue - the Integer value of DrawCornersAttribute, see @draw:corners at specification
      Returns:
      the element <draw:regular-polygon>

    • newOfficeFormsElement

      public OfficeFormsElement newOfficeFormsElement()
      Create child element <office:forms>.
      Returns:
      the element <office:forms>

    • newPresentationAnimationsElement

      public PresentationAnimationsElement newPresentationAnimationsElement()
      Create child element <presentation:animations>.
      Returns:
      the element <presentation:animations>

    • newPresentationNotesElement

      public PresentationNotesElement newPresentationNotesElement()
      Create child element <presentation:notes>.
      Returns:
      the element <presentation:notes>

    • newSvgDescElement

      public SvgDescElement newSvgDescElement()
      Create child element <svg:desc>.

      Child element was added in ODF 1.2

      Returns:
      the element <svg:desc>

    • newSvgTitleElement

      public SvgTitleElement newSvgTitleElement()
      Create child element <svg:title>.

      Child element was added in ODF 1.2

      Returns:
      the element <svg:title>

    • 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.
      Overrides:
      accept in class OdfElement
      Parameters:
      visitor - an instance of DefaultElementVisitor