Class RtfCell


  • public class RtfCell
    extends java.lang.Object
    Deprecated.
    Please move to the RtfWriter2 and associated classes.
    A Helper Class for the RtfWriter.

    Do not use it directly ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. Parts of this Class were contributed by Steffen Stundzig. Many thanks for the improvements. Updates by Benoit WIART

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static byte[] cellBackgroundColor
      Deprecated.
      Cell background color
      private static byte[] cellBorderBottom
      Deprecated.
      Cell border bottom
      private static byte[] cellBorderLeft
      Deprecated.
      Cell border left
      private static byte[] cellBorderRight
      Deprecated.
      Cell border right
      private static byte[] cellBorderTop
      Deprecated.
      Cell border top
      private static byte[] cellEnd
      Deprecated.
      End of cell
      protected static byte[] cellInTable
      Deprecated.
      Cell is part of table
      private static byte[] cellMergeFirst
      Deprecated.
      First cell to merge with - Horizontal
      private static byte[] cellMergePrev
      Deprecated.
      Merge cell with previous horizontal cell
      private int cellpadding
      Deprecated.
      cell padding, because the table only renders the left and right cell padding and not the top and bottom one
      private static byte[] cellPaddingBottom
      Deprecated.
      padding bottom
      private static byte[] cellPaddingBottomUnit
      Deprecated.
      padding bottom unit
      private static byte[] cellPaddingLeft
      Deprecated.
      padding left
      private static byte[] cellPaddingLeftUnit
      Deprecated.
      padding left unit
      private static byte[] cellPaddingRight
      Deprecated.
      padding right
      private static byte[] cellPaddingRightUnit
      Deprecated.
      padding right unit
      private static byte[] cellPaddingTop
      Deprecated.
      padding top
      private static byte[] cellPaddingTopUnit
      Deprecated.
      padding top unit
      private int cellRight
      Deprecated.
      Cell right border position
      private static byte[] cellRightBorder
      Deprecated.
      Cell right border position
      private static byte[] cellVerticalAlignBottom
      Deprecated.
      Cell content vertical alignment bottom
      private static byte[] cellVerticalAlignCenter
      Deprecated.
      Cell content vertical alignment center
      private static byte[] cellVerticalAlignTop
      Deprecated.
      Cell content vertical alignment top
      private static byte[] cellVMergeFirst
      Deprecated.
      First cell to merge with - Vertical
      private static byte[] cellVMergePrev
      Deprecated.
      Merge cell with previous vertical cell
      private int cellWidth
      Deprecated.
      Cell width
      private static byte[] cellWidthStyle
      Deprecated.
      Cell width format
      private static byte[] cellWidthTag
      Deprecated.
      Cell width
      private boolean emptyCell
      Deprecated.
      Is this an empty cell
      private RtfTable mainTable
      Deprecated.
      The RtfTable to which this RtfCell belongs.
      private static int MERGE_BOTH_FIRST
      Deprecated.
      A possible value for merging
      private static int MERGE_BOTH_PREV
      Deprecated.
      A possible value for merging
      private static int MERGE_HORIZ_FIRST
      Deprecated.
      A possible value for merging
      private static int MERGE_HORIZ_PREV
      Deprecated.
      A possible value for merging
      private static int MERGE_VERT_FIRST
      Deprecated.
      A possible value for merging
      private static int MERGE_VERT_PREV
      Deprecated.
      A possible value for merging
      private int mergeType
      Deprecated.
      Type of merging to do
      private Cell store
      Deprecated.
      Cell containing the actual data
      private RtfWriter writer
      Deprecated.
      The RtfWriter to which this RtfCell belongs.
    • Constructor Summary

      Constructors 
      Constructor Description
      RtfCell​(RtfWriter writer, RtfTable mainTable)
      Deprecated.
      Create a new RtfCell.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getCellRight()
      Deprecated.
      Get the position of the right border of this RtfCell.
      int getCellWidth()
      Deprecated.
      Get the with of this RtfCell
      Cell getStore()
      Deprecated.
      Get the Cell with the actual content.
      int importCell​(Cell cell, int cellLeft, int cellWidth, int x, int y, int cellpadding)
      Deprecated.
      Import a Cell.
      void setCellRight​(int value)
      Deprecated.
      Sets the right position of the cell
      void setCellWidth​(int value)
      Deprecated.
      sets the width of the cell
      void setMerge​(int mergeType, RtfCell mergeCell)
      Deprecated.
      Sets the merge type and the RtfCell with which this RtfCell is to be merged.
      boolean writeCellContent​(java.io.ByteArrayOutputStream os)
      Deprecated.
      Write the content of the RtfCell.
      boolean writeCellSettings​(java.io.ByteArrayOutputStream os)
      Deprecated.
      Write the properties of the RtfCell.
      private void writeInt​(java.io.ByteArrayOutputStream out, int i)
      Deprecated.
      Write an Integer to the Outputstream.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • MERGE_HORIZ_FIRST

        private static final int MERGE_HORIZ_FIRST
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • MERGE_VERT_FIRST

        private static final int MERGE_VERT_FIRST
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • MERGE_BOTH_FIRST

        private static final int MERGE_BOTH_FIRST
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • MERGE_HORIZ_PREV

        private static final int MERGE_HORIZ_PREV
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • MERGE_VERT_PREV

        private static final int MERGE_VERT_PREV
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • MERGE_BOTH_PREV

        private static final int MERGE_BOTH_PREV
        Deprecated.
        A possible value for merging
        See Also:
        Constant Field Values
      • cellMergeFirst

        private static final byte[] cellMergeFirst
        Deprecated.
        First cell to merge with - Horizontal
      • cellVMergeFirst

        private static final byte[] cellVMergeFirst
        Deprecated.
        First cell to merge with - Vertical
      • cellMergePrev

        private static final byte[] cellMergePrev
        Deprecated.
        Merge cell with previous horizontal cell
      • cellVMergePrev

        private static final byte[] cellVMergePrev
        Deprecated.
        Merge cell with previous vertical cell
      • cellVerticalAlignBottom

        private static final byte[] cellVerticalAlignBottom
        Deprecated.
        Cell content vertical alignment bottom
      • cellVerticalAlignCenter

        private static final byte[] cellVerticalAlignCenter
        Deprecated.
        Cell content vertical alignment center
      • cellVerticalAlignTop

        private static final byte[] cellVerticalAlignTop
        Deprecated.
        Cell content vertical alignment top
      • cellBorderLeft

        private static final byte[] cellBorderLeft
        Deprecated.
        Cell border left
      • cellBorderRight

        private static final byte[] cellBorderRight
        Deprecated.
        Cell border right
      • cellBorderTop

        private static final byte[] cellBorderTop
        Deprecated.
        Cell border top
      • cellBorderBottom

        private static final byte[] cellBorderBottom
        Deprecated.
        Cell border bottom
      • cellBackgroundColor

        private static final byte[] cellBackgroundColor
        Deprecated.
        Cell background color
      • cellWidthStyle

        private static final byte[] cellWidthStyle
        Deprecated.
        Cell width format
      • cellWidthTag

        private static final byte[] cellWidthTag
        Deprecated.
        Cell width
      • cellRightBorder

        private static final byte[] cellRightBorder
        Deprecated.
        Cell right border position
      • cellInTable

        protected static final byte[] cellInTable
        Deprecated.
        Cell is part of table
      • cellEnd

        private static final byte[] cellEnd
        Deprecated.
        End of cell
      • cellPaddingTop

        private static final byte[] cellPaddingTop
        Deprecated.
        padding top
      • cellPaddingTopUnit

        private static final byte[] cellPaddingTopUnit
        Deprecated.
        padding top unit
      • cellPaddingBottom

        private static final byte[] cellPaddingBottom
        Deprecated.
        padding bottom
      • cellPaddingBottomUnit

        private static final byte[] cellPaddingBottomUnit
        Deprecated.
        padding bottom unit
      • cellPaddingLeft

        private static final byte[] cellPaddingLeft
        Deprecated.
        padding left
      • cellPaddingLeftUnit

        private static final byte[] cellPaddingLeftUnit
        Deprecated.
        padding left unit
      • cellPaddingRight

        private static final byte[] cellPaddingRight
        Deprecated.
        padding right
      • cellPaddingRightUnit

        private static final byte[] cellPaddingRightUnit
        Deprecated.
        padding right unit
      • writer

        private RtfWriter writer
        Deprecated.
        The RtfWriter to which this RtfCell belongs.
      • mainTable

        private RtfTable mainTable
        Deprecated.
        The RtfTable to which this RtfCell belongs.
      • cellWidth

        private int cellWidth
        Deprecated.
        Cell width
      • cellRight

        private int cellRight
        Deprecated.
        Cell right border position
      • store

        private Cell store
        Deprecated.
        Cell containing the actual data
      • emptyCell

        private boolean emptyCell
        Deprecated.
        Is this an empty cell
      • mergeType

        private int mergeType
        Deprecated.
        Type of merging to do
      • cellpadding

        private int cellpadding
        Deprecated.
        cell padding, because the table only renders the left and right cell padding and not the top and bottom one
    • Constructor Detail

      • RtfCell

        public RtfCell​(RtfWriter writer,
                       RtfTable mainTable)
        Deprecated.
        Create a new RtfCell.
        Parameters:
        writer - The RtfWriter that this RtfCell belongs to
        mainTable - The RtfTable that created the RtfRow that created the RtfCell :-)
    • Method Detail

      • importCell

        public int importCell​(Cell cell,
                              int cellLeft,
                              int cellWidth,
                              int x,
                              int y,
                              int cellpadding)
        Deprecated.
        Import a Cell.

        Parameters:
        cell - The Cell containing the data for this RtfCell
        cellLeft - The position of the left border
        cellWidth - The default width of a cell
        x - The column index of this RtfCell
        y - The row index of this RtfCell
        cellpadding - the cellpadding
        Returns:
        the position of the right side of the cell
      • writeCellSettings

        public boolean writeCellSettings​(java.io.ByteArrayOutputStream os)
                                  throws DocumentException
        Deprecated.
        Write the properties of the RtfCell.
        Parameters:
        os - The OutputStream to which to write the properties of the RtfCell to.
        Returns:
        true if writing the cell settings succeeded
        Throws:
        DocumentException
      • writeCellContent

        public boolean writeCellContent​(java.io.ByteArrayOutputStream os)
                                 throws DocumentException
        Deprecated.
        Write the content of the RtfCell.
        Parameters:
        os - The OutputStream to which to write the content of the RtfCell to.
        Returns:
        true if writing the cell content succeeded
        Throws:
        DocumentException
      • setMerge

        public void setMerge​(int mergeType,
                             RtfCell mergeCell)
        Deprecated.
        Sets the merge type and the RtfCell with which this RtfCell is to be merged.
        Parameters:
        mergeType - The merge type specifies the kind of merge to be applied (MERGE_HORIZ_PREV, MERGE_VERT_PREV, MERGE_BOTH_PREV)
        mergeCell - The RtfCell that the cell at x and y is to be merged with
      • getStore

        public Cell getStore()
        Deprecated.
        Get the Cell with the actual content.
        Returns:
        Cell which is contained in the RtfCell
      • getCellWidth

        public int getCellWidth()
        Deprecated.
        Get the with of this RtfCell
        Returns:
        Width of the current RtfCell
      • setCellWidth

        public void setCellWidth​(int value)
        Deprecated.
        sets the width of the cell
        Parameters:
        value - a width
      • getCellRight

        public int getCellRight()
        Deprecated.
        Get the position of the right border of this RtfCell.
        Returns:
        position of the right border
      • setCellRight

        public void setCellRight​(int value)
        Deprecated.
        Sets the right position of the cell
        Parameters:
        value - a cell position
      • writeInt

        private void writeInt​(java.io.ByteArrayOutputStream out,
                              int i)
                       throws java.io.IOException
        Deprecated.
        Write an Integer to the Outputstream.
        Parameters:
        out - The OutputStream to be written to.
        i - The int to be written.
        Throws:
        java.io.IOException