Top Description Constructors Methods
org.apache.poi.ss.usermodel.helpers

public abstract Class BaseRowColShifter

extends Object
Class Inheritance
Known Direct Subclasses
org.apache.poi.ss.usermodel.helpers.ColumnShifter, org.apache.poi.ss.usermodel.helpers.RowShifter
Annotations
@Internal
Imports
org.apache.poi.ss.formula.FormulaShifter, org.apache.poi.ss.formula.ptg.AreaErrPtg, .AreaPtg, .Ptg, org.apache.poi.ss.util.CellRangeAddress, org.apache.poi.util.Internal, java.util.List
Class for code common to RowShifter and ColumnShifter Helper for shifting rows up or down and columns left and right
Since
POI 4.0.0

Constructor Summary

AccessConstructor and Description
public
BaseRowColShifter()

Method Summary

Modifier and TypeMethod and Description
public abstract List<CellRangeAddress>

Returns:

a list of affected merged regions, excluding contain deleted ones
shiftMergedRegions(int
the first row or column to be shifted
start, int
the last row or column to be shifted
end, int
the number of rows or columns to shift
n)

Shifts, grows, or shrinks the merged regions due to a row shift (RowShifter) or column shift (ColumnShifter).

public static CellRangeAddress
shiftRange(FormulaShifter formulaShifter, CellRangeAddress cra, int currentExternSheetIx)

public abstract void
updateConditionalFormatting(FormulaShifter
The FormulaShifter to use
formulaShifter)

Update conditional formatting

public abstract void
updateFormulas(FormulaShifter formulaShifter)

Update formulas.

public abstract void
updateNamedRanges(FormulaShifter formulaShifter)

Update named ranges

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

BaseRowColShifterback to summary
public BaseRowColShifter()

Method Detail

shiftMergedRegionsback to summary
public abstract List<CellRangeAddress> shiftMergedRegions(int start, int end, int n)

Shifts, grows, or shrinks the merged regions due to a row shift (RowShifter) or column shift (ColumnShifter). Merged regions that are completely overlaid by shifting will be deleted.

Parameters
start:int

the first row or column to be shifted

end:int

the last row or column to be shifted

n:int

the number of rows or columns to shift

Returns:List<CellRangeAddress>

a list of affected merged regions, excluding contain deleted ones

shiftRangeback to summary
public static CellRangeAddress shiftRange(FormulaShifter formulaShifter, CellRangeAddress cra, int currentExternSheetIx)
updateConditionalFormattingback to summary
public abstract void updateConditionalFormatting(FormulaShifter formulaShifter)

Update conditional formatting

Parameters
formulaShifter:FormulaShifter

The FormulaShifter to use

updateFormulasback to summary
public abstract void updateFormulas(FormulaShifter formulaShifter)

Update formulas.

updateHyperlinksback to summary
public abstract void updateHyperlinks(FormulaShifter formulaShifter)

Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks do not track the content they point to.

Parameters
formulaShifter:FormulaShifter

the formula shifting policy

updateNamedRangesback to summary
public abstract void updateNamedRanges(FormulaShifter formulaShifter)

Update named ranges