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:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • DrawCaptionElement

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

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

      Child element was added in ODF 1.1

      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>

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