Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.collections 
ISummaryCalculator 
Packagemx.collections
Interfacepublic interface ISummaryCalculator
Implementors DefaultSummaryCalculator

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The ISummaryCalculator interface defines the interface implemented by custom summary calculator classes. An instance of a class that implements this interface can be passed to the summaryOperation property of the SummaryField2 Class.

Implement the methods of this interface in two groups. The first group consists of the summaryCalculationBegin(), calculateSummary(), and returnSummary() methods. Use these methods to compute summary of the values.

The second group consists of the summaryOfSummaryCalculationBegin(), calculateSummaryOfSummary(), and returnSummaryOfSummary() methods. Use these methods to compute summary of summary values.

See also



Public Methods
 MethodDefined By
  
Flex calls this method when a new value needs to be added to the summary value.
ISummaryCalculator
  
Flex calls this method when a new summary value needs to be added to the already computed summary.
ISummaryCalculator
  
Flex calls this method to end the computation of the summary value.
ISummaryCalculator
  
Flex calls this method to end the summary calculation.
ISummaryCalculator
  
Flex calls this method to start the computation of a summary value.
ISummaryCalculator
  
Flex calls this method to start calculation of summary out of summary values.
ISummaryCalculator
Method Detail

calculateSummary

()method
public function calculateSummary(data:Object, field:SummaryField2, rowData:Object):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method when a new value needs to be added to the summary value.

Parameters

data:Object — The Object returned by the call to the summaryCalculationBegin() method, or calculated by a previous call to the calculateSummary() method. Use this Object to hold information necessary to perform the calculation. This method modifies this Object; it does not return a value.
 
field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.
 
rowData:Object — The object representing the rows data that is being analyzed.

calculateSummaryOfSummary

()method 
public function calculateSummaryOfSummary(value:Object, newValue:Object, field:SummaryField2):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method when a new summary value needs to be added to the already computed summary.

Parameters

value:Object — The Object returned by a call the summaryOfSummaryCalculationBegin() method, or calculated by a previous call to the calculateSummaryOfSummary() method. This method modifies this Object; it does not return a value.
 
newValue:Object — The Object returned by the call to the returnSummary() method for a previous aggregation.
 
field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.

returnSummary

()method 
public function returnSummary(data:Object, field:SummaryField2):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method to end the computation of the summary value.

Parameters

data:Object — The Object returned by the call to the calculateSummary() method. Use this Object to hold information necessary to perform the calculation.
 
field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.

Returns
Number — The summary value.

returnSummaryOfSummary

()method 
public function returnSummaryOfSummary(value:Object, field:SummaryField2):Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method to end the summary calculation.

Parameters

value:Object — The Object returned by a call to the calculateSummaryOfSummary() method that is used to store the summary calculation results. This method modifies this Object; it does not return a value.
 
field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.

Returns
Number — The summary value.

summaryCalculationBegin

()method 
public function summaryCalculationBegin(field:SummaryField2):Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method to start the computation of a summary value.

Parameters

field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.

Returns
Object — An Object initialized for the summary calculation. Use this Object to hold any information necessary to perform the calculation. You pass this Object to subsequent calls to the calculateSummary() and returnSummary() methods.

summaryOfSummaryCalculationBegin

()method 
public function summaryOfSummaryCalculationBegin(value:Object, field:SummaryField2):Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Flex calls this method to start calculation of summary out of summary values. Calculating the average value of a group of averages is an example of an calculation of summary out of summary values.

Parameters

value:Object — The Object returned by the call to the calculateSummary() method for a previous summary calculation. Use this Object to hold the information necessary to perform the calculation.
 
field:SummaryField2 — The SummaryField2 for which the summary needs to calculated.

Returns
Object — An Object initialized for the summary calculation. Use this Object to hold any information necessary to perform the calculation. You pass this Object to subsequent calls to the calculateSummaryOfSummary() and returnSummaryOfSummary() methods.