Top Inners Fields Constructors Methods
org.apache.poi.ss.usermodel

public Class CellCopyPolicy

extends Object
Class Inheritance
Annotations
@Beta
Imports
org.apache.poi.util.Beta

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
public static final boolean
public static final boolean
public static final boolean
public static final boolean
public static final boolean
public static final boolean
private boolean

Constructor Summary

AccessConstructor and Description
public
CellCopyPolicy()

Default CellCopyPolicy, uses default policy For custom CellCopyPolicy, use Builder class

public
CellCopyPolicy(CellCopyPolicy
policy to copy
other
)

Copy constructor

private

Method Summary

Modifier and TypeMethod and Description
public CellCopyPolicy.Builder
public boolean

Returns:

the condenseRows setting
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

public boolean

Returns:

the copyCellFormula
isCopyCellFormula
()

public boolean

Returns:

the copyCellStyle
isCopyCellStyle
()

public boolean

Returns:

the copyCellValue
isCopyCellValue
()

public boolean

Returns:

the copyMergedRegions
isCopyMergedRegions
()

public boolean

Returns:

the copyRowHeight
isCopyRowHeight
()

public void
setCondenseRows(boolean
the condenseRows to set
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

public void
setCopyCellFormula(boolean
the copyCellFormula to set
copyCellFormula
)

public void
setCopyCellStyle(boolean
the copyCellStyle to set
copyCellStyle
)

public void
setCopyCellValue(boolean
the copyCellValue to set
copyCellValue
)

public void
setCopyMergedRegions(boolean
the copyMergedRegions to set
copyMergedRegions
)

public void
setCopyRowHeight(boolean
the copyRowHeight to set
copyRowHeight
)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

condenseRowsback to summary
private boolean condenseRows
copyCellFormulaback to summary
private boolean copyCellFormula
copyCellStyleback to summary
private boolean copyCellStyle
copyCellValueback to summary
private boolean copyCellValue
copyMergedRegionsback to summary
private boolean copyMergedRegions
copyRowHeightback to summary
private boolean copyRowHeight
DEFAULT_CONDENSE_ROWS_POLICYback to summary
public static final boolean DEFAULT_CONDENSE_ROWS_POLICY
DEFAULT_COPY_CELL_FORMULA_POLICYback to summary
public static final boolean DEFAULT_COPY_CELL_FORMULA_POLICY
DEFAULT_COPY_CELL_STYLE_POLICYback to summary
public static final boolean DEFAULT_COPY_CELL_STYLE_POLICY
DEFAULT_COPY_CELL_VALUE_POLICYback to summary
public static final boolean DEFAULT_COPY_CELL_VALUE_POLICY
DEFAULT_COPY_MERGED_REGIONS_POLICYback to summary
public static final boolean DEFAULT_COPY_MERGED_REGIONS_POLICY
DEFAULT_COPY_ROW_HEIGHT_POLICYback to summary
public static final boolean DEFAULT_COPY_ROW_HEIGHT_POLICY

Constructor Detail

CellCopyPolicyback to summary
public CellCopyPolicy()

Default CellCopyPolicy, uses default policy For custom CellCopyPolicy, use Builder class

CellCopyPolicyback to summary
public CellCopyPolicy(CellCopyPolicy other)

Copy constructor

Parameters
other:CellCopyPolicy

policy to copy

CellCopyPolicyback to summary
private CellCopyPolicy(CellCopyPolicy.Builder builder)

Method Detail

createBuilderback to summary
public CellCopyPolicy.Builder createBuilder()
isCondenseRowsback to summary
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:boolean

the condenseRows setting

isCopyCellFormulaback to summary
public boolean isCopyCellFormula()
Returns:boolean

the copyCellFormula

isCopyCellStyleback to summary
public boolean isCopyCellStyle()
Returns:boolean

the copyCellStyle

isCopyCellValueback to summary
public boolean isCopyCellValue()
Returns:boolean

the copyCellValue

isCopyMergedRegionsback to summary
public boolean isCopyMergedRegions()
Returns:boolean

the copyMergedRegions

isCopyRowHeightback to summary
public boolean isCopyRowHeight()
Returns:boolean

the copyRowHeight

setCondenseRowsback to summary
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:boolean

the condenseRows to set

setCopyCellFormulaback to summary
public void setCopyCellFormula(boolean copyCellFormula)
Parameters
copyCellFormula:boolean

the copyCellFormula to set

setCopyCellStyleback to summary
public void setCopyCellStyle(boolean copyCellStyle)
Parameters
copyCellStyle:boolean

the copyCellStyle to set

setCopyCellValueback to summary
public void setCopyCellValue(boolean copyCellValue)
Parameters
copyCellValue:boolean

the copyCellValue to set

setCopyMergedRegionsback to summary
public void setCopyMergedRegions(boolean copyMergedRegions)
Parameters
copyMergedRegions:boolean

the copyMergedRegions to set

setCopyRowHeightback to summary
public void setCopyRowHeight(boolean copyRowHeight)
Parameters
copyRowHeight:boolean

the copyRowHeight to set

org.apache.poi.ss.usermodel back to summary

public Class CellCopyPolicy.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean
private boolean

Constructor Summary

AccessConstructor and Description
public
Builder()

Builder class for CellCopyPolicy

Method Summary

Modifier and TypeMethod and Description
public CellCopyPolicy
public CellCopyPolicy.Builder
cellFormula(boolean copyCellFormula)

public CellCopyPolicy.Builder
cellStyle(boolean copyCellStyle)

public CellCopyPolicy.Builder
cellValue(boolean copyCellValue)

public CellCopyPolicy.Builder
condenseRows(boolean condenseRows)

public CellCopyPolicy.Builder
mergedRegions(boolean copyMergedRegions)

public CellCopyPolicy.Builder
rowHeight(boolean copyRowHeight)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

condenseRowsback to summary
private boolean condenseRows
copyCellFormulaback to summary
private boolean copyCellFormula
copyCellStyleback to summary
private boolean copyCellStyle
copyCellValueback to summary
private boolean copyCellValue
copyMergedRegionsback to summary
private boolean copyMergedRegions
copyRowHeightback to summary
private boolean copyRowHeight

Constructor Detail

Builderback to summary
public Builder()

Builder class for CellCopyPolicy

Method Detail

buildback to summary
public CellCopyPolicy build()
cellFormulaback to summary
public CellCopyPolicy.Builder cellFormula(boolean copyCellFormula)
cellStyleback to summary
public CellCopyPolicy.Builder cellStyle(boolean copyCellStyle)
cellValueback to summary
public CellCopyPolicy.Builder cellValue(boolean copyCellValue)
condenseRowsback to summary
public CellCopyPolicy.Builder condenseRows(boolean condenseRows)
mergedRegionsback to summary
public CellCopyPolicy.Builder mergedRegions(boolean copyMergedRegions)
rowHeightback to summary
public CellCopyPolicy.Builder rowHeight(boolean copyRowHeight)