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

Class DOCXTblPr

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

Table Properties Definition.

Represents w:tblPr in xml.

Author:
Jamson Chan

  • Constructor Summary

    Constructors
    Constructor
    Description
    DOCXTblPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPr tblPr, DOCXTbl parent)
    Create a new TableProperties by given CTTblPr.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPr
    getCT()
    Returns the CT object of current element.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STJcTable.Enum
    getJc()
    Returns the table alignment.
    DOCXTbl
    getParent()
    Returns the parent table.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd
    getShd()
    Returns the table shading.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblBorders
    getTblBorders()
    Returns the table borders.
    String
    getTblCaption()
    Returns the table caption.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblCellMar
    getTblCellMar()
    Returns the default table cell margin.
    Double
    getTblCellSpacing()
    Returns the default table cell spacing.
    String
    getTblDescription()
    Returns the table description.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth
    getTblInd()
    Returns the table indent from the leading margin.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblLayoutType.Enum
    getTblLayout()
    Returns the table layout.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblLook
    getTblLook()
    Returns the table style conditional formatting settings.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblOverlap.Enum
    getTblOverlap()
    Returns the floating table allows other tables to overlap.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPPr
    getTblpPr()
    Returns the floating table positioning.
    String
    getTblStyle()
    Returns the referenced table style.
    Long
    getTblStyleColBandSize()
    Returns the number of columns in column band.
    Long
    getTblStyleRowBandSize()
    Returns the number of rows in row band.
    org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth
    getTblW()
    Returns the preferred table width.
    boolean
    isBidiVisual()
    Returns whether the table is visually right to left.
    void
    setBidiVisual(boolean bidiVisual)
    Sets whether the table is visually right to left.
    void
    setJc(org.openxmlformats.schemas.wordprocessingml.x2006.main.STJcTable.Enum jc)
    Sets the table alignment.
    void
    setParent(DOCXTbl parent)
    Sets the parent table.
    void
    setShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd)
    Sets the table shading.
    void
    setTblBorders(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblBorders tblBorders)
    Sets the table borders.
    void
    setTblCaption(String tblCaption)
    Sets the table caption.
    void
    setTblCellMar(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblCellMar tblCellMar)
    Sets the default table cell margin.
    void
    setTblCellSpacing(Double tblCellSpacing)
    Sets the default table cell spacing.
    void
    setTblDescription(String tblDescription)
    Sets the table description.
    void
    setTblInd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tblInd)
    Sets the table indent from the leading margin.
    void
    setTblLayout(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblLayoutType.Enum tblLayout)
    Sets the table layout.
    void
    setTblLook(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblLook tblLook)
    Sets the table style conditional formatting settings.
    void
    setTblOverlap(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblOverlap.Enum tblOverlap)
    Sets the floating table allows other tables to overlap.
    void
    setTblpPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPPr tblpPr)
    Sets the floating table positioning.
    void
    setTblStyle(String tblStyle)
    Sets the referenced table style.
    void
    setTblStyleColBandSize(Long tblStyleColBandSize)
    Sets the number of columns in column band.
    void
    setTblStyleRowBandSize(Long tblStyleRowBandSize)
    Sets the number of rows in row band.
    void
    setTblW(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tblW)
    Sets the preferred table width.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DOCXTblPr

      public DOCXTblPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPr tblPr, DOCXTbl parent)
      Create a new TableProperties by given CTTblPr.
      Parameters:
      tblPr - the CTTblPr object.
      parent - the parent Table object.

  • Method Details

    • getCT

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

    • getParent

      public DOCXTbl getParent()
      Returns the parent table.
      Returns:
      the parent table.

    • setParent

      public void setParent(DOCXTbl parent)
      Sets the parent table.
      Parameters:
      parent - the parent table.

    • isBidiVisual

      public boolean isBidiVisual()
      Returns whether the table is visually right to left.

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

      Returns:
      whether the table is visually right to left.

    • setBidiVisual

      public void setBidiVisual(boolean bidiVisual)
      Sets whether the table is visually right to left.

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

      Parameters:
      bidiVisual - whether the table is visually right to left.

    • getJc

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STJcTable.Enum getJc()
      Returns the table alignment.

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

      Returns:
      the table alignment.

    • setJc

      public void setJc(org.openxmlformats.schemas.wordprocessingml.x2006.main.STJcTable.Enum jc)
      Sets the table alignment.

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

      Parameters:
      jc - the table alignment.

    • getShd

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd getShd()
      Returns the table shading.

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

      Returns:
      the table shading.

    • setShd

      public void setShd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd)
      Sets the table shading.

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

      Parameters:
      shd - the table shading.

    • getTblBorders

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblBorders getTblBorders()
      Returns the table borders.

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

      Returns:
      the table borders.

    • setTblBorders

      public void setTblBorders(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblBorders tblBorders)
      Sets the table borders.

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

      Parameters:
      tblBorders - the table borders.

    • getTblCaption

      public String getTblCaption()
      Returns the table caption.

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

      Returns:
      the table caption.

    • setTblCaption

      public void setTblCaption(String tblCaption)
      Sets the table caption.

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

      Parameters:
      tblCaption - the table caption.

    • getTblCellMar

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblCellMar getTblCellMar()
      Returns the default table cell margin.

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

      Returns:
      the default table cell margin.

    • setTblCellMar

      public void setTblCellMar(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblCellMar tblCellMar)
      Sets the default table cell margin.

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

      Parameters:
      tblCellMar - the default table cell margin.

    • getTblCellSpacing

      public Double getTblCellSpacing()
      Returns the default table cell spacing.

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

      Returns:
      the default table cell spacing.

    • setTblCellSpacing

      public void setTblCellSpacing(Double tblCellSpacing)
      Sets the default table cell spacing.

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

      Parameters:
      tblCellSpacing - the default table cell spacing.

    • getTblDescription

      public String getTblDescription()
      Returns the table description.

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

      Returns:
      the table description.

    • setTblDescription

      public void setTblDescription(String tblDescription)
      Sets the table description.

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

      Parameters:
      tblDescription - the table description.

    • getTblInd

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth getTblInd()
      Returns the table indent from the leading margin.

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

      Returns:
      the table indent from the leading margin.

    • setTblInd

      public void setTblInd(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tblInd)
      Sets the table indent from the leading margin.

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

      Parameters:
      tblInd - the table indent from the leading margin.

    • getTblLayout

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblLayoutType.Enum getTblLayout()
      Returns the table layout.

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

      Returns:
      the table layout.

    • setTblLayout

      public void setTblLayout(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblLayoutType.Enum tblLayout)
      Sets the table layout.

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

      Parameters:
      tblLayout - the table layout.

    • getTblLook

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblLook getTblLook()
      Returns the table style conditional formatting settings.

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

      Returns:
      the table style conditional formatting settings.

    • setTblLook

      public void setTblLook(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblLook tblLook)
      Sets the table style conditional formatting settings.

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

      Parameters:
      tblLook - the table style conditional formatting settings.

    • getTblOverlap

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblOverlap.Enum getTblOverlap()
      Returns the floating table allows other tables to overlap.

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

      Returns:
      the floating table allows other tables to overlap.

    • setTblOverlap

      public void setTblOverlap(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTblOverlap.Enum tblOverlap)
      Sets the floating table allows other tables to overlap.

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

      Parameters:
      tblOverlap - the floating table allows other tables to overlap.

    • getTblpPr

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPPr getTblpPr()
      Returns the floating table positioning.

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

      Returns:
      the floating table positioning.

    • setTblpPr

      public void setTblpPr(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblPPr tblpPr)
      Sets the floating table positioning.

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

      Parameters:
      tblpPr - the floating table positioning.

    • getTblStyle

      public String getTblStyle()
      Returns the referenced table style.

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

      Returns:
      the referenced table style.

    • setTblStyle

      public void setTblStyle(String tblStyle)
      Sets the referenced table style.

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

      Parameters:
      tblStyle - the referenced table style.

    • getTblStyleColBandSize

      public Long getTblStyleColBandSize()
      Returns the number of columns in column band.

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

      Returns:
      the number of columns in column band.

    • setTblStyleColBandSize

      public void setTblStyleColBandSize(Long tblStyleColBandSize)
      Sets the number of columns in column band.

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

      Parameters:
      tblStyleColBandSize - the number of columns in column band.

    • getTblStyleRowBandSize

      public Long getTblStyleRowBandSize()
      Returns the number of rows in row band.

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

      Returns:
      the number of rows in row band.

    • setTblStyleRowBandSize

      public void setTblStyleRowBandSize(Long tblStyleRowBandSize)
      Sets the number of rows in row band.

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

      Parameters:
      tblStyleRowBandSize - the number of rows in row band.

    • getTblW

      public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth getTblW()
      Returns the preferred table width.

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

      Returns:
      the preferred table width.

    • setTblW

      public void setTblW(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tblW)
      Sets the preferred table width.

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

      Parameters:
      tblW - the preferred table width.