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

Class DOCXTcPr

  • All Implemented Interfaces:
    ICTElement
    public class DOCXTcPr
extends java.lang.Object
implements ICTElement
    Internal Use Only.

    Table Cell Properties Definition.

    Represents w:tcPr in xml.

    Author:
    Jamson Chan

    • Constructor Summary

      Constructors 
      Constructor Description
      DOCXTcPr​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcPr tcPr, DOCXTc parent)
      Create a new TableCellProperties by given CTTcPr.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf getCnfStyle()
      Returns the Table Cell Conditional Formatting.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcPr getCT()
      Returns the CT object of current element.
      java.lang.Integer getGridSpan()
      Returns the grid span.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.STMerge.Enum getHMerge()
      Returns the horizontal merge.
      DOCXTc getParent()
      Returns the parent table cell.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd getShd()
      Returns the shading of the cell.
      DOCXTcBorders getTcBorders()
      Returns the table cell borders.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcMar getTcMar()
      Returns the single table cell margins.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth getTcW()
      Returns the width of the cell.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum getTextDirection()
      Returns the cell text flow direction.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalJc.Enum getVAlign()
      Returns the vertical alignment of the cell.
      org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVMerge getVMerge()
      Returns the vertical merge.
      boolean isHideMark()
      Returns whether to hide the end of cell marker in row height calculation.
      boolean isNoWrap()
      Returns whether to wrap the cell content.
      boolean isTcFitText()
      Returns whether to fit text within cell.
      void setCnfStyle​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf cnfStyle)
      Sets the Table Cell Conditional Formatting.
      void setGridSpan​(java.lang.Integer gridSpan)
      Sets the grid span.
      void setHideMark​(boolean hideMark)
      Sets whether to hide the end of cell marker in row height calculation.
      void setHMerge​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STMerge.Enum hMerge)
      Sets the horizontal merge.
      void setNoWrap​(boolean noWrap)
      Sets whether to wrap the cell content.
      void setParent​(DOCXTc parent)
      Sets the parent table cell.
      void setShd​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTShd shd)
      Sets the shading of the cell.
      void setTcBorders​(DOCXTcBorders tcBorders)
      Sets the table cell borders.
      void setTcFitText​(boolean tcFitText)
      Sets whether to fit text within cell.
      void setTcMar​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcMar tcMar)
      Sets the single table cell margins.
      void setTcW​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tcW)
      Sets the width of the cell.
      void setTextDirection​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum textDirection)
      Sets the cell text flow direction.
      void setVAlign​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalJc.Enum vAlign)
      Sets the vertical alignment of the cell.
      void setVMerge​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVMerge vMerge)
      Sets the vertical merge.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DOCXTcPr

        public DOCXTcPr​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcPr tcPr,
                DOCXTc parent)
        Create a new TableCellProperties by given CTTcPr.
        Parameters:
        tcPr - the CTTcPr object.
        parent - the parent TableCell object.

    • Method Detail

      • getCT

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

      • getParent

        public DOCXTc getParent()
        Returns the parent table cell.
        Returns:
        the parent table cell.

      • setParent

        public void setParent​(DOCXTc parent)
        Sets the parent table cell.
        Parameters:
        parent - the parent table cell.

      • getCnfStyle

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf getCnfStyle()
        Returns the Table Cell Conditional Formatting.

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

        Returns:
        the Table Cell Conditional Formatting.

      • setCnfStyle

        public void setCnfStyle​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTCnf cnfStyle)
        Sets the Table Cell Conditional Formatting.

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

        Parameters:
        cnfStyle - the Table Cell Conditional Formatting.

      • getGridSpan

        public java.lang.Integer getGridSpan()
        Returns the grid span.

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

        Returns:
        the grid span.

      • setGridSpan

        public void setGridSpan​(java.lang.Integer gridSpan)
        Sets the grid span.

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

        Parameters:
        gridSpan - the grid span.

      • isHideMark

        public boolean isHideMark()
        Returns whether to hide the end of cell marker in row height calculation.

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

        Returns:
        whether to hide the end of cell marker in row height calculation.

      • setHideMark

        public void setHideMark​(boolean hideMark)
        Sets whether to hide the end of cell marker in row height calculation.

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

        Parameters:
        hideMark - whether to hide the end of cell marker in row height calculation.

      • getHMerge

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.STMerge.Enum getHMerge()
        Returns the horizontal merge.

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

        Returns:
        the horizontal merge.

      • setHMerge

        public void setHMerge​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STMerge.Enum hMerge)
        Sets the horizontal merge.

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

        Parameters:
        hMerge - the horizontal merge.

      • isNoWrap

        public boolean isNoWrap()
        Returns whether to wrap the cell content.

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

        Returns:
        whether to wrap the cell content.

      • setNoWrap

        public void setNoWrap​(boolean noWrap)
        Sets whether to wrap the cell content.

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

        Parameters:
        noWrap - whether to wrap the cell content.

      • getShd

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

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

        Returns:
        the shading of the cell.

      • setShd

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

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

        Parameters:
        shd - the shading of the cell.

      • getTcBorders

        public DOCXTcBorders getTcBorders()
        Returns the table cell borders.

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

        Returns:
        the table cell borders.

      • setTcBorders

        public void setTcBorders​(DOCXTcBorders tcBorders)
        Sets the table cell borders.

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

        Parameters:
        tcBorders - the table cell borders.

      • isTcFitText

        public boolean isTcFitText()
        Returns whether to fit text within cell.

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

        Returns:
        whether to fit text within cell.

      • setTcFitText

        public void setTcFitText​(boolean tcFitText)
        Sets whether to fit text within cell.

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

        Parameters:
        tcFitText - whether to fit text within cell.

      • getTcMar

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcMar getTcMar()
        Returns the single table cell margins.

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

        Returns:
        the single table cell margins.

      • setTcMar

        public void setTcMar​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcMar tcMar)
        Sets the single table cell margins.

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

        Parameters:
        tcMar - the single table cell margins.

      • getTcW

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth getTcW()
        Returns the width of the cell.

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

        Returns:
        the width of the cell.

      • setTcW

        public void setTcW​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTblWidth tcW)
        Sets the width of the cell.

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

        Parameters:
        tcW - the width of the cell.

      • getTextDirection

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum getTextDirection()
        Returns the cell text flow direction.

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

        Returns:
        the cell text flow direction.

      • setTextDirection

        public void setTextDirection​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STTextDirection.Enum textDirection)
        Sets the cell text flow direction.

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

        Parameters:
        textDirection - the cell text flow direction.

      • getVAlign

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalJc.Enum getVAlign()
        Returns the vertical alignment of the cell.

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

        Returns:
        the vertical alignment of the cell.

      • setVAlign

        public void setVAlign​(org.openxmlformats.schemas.wordprocessingml.x2006.main.STVerticalJc.Enum vAlign)
        Sets the vertical alignment of the cell.

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

        Parameters:
        vAlign - the vertical alignment of the cell.

      • getVMerge

        public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVMerge getVMerge()
        Returns the vertical merge.

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

        Returns:
        the vertical merge.

      • setVMerge

        public void setVMerge​(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVMerge vMerge)
        Sets the vertical merge.

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

        Parameters:
        vMerge - the vertical merge.