Package com.independentsoft.office.odf.drawing

Class Caption

java.lang.Object
com.independentsoft.office.odf.drawing.Shape
com.independentsoft.office.odf.drawing.Caption
All Implemented Interfaces:
ICellContent, IContentElement, IIndexContent, IParagraphContent, ITextContent
public class Caption extends Shape
Represents a description attached to a fixed point. It consists of rectangular drawing shape with an additional set of connected lines that connect the rectangle with the fixed point.

  • Constructor Details

  • Method Details

    • add

      public void add​(List list)
      Adds a List object to the content.
      Parameters:
      list - the list

    • add

      public void add​(Paragraph paragraph)
      Adds a Paragraph object to the content.
      Parameters:
      paragraph - the paragraph

    • add

      public void add​(IDrawText drawText)
      Adds a IDrawText object to the content.
      Parameters:
      drawText - the draw text

    • getContentElements

      public List<IContentElement> getContentElements()
      Returns all content elements.
      Specified by:
      getContentElements in interface IContentElement
      Specified by:
      getContentElements in class Shape
      Returns:
      A collection of content elements.

    • getParent

      public IContentElement getParent()
      Returns the parent content element.
      Specified by:
      getParent in interface IContentElement
      Overrides:
      getParent in class Shape
      Returns:
      the parent

    • setParent

      public void setParent​(IContentElement parent)
      Sets the parent content element.
      Specified by:
      setParent in interface IContentElement
      Overrides:
      setParent in class Shape
      Parameters:
      parent - the new parent

    • clone

      public Caption clone()
      Creates a new object that is a deep copy of the current instance.
      Specified by:
      clone in interface ICellContent
      Specified by:
      clone in interface IContentElement
      Specified by:
      clone in interface IIndexContent
      Specified by:
      clone in interface IParagraphContent
      Specified by:
      clone in interface ITextContent
      Specified by:
      clone in class Shape
      Returns:
      A new object that is a copy of this instance.

    • toString

      public String toString()
      Converts the value of the current Caption object to its equivalent string representation.
      Overrides:
      toString in class Object
      Returns:
      the string

    • getContent

      public List<IDrawText> getContent()
      Contains a collection of IDrawText objects.
      Returns:
      the content

    • getEventListeners

      public List<IEventListener> getEventListeners()
      Contains an attachment of an event listener to a drawing shape.
      Returns:
      the event listeners

    • getGluePoints

      public List<GluePoint> getGluePoints()
      Contains the designated point in the area of a drawing object to which a connector shape can connect.
      Returns:
      the glue points

    • getRelativeWidth

      public String getRelativeWidth()
      Gets width of a drawing object as a relative value within a frame.
      Returns:
      the relative width

    • setRelativeWidth

      public void setRelativeWidth​(String relativeWidth)
      Sets width of a drawing object as a relative value within a frame.
      Parameters:
      relativeWidth - the new relative width

    • getRelativeHeight

      public String getRelativeHeight()
      Gets height of a drawing object as a relative value within a frame.
      Returns:
      the relative height

    • setRelativeHeight

      public void setRelativeHeight​(String relativeHeight)
      Sets height of a drawing object as a relative value within a frame.
      Parameters:
      relativeHeight - the new relative height

    • getCornerRadius

      public Size getCornerRadius()
      Gets the radius of the circle used to round off the corners of a caption, rectangle or a text-box.
      Returns:
      the corner radius

    • setCornerRadius

      public void setCornerRadius​(Size cornerRadius)
      Sets the radius of the circle used to round off the corners of a caption, rectangle or a text-box.
      Parameters:
      cornerRadius - the new corner radius

    • getCaptionPointX

      public Size getCaptionPointX()
      Gets the position of a point that is captioned. A set of lines are rendered to that point from the caption area.
      Returns:
      the caption point x

    • setCaptionPointX

      public void setCaptionPointX​(Size captionPointX)
      Sets the position of a point that is captioned. A set of lines are rendered to that point from the caption area.
      Parameters:
      captionPointX - the new caption point x

    • getCaptionPointY

      public Size getCaptionPointY()
      Gets the position of a point that is captioned. A set of lines are rendered to that point from the caption area.
      Returns:
      the caption point y

    • setCaptionPointY

      public void setCaptionPointY​(Size captionPointY)
      Sets the position of a point that is captioned. A set of lines are rendered to that point from the caption area.
      Parameters:
      captionPointY - the new caption point y