Package net.webpdf.wsclient.openapi

Class MetadataLine

  • public class MetadataLine
extends Object
    Defines a set of attributes for Line annotations.

    • Constructor Detail

      • MetadataLine

        public MetadataLine()

    • Method Detail

      • captionHorizontalOffset

        public MetadataLine captionHorizontalOffset​(Float captionHorizontalOffset)

      • getCaptionHorizontalOffset

        @Nullable
public @Nullable Float getCaptionHorizontalOffset()
        The horizontal offset of the caption's leading letter in relation to it's normal position.
        Returns:
        captionHorizontalOffset

      • setCaptionHorizontalOffset

        public void setCaptionHorizontalOffset​(Float captionHorizontalOffset)

      • captionPositioning

        public MetadataLine captionPositioning​(String captionPositioning)

      • getCaptionPositioning

        @Nullable
public @Nullable String getCaptionPositioning()
        The positioning method for the caption of the line. Possible values are \"Inline\" (superimposed) and \"Top\" (above the line).
        Returns:
        captionPositioning

      • setCaptionPositioning

        public void setCaptionPositioning​(String captionPositioning)

      • captionVerticalOffset

        public MetadataLine captionVerticalOffset​(Float captionVerticalOffset)

      • getCaptionVerticalOffset

        @Nullable
public @Nullable Float getCaptionVerticalOffset()
        The vertical offset of the caption's leading letter in relation to it's normal position.
        Returns:
        captionVerticalOffset

      • setCaptionVerticalOffset

        public void setCaptionVerticalOffset​(Float captionVerticalOffset)

      • getEndStyle

        @Nullable
public @Nullable String getEndStyle()
        Selects the Line ending style at the end of the line. Possible values are: Square, Circle, Diamond, OpenArrow, ClosedArrow, None, Butt, ROpenArrow, RClosedArrow, Slash
        Returns:
        endStyle

      • setEndStyle

        public void setEndStyle​(String endStyle)

      • leaderLineExtensionLength

        public MetadataLine leaderLineExtensionLength​(Float leaderLineExtensionLength)

      • getLeaderLineExtensionLength

        @Nullable
public @Nullable Float getLeaderLineExtensionLength()
        A non-negative number that shall represent the length of leader line extensions that extend from the line proper 180 degrees from the leader lines. (0 = no leader line extensions)
        Returns:
        leaderLineExtensionLength

      • setLeaderLineExtensionLength

        public void setLeaderLineExtensionLength​(Float leaderLineExtensionLength)

      • leaderLineLength

        public MetadataLine leaderLineLength​(Float leaderLineLength)

      • getLeaderLineLength

        @Nullable
public @Nullable Float getLeaderLineLength()
        The length of leader lines that extend from each endpoint of the line perpendicular to the line itself. A positive value shall mean that the leader lines appear in the direction that is clockwise when traversing the line from its starting point to its ending point; a negative value shall indicate the opposite direction.(0 = no leader lines)
        Returns:
        leaderLineLength

      • setLeaderLineLength

        public void setLeaderLineLength​(Float leaderLineLength)

      • leaderLineOffsetLength

        public MetadataLine leaderLineOffsetLength​(Float leaderLineOffsetLength)

      • getLeaderLineOffsetLength

        @Nullable
public @Nullable Float getLeaderLineOffsetLength()
        A non-negative number that shall represent the length of the leader line offset, which is the amount of empty space between the endpoints of the annotation and the beginning of the leader lines.
        Returns:
        leaderLineOffsetLength

      • setLeaderLineOffsetLength

        public void setLeaderLineOffsetLength​(Float leaderLineOffsetLength)

      • getShowCaption

        @Nullable
public @Nullable Boolean getShowCaption()
        When set to true the line shall display a textual caption.
        Returns:
        showCaption

      • setShowCaption

        public void setShowCaption​(Boolean showCaption)

      • getStartStyle

        @Nullable
public @Nullable String getStartStyle()
        Selects the Line ending style at the start of the line.
        Returns:
        startStyle

      • setStartStyle

        public void setStartStyle​(String startStyle)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object