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

Class DrawFrameElement

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.DrawFrameElement
All Implemented Interfaces:
Serializable, Cloneable, OdfStylePropertySet, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
OdfDrawFrame
public class DrawFrameElement extends DrawShapeElementBase
DOM implementation of OpenDocument element <draw:frame>.
See Also:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • DrawFrameElement

      public DrawFrameElement(OdfFileDom ownerDoc)
      Create the instance of DrawFrameElement
      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:frame>.

    • 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

    • getDrawCopyOfAttribute

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

    • setDrawCopyOfAttribute

      public void setDrawCopyOfAttribute(String drawCopyOfValue)
      Sets the value of ODFDOM attribute representation DrawCopyOfAttribute , See @draw:copy-of
      Parameters:
      drawCopyOfValue - 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

    • getPresentationClassAttribute

      public String getPresentationClassAttribute()
      Receives the value of the ODFDOM attribute representation PresentationClassAttribute , See @presentation:class
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setPresentationClassAttribute

      public void setPresentationClassAttribute(String presentationClassValue)
      Sets the value of ODFDOM attribute representation PresentationClassAttribute , See @presentation:class
      Parameters:
      presentationClassValue - The type is String

    • getPresentationPlaceholderAttribute

      public Boolean getPresentationPlaceholderAttribute()
      Receives the value of the ODFDOM attribute representation PresentationPlaceholderAttribute , See @presentation:placeholder
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setPresentationPlaceholderAttribute

      public void setPresentationPlaceholderAttribute(Boolean presentationPlaceholderValue)
      Sets the value of ODFDOM attribute representation PresentationPlaceholderAttribute , See @presentation:placeholder
      Parameters:
      presentationPlaceholderValue - The type is Boolean

    • getPresentationUserTransformedAttribute

      public Boolean getPresentationUserTransformedAttribute()
      Receives the value of the ODFDOM attribute representation PresentationUserTransformedAttribute , See @presentation:user-transformed
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setPresentationUserTransformedAttribute

      public void setPresentationUserTransformedAttribute(Boolean presentationUserTransformedValue)
      Sets the value of ODFDOM attribute representation PresentationUserTransformedAttribute , See @presentation:user-transformed
      Parameters:
      presentationUserTransformedValue - The type is Boolean

    • getStyleRelHeightAttribute

      public String getStyleRelHeightAttribute()
      Receives the value of the ODFDOM attribute representation StyleRelHeightAttribute , See @style:rel-height
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setStyleRelHeightAttribute

      public void setStyleRelHeightAttribute(String styleRelHeightValue)
      Sets the value of ODFDOM attribute representation StyleRelHeightAttribute , See @style:rel-height
      Parameters:
      styleRelHeightValue - The type is String

    • getStyleRelWidthAttribute

      public String getStyleRelWidthAttribute()
      Receives the value of the ODFDOM attribute representation StyleRelWidthAttribute , See @style:rel-width
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setStyleRelWidthAttribute

      public void setStyleRelWidthAttribute(String styleRelWidthValue)
      Sets the value of ODFDOM attribute representation StyleRelWidthAttribute , See @style:rel-width
      Parameters:
      styleRelWidthValue - The type is String

    • getSvgHeightAttribute

      public String getSvgHeightAttribute()
      Receives the value of the ODFDOM attribute representation SvgHeightAttribute , See @svg:height
      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
      Parameters:
      svgHeightValue - The type is String

    • getSvgWidthAttribute

      public String getSvgWidthAttribute()
      Receives the value of the ODFDOM attribute representation SvgWidthAttribute , See @svg:width
      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
      Parameters:
      svgWidthValue - The type is String

    • getSvgXAttribute

      public String getSvgXAttribute()
      Receives the value of the ODFDOM attribute representation SvgXAttribute , See @svg:x
      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
      Parameters:
      svgXValue - The type is String

    • getSvgYAttribute

      public String getSvgYAttribute()
      Receives the value of the ODFDOM attribute representation SvgYAttribute , See @svg:y
      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
      Parameters:
      svgYValue - The type is String

    • newDrawAppletElement

      public DrawAppletElement newDrawAppletElement()
      Create child element <draw:applet>.
      Returns:
      the element <draw:applet>

    • newDrawContourPathElement

      public DrawContourPathElement newDrawContourPathElement(boolean drawRecreateOnEditValue, String svgDValue, int svgViewBoxValue)
      Create child element <draw:contour-path>.
      Parameters:
      drawRecreateOnEditValue - the Boolean value of DrawRecreateOnEditAttribute, see @draw:recreate-on-edit at specification
      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:contour-path>

    • newDrawContourPolygonElement

      public DrawContourPolygonElement newDrawContourPolygonElement(String drawPointsValue, boolean drawRecreateOnEditValue, int svgViewBoxValue)
      Create child element <draw:contour-polygon>.
      Parameters:
      drawPointsValue - the String value of DrawPointsAttribute, see @draw:points at specification
      drawRecreateOnEditValue - the Boolean value of DrawRecreateOnEditAttribute, see @draw:recreate-on-edit at specification
      svgViewBoxValue - the Integer value of SvgViewBoxAttribute, see @svg:viewBox at specification
      Returns:
      the element <draw:contour-polygon>

    • newDrawFloatingFrameElement

      public DrawFloatingFrameElement newDrawFloatingFrameElement(String xlinkHrefValue, String xlinkTypeValue)
      Create child element <draw:floating-frame>.
      Parameters:
      xlinkHrefValue - the String value of XlinkHrefAttribute, see @xlink:href at specification
      xlinkTypeValue - the String value of XlinkTypeAttribute, see @xlink:type at specification
      Returns:
      the element <draw:floating-frame>

    • 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>

    • newDrawImageElement

      public DrawImageElement newDrawImageElement()
      Create child element <draw:image>.
      Returns:
      the element <draw:image>

    • newDrawImageMapElement

      public DrawImageMapElement newDrawImageMapElement()
      Create child element <draw:image-map>.
      Returns:
      the element <draw:image-map>

    • newDrawObjectElement

      public DrawObjectElement newDrawObjectElement()
      Create child element <draw:object>.
      Returns:
      the element <draw:object>

    • newDrawObjectOleElement

      public DrawObjectOleElement newDrawObjectOleElement()
      Create child element <draw:object-ole>.
      Returns:
      the element <draw:object-ole>

    • newDrawPluginElement

      public DrawPluginElement newDrawPluginElement(String xlinkHrefValue, String xlinkTypeValue)
      Create child element <draw:plugin>.
      Parameters:
      xlinkHrefValue - the String value of XlinkHrefAttribute, see @xlink:href at specification
      xlinkTypeValue - the String value of XlinkTypeAttribute, see @xlink:type at specification
      Returns:
      the element <draw:plugin>

    • newDrawTextBoxElement

      public DrawTextBoxElement newDrawTextBoxElement()
      Create child element <draw:text-box>.
      Returns:
      the element <draw:text-box>

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

      Child element was added in ODF 1.1

      Returns:
      the element <svg:title>

    • newTableTableElement

      public TableTableElement newTableTableElement()
      Create child element <table:table>.

      Child element was added in ODF 1.2

      Returns:
      the element <table:table>

    • 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