Modifier and Type	Class and Description
private static enum	FormulaShifter.ShiftMode

Modifier and Type	Field and Description
private final int	_amountToMove
private final int	_dstSheetIndex
private final int	_externSheetIndex Extern sheet index of sheet where moving is occurring, used for updating HSSF style 3D references
private final int	_firstMovedIndex
private final int	_lastMovedIndex
private final FormulaShifter.ShiftMode	_mode
private final String	_sheetName Sheet name of the sheet where moving is occurring, used for updating XSSF style 3D references on row shifts.
private final int	_srcSheetIndex
private final SpreadsheetVersion	_version

Access	Constructor and Description
private	FormulaShifter(int externSheetIndex, String sheetName, int firstMovedIndex, int lastMovedIndex, int amountToMove, FormulaShifter.ShiftMode mode, SpreadsheetVersion version) Create an instance for shifting row.
private	FormulaShifter(int srcSheetIndex, int dstSheetIndex) Create an instance for shifting sheets.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if a change was made to the formula tokens adjustFormula(Ptg[] - if necessary, will get modified by this method ptgs, int - the extern sheet index of the sheet that contains the formula being adjusted currentExternSheetIx)
private Ptg	adjustPtg(Ptg ptg, int currentExternSheetIx)
private Ptg	Returns: deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last column of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null` adjustPtgDueToColumnCopy(Ptg the ptg to shift ptg) Call this on any ptg reference contained in a column of cells that was copied.
private Ptg	Returns: in-place modified ptg (if column move would cause Ptg to change), deleted ref ptg (if column move causes an error), or null (if no Ptg change is needed) adjustPtgDueToColumnMove(Ptg ptg, int currentExternSheetIx)
private Ptg	Returns: deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row or columns of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null` adjustPtgDueToCopy(Ptg the ptg to shift ptg, boolean isRowCopy) Call this on any ptg reference contained in a row or column of cells that was copied.
private Ptg	Returns: in-place modified ptg (if column move would cause Ptg to change), deleted ref ptg (if column move causes an error), or null (if no Ptg change is needed) adjustPtgDueToMove(Ptg ptg, int currentExternSheetIx, boolean isRowMove)
private Ptg	Returns: deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null` adjustPtgDueToRowCopy(Ptg the ptg to shift ptg) Call this on any ptg reference contained in a row of cells that was copied.
private Ptg	Returns: in-place modified ptg (if row move would cause Ptg to change), deleted ref ptg (if row move causes an error), or null (if no Ptg change is needed) adjustPtgDueToRowMove(Ptg ptg, int currentExternSheetIx)
private Ptg	adjustPtgDueToSheetMove(Ptg ptg)
private Ptg	Returns: null, AreaErrPtg, or modified aptg columnCopyAreaPtg(AreaPtgBase The Area that is copied aptg) Modifies aptg in-place and return a reference to aptg if the first or last column of of the Area reference would move due to a column copy operation Returns `null` or `AreaErrPtg` if no change was made
private Ptg	Returns: The Ptg reference if the cell would move due to copy, otherwise null columnCopyRefPtg(RefPtgBase The REF that is copied rptg) Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a column copy operation Returns `null` or `RefErrorPtg` if no change was made
private Ptg	columnMoveAreaPtg(AreaPtgBase aptg)
private Ptg	columnMoveRefPtg(RefPtgBase rptg)
private static Ptg	createDeletedRef(Ptg ptg)
public static FormulaShifter	createForColumnCopy(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version)
public static FormulaShifter	createForColumnShift(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version)
public static FormulaShifter	createForRowCopy(int externSheetIndex, String sheetName, int firstMovedRowIndex, int lastMovedRowIndex, int numberOfRowsToMove, SpreadsheetVersion version)
public static FormulaShifter	createForRowShift(int externSheetIndex, String sheetName, int firstMovedRowIndex, int lastMovedRowIndex, int numberOfRowsToMove, SpreadsheetVersion version)
public static FormulaShifter	createForSheetShift(int srcSheetIndex, int dstSheetIndex)
private Ptg	Returns: null, AreaErrPtg, or modified aptg rowCopyAreaPtg(AreaPtgBase The Area that is copied aptg) Modifies aptg in-place and return a reference to aptg if the first or last row of of the Area reference would move due to a row copy operation Returns `null` or `AreaErrPtg` if no change was made
private Ptg	Returns: The Ptg reference if the cell would move due to copy, otherwise null rowCopyRefPtg(RefPtgBase The REF that is copied rptg) Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a row copy operation Returns `null` or `RefErrorPtg` if no change was made
private Ptg	rowMoveAreaPtg(AreaPtgBase aptg)
private Ptg	rowMoveRefPtg(RefPtgBase rptg)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_amountToMove	back to summary
private final int _amountToMove

_dstSheetIndex	back to summary
private final int _dstSheetIndex

_externSheetIndex	back to summary
private final int _externSheetIndex Extern sheet index of sheet where moving is occurring, used for updating HSSF style 3D references

_firstMovedIndex	back to summary
private final int _firstMovedIndex

_lastMovedIndex	back to summary
private final int _lastMovedIndex

_mode	back to summary
private final FormulaShifter.ShiftMode _mode

_sheetName	back to summary
private final String _sheetName Sheet name of the sheet where moving is occurring, used for updating XSSF style 3D references on row shifts.

_srcSheetIndex	back to summary
private final int _srcSheetIndex

_version	back to summary
private final SpreadsheetVersion _version

Constructor Detail

FormulaShifter	back to summary
private FormulaShifter(int externSheetIndex, String sheetName, int firstMovedIndex, int lastMovedIndex, int amountToMove, FormulaShifter.ShiftMode mode, SpreadsheetVersion version) Create an instance for shifting row. For example, this will be called on `org.apache.poi.hssf.usermodel.HSSFSheet#shiftRows(int, int, int)` }

FormulaShifter	back to summary
private FormulaShifter(int srcSheetIndex, int dstSheetIndex) Create an instance for shifting sheets. For example, this will be called on `org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)`

Method Detail

adjustFormula	back to summary
public boolean adjustFormula(Ptg[] ptgs, int currentExternSheetIx) Parameters ptgs:Ptg[] - if necessary, will get modified by this method currentExternSheetIx:int - the extern sheet index of the sheet that contains the formula being adjusted Returns:boolean `true` if a change was made to the formula tokens

adjustPtg	back to summary
private Ptg adjustPtg(Ptg ptg, int currentExternSheetIx)

adjustPtgDueToColumnCopy back to summary

adjustPtgDueToColumnCopy	back to summary
private Ptg adjustPtgDueToColumnCopy(Ptg ptg) Call this on any ptg reference contained in a column of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the columns were copied. Parameters ptg:Ptg the ptg to shift Returns:Ptg deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last column of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null`

private Ptg adjustPtgDueToColumnCopy(Ptg ptg)

Call this on any ptg reference contained in a column of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the columns were copied.

Parameters

ptg:Ptg: the ptg to shift

Returns:Ptg

deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last column of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns null

adjustPtgDueToColumnMove	back to summary
private Ptg adjustPtgDueToColumnMove(Ptg ptg, int currentExternSheetIx) Returns:Ptg in-place modified ptg (if column move would cause Ptg to change), deleted ref ptg (if column move causes an error), or null (if no Ptg change is needed)

adjustPtgDueToCopy back to summary

adjustPtgDueToCopy	back to summary
private Ptg adjustPtgDueToCopy(Ptg ptg, boolean isRowCopy) Call this on any ptg reference contained in a row or column of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the rows or columns were copied. Parameters ptg:Ptg the ptg to shift Returns:Ptg deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row or columns of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null`

private Ptg adjustPtgDueToCopy(Ptg ptg, boolean isRowCopy)

Call this on any ptg reference contained in a row or column of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the rows or columns were copied.

Parameters

ptg:Ptg: the ptg to shift

Returns:Ptg

deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row or columns of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns null

adjustPtgDueToMove	back to summary
private Ptg adjustPtgDueToMove(Ptg ptg, int currentExternSheetIx, boolean isRowMove) Returns:Ptg in-place modified ptg (if column move would cause Ptg to change), deleted ref ptg (if column move causes an error), or null (if no Ptg change is needed)

adjustPtgDueToRowCopy back to summary

adjustPtgDueToRowCopy	back to summary
private Ptg adjustPtgDueToRowCopy(Ptg ptg) Call this on any ptg reference contained in a row of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the rows were copied. Parameters ptg:Ptg the ptg to shift Returns:Ptg deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns `null`

private Ptg adjustPtgDueToRowCopy(Ptg ptg)

Call this on any ptg reference contained in a row of cells that was copied. If the ptg reference is relative, the references will be shifted by the distance that the rows were copied.

Parameters

ptg:Ptg: the ptg to shift

Returns:Ptg

deleted ref ptg, in-place modified ptg, or null If Ptg would be shifted off the first or last row of a sheet, return deleted ref If Ptg needs to be changed, modifies Ptg in-place If Ptg doesn't need to be changed, returns null

adjustPtgDueToRowMove	back to summary
private Ptg adjustPtgDueToRowMove(Ptg ptg, int currentExternSheetIx) Returns:Ptg in-place modified ptg (if row move would cause Ptg to change), deleted ref ptg (if row move causes an error), or null (if no Ptg change is needed)

adjustPtgDueToSheetMove	back to summary
private Ptg adjustPtgDueToSheetMove(Ptg ptg)

columnCopyAreaPtg back to summary

columnCopyAreaPtg	back to summary
private Ptg columnCopyAreaPtg(AreaPtgBase aptg) Modifies aptg in-place and return a reference to aptg if the first or last column of of the Area reference would move due to a column copy operation Returns `null` or `AreaErrPtg` if no change was made Parameters aptg:AreaPtgBase The Area that is copied Returns:Ptg null, AreaErrPtg, or modified aptg

private Ptg columnCopyAreaPtg(AreaPtgBase aptg)

Modifies aptg in-place and return a reference to aptg if the first or last column of of the Area reference would move due to a column copy operation Returns null or AreaErrPtg if no change was made

Parameters

aptg:AreaPtgBase: The Area that is copied

Returns:Ptg

null, AreaErrPtg, or modified aptg

columnCopyRefPtg back to summary

columnCopyRefPtg	back to summary
private Ptg columnCopyRefPtg(RefPtgBase rptg) Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a column copy operation Returns `null` or `RefErrorPtg` if no change was made Parameters rptg:RefPtgBase The REF that is copied Returns:Ptg The Ptg reference if the cell would move due to copy, otherwise null

private Ptg columnCopyRefPtg(RefPtgBase rptg)

Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a column copy operation Returns null or RefErrorPtg if no change was made

Parameters

rptg:RefPtgBase: The REF that is copied

Returns:Ptg

The Ptg reference if the cell would move due to copy, otherwise null

columnMoveAreaPtg	back to summary
private Ptg columnMoveAreaPtg(AreaPtgBase aptg)

columnMoveRefPtg	back to summary
private Ptg columnMoveRefPtg(RefPtgBase rptg)

createDeletedRef	back to summary
private static Ptg createDeletedRef(Ptg ptg)

createForColumnCopy	back to summary
public static FormulaShifter createForColumnCopy(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version) Since POI 4.0.0

createForColumnShift	back to summary
public static FormulaShifter createForColumnShift(int externSheetIndex, String sheetName, int firstMovedColumnIndex, int lastMovedColumnIndex, int numberOfColumnsToMove, SpreadsheetVersion version) Since POI 4.0.0

createForRowCopy	back to summary
public static FormulaShifter createForRowCopy(int externSheetIndex, String sheetName, int firstMovedRowIndex, int lastMovedRowIndex, int numberOfRowsToMove, SpreadsheetVersion version)

createForRowShift	back to summary
public static FormulaShifter createForRowShift(int externSheetIndex, String sheetName, int firstMovedRowIndex, int lastMovedRowIndex, int numberOfRowsToMove, SpreadsheetVersion version)

createForSheetShift	back to summary
public static FormulaShifter createForSheetShift(int srcSheetIndex, int dstSheetIndex)

rowCopyAreaPtg back to summary

rowCopyAreaPtg	back to summary
private Ptg rowCopyAreaPtg(AreaPtgBase aptg) Modifies aptg in-place and return a reference to aptg if the first or last row of of the Area reference would move due to a row copy operation Returns `null` or `AreaErrPtg` if no change was made Parameters aptg:AreaPtgBase The Area that is copied Returns:Ptg null, AreaErrPtg, or modified aptg

private Ptg rowCopyAreaPtg(AreaPtgBase aptg)

Modifies aptg in-place and return a reference to aptg if the first or last row of of the Area reference would move due to a row copy operation Returns null or AreaErrPtg if no change was made

Parameters

aptg:AreaPtgBase: The Area that is copied

Returns:Ptg

null, AreaErrPtg, or modified aptg

rowCopyRefPtg back to summary

rowCopyRefPtg	back to summary
private Ptg rowCopyRefPtg(RefPtgBase rptg) Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a row copy operation Returns `null` or `RefErrorPtg` if no change was made Parameters rptg:RefPtgBase The REF that is copied Returns:Ptg The Ptg reference if the cell would move due to copy, otherwise null

private Ptg rowCopyRefPtg(RefPtgBase rptg)

Modifies rptg in-place and return a reference to rptg if the cell reference would move due to a row copy operation Returns null or RefErrorPtg if no change was made

Parameters

rptg:RefPtgBase: The REF that is copied

Returns:Ptg

The Ptg reference if the cell would move due to copy, otherwise null

rowMoveAreaPtg	back to summary
private Ptg rowMoveAreaPtg(AreaPtgBase aptg)

rowMoveRefPtg	back to summary
private Ptg rowMoveRefPtg(RefPtgBase rptg)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

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

private final Enum FormulaShifter.ShiftMode

Class Inheritance

extends Enum<FormulaShifter.ShiftMode>

java.lang.Object
java.lang.Enum
org.apache.poi.ss.formula.FormulaShifter.ShiftMode

Field Summary

Modifier and Type	Field and Description
public static final FormulaShifter.ShiftMode	ColumnCopy
public static final FormulaShifter.ShiftMode	ColumnMove
public static final FormulaShifter.ShiftMode	RowCopy
public static final FormulaShifter.ShiftMode	RowMove
public static final FormulaShifter.ShiftMode	SheetMove

Constructor Summary

Access	Constructor and Description
private	ShiftMode()

Method Summary

Modifier and Type	Method and Description
public static FormulaShifter.ShiftMode	valueOf(String name)
public static FormulaShifter.ShiftMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ColumnCopy	back to summary
public static final FormulaShifter.ShiftMode ColumnCopy Since POI 4.0.0

ColumnMove	back to summary
public static final FormulaShifter.ShiftMode ColumnMove Since POI 4.0.0

RowCopy	back to summary
public static final FormulaShifter.ShiftMode RowCopy

RowMove	back to summary
public static final FormulaShifter.ShiftMode RowMove

SheetMove	back to summary
public static final FormulaShifter.ShiftMode SheetMove

Constructor Detail

ShiftMode	back to summary
private ShiftMode()

Method Detail

valueOf	back to summary
public static FormulaShifter.ShiftMode valueOf(String name)

values	back to summary
public static FormulaShifter.ShiftMode[] values()

public final Class FormulaShifter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum FormulaShifter.ShiftMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail