Package com.itextpdf.forms.xfdf

Class BorderStyleAltObject

java.lang.Object
com.itextpdf.forms.xfdf.BorderStyleAltObject
public class BorderStyleAltObject extends Object
Represents the BorderStyleAlt element, a child of the link element. Corresponds to the Border key in the common annotation dictionary. Content model: border style encoded in the format specified in the border style attributes. Required attributes: HCornerRadius, VCornerRadius, Width. Optional attributes: DashPattern. For more details see paragraph 6.5.3 in Xfdf document specification. For more details about attributes see paragraph 6.6.19 in Xfdf document specification.

  • Constructor Details

    • BorderStyleAltObject

      public BorderStyleAltObject (float hCornerRadius, float vCornerRadius, float width)
      Creates an instance that encapsulates BorderStyleAlt XFDF element data.
      Parameters:
      hCornerRadius - a float value specifying the horizontal corner radius of the rectangular border.
      vCornerRadius - a float value specifying the vertical corner radius of the rectangular border.
      width - a float value specifying the width of the rectangular border.

  • Method Details

    • getHCornerRadius

      public float getHCornerRadius()
      Gets the horizontal corner radius of the rectangular border. Corresponds to array index 0 in the Border key in the common annotation dictionary.
      Returns:
      a float value specifying the horizontal corner radius.

    • getVCornerRadius

      public float getVCornerRadius()
      Gets the vertical corner radius of the rectangular border. Corresponds to array index 1 in the Border key in the common annotation dictionary.
      Returns:
      a float value specifying the vertical corner radius.

    • getWidth

      public float getWidth()
      Gets the width of the rectangular border. Corresponds to array index 2 in the Border key in the common annotation dictionary.
      Returns:
      a float value specifying the width of the border.

    • getDashPattern

      public float[] getDashPattern()
      Gets the dash pattern of the border. Corresponds to array index 3 in the Border key in the common annotation dictionary.
      Returns:
      an array of numbers specifying the pattern of dashes and gaps of the border.

    • setDashPattern

      public BorderStyleAltObject setDashPattern (float[] dashPattern)
      Sets the dash pattern of the border. Corresponds to array index 3 in the Border key in the common annotation dictionary.
      Parameters:
      dashPattern - an array of numbers specifying the pattern of dashes and gaps of the border.
      Returns:
      this BorderStyleAltObject instance.

    • getContent

      public String getContent()
      Gets border style.
      Returns:
      an encoded border style as string.

    • setContent

      public BorderStyleAltObject setContent (String content)
      Sets border style.
      Parameters:
      content - an encoded border style as string.
      Returns:
      this BorderStyleAltObject instance.