Package io.keikai.doc.io.schema.docx

Class DOCXBorder

java.lang.Object
io.keikai.doc.io.schema.docx.DOCXBorder
All Implemented Interfaces:
ICTElement
public class DOCXBorder extends Object implements ICTElement
Internal Use Only.

BorderType Definition.

Represents border element in the schema.

Author:
Jamson Chan

  • Constructor Summary

    Constructors
    Constructor
    Description
    DOCXBorder(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder border)
    Create a new BorderType by given CTBorder.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getColor()
    Returns the border color.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder
    getCT()
    Returns the CT object of current element.
    Object
    getFrame()
    Returns whether to create frame effect.
    Object
    getShadow()
    Returns the border shadow.
    Double
    getSpace()
    Returns the border spacing measurement.
    Double
    getSz()
    Returns the border width.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STThemeColor.Enum
    getThemeColor()
    Returns the border theme color.
    byte[]
    getThemeShade()
    Returns the border theme shade.
    byte[]
    getThemeTint()
    Returns the border theme tint.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder.Enum
    getVal()
    Returns the border style.
    void
    setColor(String color)
    Sets the border color.
    void
    setFrame(Object frame)
    Sets whether to create frame effect.
    void
    setShadow(Object shadow)
    Sets the border shadow.
    void
    setSpace(Double space)
    Sets the border spacing measurement.
    void
    setSz(Double sz)
    Sets the border width.
    void
    setThemeColor(org.openxmlformats.schemas.wordprocessingml.x2006.main.STThemeColor.Enum themeColor)
    Sets the border theme color.
    void
    setThemeShade(byte[] themeShade)
    Sets the border theme shade.
    void
    setThemeTint(byte[] themeTint)
    Sets the border theme tint.
    void
    setVal(org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder.Enum val)
    Sets the border style.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DOCXBorder

      public DOCXBorder(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder border)
      Create a new BorderType by given CTBorder.
      Parameters:
      border - the CTBorder object.

  • Method Details

    • getCT

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBorder getCT()
      Description copied from interface: ICTElement
      Returns the CT object of current element.
      Specified by:
      getCT in interface ICTElement

    • getColor

      public String getColor()
      Returns the border color.

      Represents the following element tag in the schema: w:color.

      Returns:
      the border color.

    • setColor

      public void setColor(String color)
      Sets the border color.

      Represents the following element tag in the schema: w:color.

      Parameters:
      color - the border color.

    • getSz

      public Double getSz()
      Returns the border width.

      Represents the following element tag in the schema: w:sz.

      Returns:
      the border width.

    • setSz

      public void setSz(Double sz)
      Sets the border width.

      Represents the following element tag in the schema: w:sz.

      Parameters:
      sz - the border width.

    • getVal

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder.Enum getVal()
      Returns the border style.

      Represents the following element tag in the schema: w:val.

      Returns:
      the border style.

    • setVal

      public void setVal(org.openxmlformats.schemas.wordprocessingml.x2006.main.STBorder.Enum val)
      Sets the border style.

      Represents the following element tag in the schema: w:val.

      Parameters:
      val - the border style.

    • getSpace

      public Double getSpace()
      Returns the border spacing measurement.

      Represents the following element tag in the schema: w:space.

      Returns:
      the border spacing measurement.

    • setSpace

      public void setSpace(Double space)
      Sets the border spacing measurement.

      Represents the following element tag in the schema: w:space.

      Parameters:
      space - the border spacing measurement.

    • getFrame

      public Object getFrame()
      Returns whether to create frame effect.

      Represents the following element tag in the schema: w:frame.

      Returns:
      whether to create frame effect.

    • setFrame

      public void setFrame(Object frame)
      Sets whether to create frame effect.

      Represents the following element tag in the schema: w:frame.

      Parameters:
      frame - whether to create frame effect.

    • getShadow

      public Object getShadow()
      Returns the border shadow.

      Represents the following element tag in the schema: w:shadow.

      Returns:
      the border shadow.

    • setShadow

      public void setShadow(Object shadow)
      Sets the border shadow.

      Represents the following element tag in the schema: w:shadow.

      Parameters:
      shadow - the border shadow.

    • getThemeColor

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STThemeColor.Enum getThemeColor()
      Returns the border theme color.

      Represents the following element tag in the schema: w:themeColor.

      Returns:
      the border theme color.

    • setThemeColor

      public void setThemeColor(org.openxmlformats.schemas.wordprocessingml.x2006.main.STThemeColor.Enum themeColor)
      Sets the border theme color.

      Represents the following element tag in the schema: w:themeColor.

      Parameters:
      themeColor - the border theme color.

    • getThemeTint

      public byte[] getThemeTint()
      Returns the border theme tint.

      Represents the following element tag in the schema: w:themeTint.

      Returns:
      the border theme tint.

    • setThemeTint

      public void setThemeTint(byte[] themeTint)
      Sets the border theme tint.

      Represents the following element tag in the schema: w:themeTint.

      Parameters:
      themeTint - the border theme tint.

    • getThemeShade

      public byte[] getThemeShade()
      Returns the border theme shade.

      Represents the following element tag in the schema: w:themeShade.

      Returns:
      the border theme shade.

    • setThemeShade

      public void setThemeShade(byte[] themeShade)
      Sets the border theme shade.

      Represents the following element tag in the schema: w:themeShade.

      Parameters:
      themeShade - the border theme shade.