com.aspose.cells
Class AbstractCalculationMonitor

java.lang.Object
    extended by com.aspose.cells.AbstractCalculationMonitor

public abstract class AbstractCalculationMonitor 
extends java.lang.Object

Monitor for user to track the progress of formula calculation.


Property Getters/Setters Summary
java.lang.ObjectgetCalculatedValue()
           Gets the newly calculated value of the cell. Should be used only in afterCalculate(int, int, int).
java.lang.ObjectgetOriginalValue()
           Gets the old value of the calculated cell. Should be used only in beforeCalculate(int, int, int) and afterCalculate(int, int, int).
booleangetValueChanged()
           Whether the cell's value has been changed after the calculation. Should be used only in afterCalculate(int, int, int).
 
Method Summary
voidafterCalculate(int sheetIndex, int rowIndex, int colIndex)
           Implement this method to do business after one cell has been calculated.
voidbeforeCalculate(int sheetIndex, int rowIndex, int colIndex)
           Implement this method to do business before calculating one cell.
booleanonCircular(java.util.Iterator circularCellsData)
           Implement this method to do business when calculating formulas with circular references.
 

Property Getters/Setters Detail

getOriginalValue

public java.lang.Object getOriginalValue()
Gets the old value of the calculated cell. Should be used only in beforeCalculate(int, int, int) and afterCalculate(int, int, int).

getValueChanged

public boolean getValueChanged()
Whether the cell's value has been changed after the calculation. Should be used only in afterCalculate(int, int, int).

getCalculatedValue

public java.lang.Object getCalculatedValue()
Gets the newly calculated value of the cell. Should be used only in afterCalculate(int, int, int).

Method Detail

beforeCalculate

public void beforeCalculate(int sheetIndex, int rowIndex, int colIndex)
Implement this method to do business before calculating one cell.
Parameters:
sheetIndex - Index of the sheet that the cell belongs to.
rowIndex - Row index of the cell
colIndex - Column index of the cell

afterCalculate

public void afterCalculate(int sheetIndex, int rowIndex, int colIndex)
Implement this method to do business after one cell has been calculated.
Parameters:
sheetIndex - Index of the sheet that the cell belongs to.
rowIndex - Row index of the cell
colIndex - Column index of the cell

onCircular

public boolean onCircular(java.util.Iterator circularCellsData)
Implement this method to do business when calculating formulas with circular references. In the implementation user may also set the expected value as calculated result for part/all of those cells so the formula engine will not calculate them recursively.
Parameters:
circularCellsData - IEnumerator with CalculationCell items representing cells that depend on circular references.
Returns:
Whether the formula engine needs to calculate those cells in circular after this call. True to let the formula engine continue to do calculation for them. False to let the formula engine just mark those cells as Calculated.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.