Package org.apache.poi.ss.usermodel

Class CellCopyPolicy

java.lang.Object
org.apache.poi.ss.usermodel.CellCopyPolicy
@Beta public class CellCopyPolicy extends Object

  • Field Details

    • DEFAULT_COPY_CELL_VALUE_POLICY

      public static final boolean DEFAULT_COPY_CELL_VALUE_POLICY
      See Also:

    • DEFAULT_COPY_CELL_STYLE_POLICY

      public static final boolean DEFAULT_COPY_CELL_STYLE_POLICY
      See Also:

    • DEFAULT_COPY_CELL_FORMULA_POLICY

      public static final boolean DEFAULT_COPY_CELL_FORMULA_POLICY
      See Also:

    • DEFAULT_ADJUST_FORMULA_REFERENCES_POLICY

      public static final boolean DEFAULT_ADJUST_FORMULA_REFERENCES_POLICY
      Since:
      6.0.0
      See Also:

    • DEFAULT_COPY_ROW_HEIGHT_POLICY

      public static final boolean DEFAULT_COPY_ROW_HEIGHT_POLICY
      See Also:

    • DEFAULT_CONDENSE_ROWS_POLICY

      public static final boolean DEFAULT_CONDENSE_ROWS_POLICY
      See Also:

    • DEFAULT_COPY_MERGED_REGIONS_POLICY

      public static final boolean DEFAULT_COPY_MERGED_REGIONS_POLICY
      See Also:

  • Constructor Details

    • CellCopyPolicy

      public CellCopyPolicy()
      Default CellCopyPolicy, uses default policy For custom CellCopyPolicy, use CellCopyPolicy.Builder class

    • CellCopyPolicy

      public CellCopyPolicy(CellCopyPolicy other)
      Copy constructor
      Parameters:
      other - policy to copy

  • Method Details

    • createBuilder

      public CellCopyPolicy.Builder createBuilder()

    • isCopyCellValue

      public boolean isCopyCellValue()
      Returns:
      the copyCellValue

    • setCopyCellValue

      public void setCopyCellValue(boolean copyCellValue)
      Parameters:
      copyCellValue - the copyCellValue to set

    • isCopyCellStyle

      public boolean isCopyCellStyle()
      Returns:
      the copyCellStyle

    • setCopyCellStyle

      public void setCopyCellStyle(boolean copyCellStyle)
      Parameters:
      copyCellStyle - the copyCellStyle to set

    • isCopyCellFormula

      public boolean isCopyCellFormula()
      Returns:
      the copyCellFormula

    • setCopyCellFormula

      public void setCopyCellFormula(boolean copyCellFormula)
      Parameters:
      copyCellFormula - the copyCellFormula to set

    • isAdjustFormulaReferences

      public boolean isAdjustFormulaReferences()
      Returns:
      whether the relative references of copied formulas are adjusted
      Since:
      6.0.0
      See Also:

    • setAdjustFormulaReferences

      public void setAdjustFormulaReferences(boolean adjustFormulaReferences)
      Sets whether CellUtil.copyCell(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.CellCopyPolicy, org.apache.poi.ss.usermodel.CellCopyContext) adjusts the relative references of a copied formula by the row and column offset between the source and destination cells, as Excel does when a formula is copied and pasted.

      Absolute references, and the absolute parts of mixed references, are not changed. References keep the sheet they refer to. A reference that would move past the limits of the destination workbook's SpreadsheetVersion becomes #REF!. The formula is parsed against the destination workbook. If it cannot be parsed there (e.g. it refers to a sheet or name that the destination workbook does not have), it is copied unchanged.

      Defaults to false, which copies formulas unchanged. Row copies (e.g. copyRowFrom) shift formula references whatever this setting is.

      Parameters:
      adjustFormulaReferences - whether to adjust the relative references of copied formulas
      Since:
      6.0.0

    • isCopyHyperlink

      public boolean isCopyHyperlink()
      Returns:
      the copyHyperlink

    • setCopyHyperlink

      public void setCopyHyperlink(boolean copyHyperlink)
      Parameters:
      copyHyperlink - the copyHyperlink to set

    • isMergeHyperlink

      public boolean isMergeHyperlink()
      Returns:
      the mergeHyperlink

    • setMergeHyperlink

      public void setMergeHyperlink(boolean mergeHyperlink)
      Parameters:
      mergeHyperlink - the mergeHyperlink to set

    • isCopyRowHeight

      public boolean isCopyRowHeight()
      Returns:
      the copyRowHeight

    • setCopyRowHeight

      public void setCopyRowHeight(boolean copyRowHeight)
      Parameters:
      copyRowHeight - the copyRowHeight to set

    • isCondenseRows

      public boolean isCondenseRows()
      If condenseRows is true, a discontinuity in srcRows will be removed when copied to destination

      For example:

      Sheet.copyRows({Row(1), Row(2), Row(5)}, 11, policy) results in rows 1, 2, and 5 being copied to rows 11, 12, and 13 if condenseRows is True, or rows 11, 11, 15 if condenseRows is false

      Returns:
      the condenseRows setting

    • setCondenseRows

      public void setCondenseRows(boolean condenseRows)
      If condenseRows is true, a discontinuity in srcRows will be removed when copied to destination

      For example:

      Sheet.copyRows({Row(1), Row(2), Row(5)}, 11, policy) results in rows 1, 2, and 5 being copied to rows 11, 12, and 13 if condenseRows is True, or rows 11, 11, 15 if condenseRows is false

      Parameters:
      condenseRows - the condenseRows to set

    • isCopyMergedRegions

      public boolean isCopyMergedRegions()
      Returns:
      the copyMergedRegions

    • setCopyMergedRegions

      public void setCopyMergedRegions(boolean copyMergedRegions)
      Parameters:
      copyMergedRegions - the copyMergedRegions to set