ISummaryCalculator - BETA ActionScript® 3 (AS3 Flex) Reference for the Adobe® Flash® Platform API Reference

(Preview)

Package	mx.collections
Interface	public 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.

More examples

Creating summary rows

Related API Elements

mx.collections.SummaryField2

Public Methods

	Method		Defined By
		calculateSummary(data:Object, field:SummaryField2, rowData:Object):void Flex calls this method when a new value needs to be added to the summary value.	ISummaryCalculator
		calculateSummaryOfSummary(value:Object, newValue:Object, field:SummaryField2):void Flex calls this method when a new summary value needs to be added to the already computed summary.	ISummaryCalculator
		returnSummary(data:Object, field:SummaryField2):Number Flex calls this method to end the computation of the summary value.	ISummaryCalculator
		returnSummaryOfSummary(value:Object, field:SummaryField2):Number Flex calls this method to end the summary calculation.	ISummaryCalculator
		summaryCalculationBegin(field:SummaryField2):Object Flex calls this method to start the computation of a summary value.	ISummaryCalculator
		summaryOfSummaryCalculationBegin(value:Object, field:SummaryField2):Object Flex calls this method to start calculation of summary out of summary values.	ISummaryCalculator

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

ISummaryCalculator - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.collections

calculateSummary

calculateSummaryOfSummary

returnSummary

returnSummaryOfSummary

summaryCalculationBegin

summaryOfSummaryCalculationBegin

	`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.

	`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.