| { "type": "interface", | |
| "qname": "mx.collections.ISummaryCalculator", | |
| "description": "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 <code>summaryOperation</code> property of the <code>SummaryField2</code> Class. <p>Implement the methods of this interface in two groups. The first group consists of the <code>summaryCalculationBegin()</code>, <code>calculateSummary()</code>, and <code>returnSummary()</code> methods. Use these methods to compute summary of the values.</p> <p>The second group consists of the <code>summaryOfSummaryCalculationBegin()</code>, <code>calculateSummaryOfSummary()</code>, and <code>returnSummaryOfSummary()</code> methods. Use these methods to compute summary of summary values.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.collections.SummaryField2"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "summaryCalculationBegin", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flex calls this method to start the computation of a summary value. Use this Object to hold any information necessary to perform the calculation. You pass this Object to subsequent calls to the <code>calculateSummary()</code> and <code>returnSummary()</code> methods.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["field The SummaryField2 for which the summary needs to calculated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "return", | |
| "values": ["An Object initialized for the summary calculation."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Object", | |
| "params": [{ "name": "field", "type": "mx.collections.SummaryField2"}]} | |
| , | |
| { "type": "method", | |
| "qname": "calculateSummary", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flex calls this method when a new value needs to be added to the summary value. or calculated by a previous call to the <code>calculateSummary()</code> method. Use this Object to hold information necessary to perform the calculation. This method modifies this Object; it does not return a value.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["data The Object returned by the call to the <code>summaryCalculationBegin()</code> method,", "field The SummaryField2 for which the summary needs to calculated.", "rowData The object representing the rows data that is being analyzed."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "data", "type": "Object"}, | |
| { "name": "field", "type": "mx.collections.SummaryField2"}, | |
| { "name": "rowData", "type": "Object"}]} | |
| , | |
| { "type": "method", | |
| "qname": "returnSummary", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flex calls this method to end the computation of the summary value. Use this Object to hold information necessary to perform the calculation.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["data The Object returned by the call to the <code>calculateSummary()</code> method.", "field The SummaryField2 for which the summary needs to calculated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "return", | |
| "values": ["The summary value."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Number", | |
| "params": [{ "name": "data", "type": "Object"}, | |
| { "name": "field", "type": "mx.collections.SummaryField2"}]} | |
| , | |
| { "type": "method", | |
| "qname": "summaryOfSummaryCalculationBegin", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. for a previous summary calculation. Use this Object to hold the information necessary to perform the calculation. Use this Object to hold any information necessary to perform the calculation. You pass this Object to subsequent calls to the <code>calculateSummaryOfSummary()</code> and <code>returnSummaryOfSummary()</code> methods.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["value The Object returned by the call to the <code>calculateSummary()</code> method", "field The SummaryField2 for which the summary needs to calculated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "return", | |
| "values": ["An Object initialized for the summary calculation."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Object", | |
| "params": [{ "name": "value", "type": "Object"}, | |
| { "name": "field", "type": "mx.collections.SummaryField2"}]} | |
| , | |
| { "type": "method", | |
| "qname": "calculateSummaryOfSummary", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flex calls this method when a new summary value needs to be added to the already computed summary. or calculated by a previous call to the <code>calculateSummaryOfSummary()</code> method. This method modifies this Object; it does not return a value. for a previous aggregation.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["value The Object returned by a call the <code>summaryOfSummaryCalculationBegin()</code> method,", "newValue The Object returned by the call to the <code>returnSummary()</code> method", "field The SummaryField2 for which the summary needs to calculated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "value", "type": "Object"}, | |
| { "name": "newValue", "type": "Object"}, | |
| { "name": "field", "type": "mx.collections.SummaryField2"}]} | |
| , | |
| { "type": "method", | |
| "qname": "returnSummaryOfSummary", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Flex calls this method to end the summary calculation. that is used to store the summary calculation results. This method modifies this Object; it does not return a value.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["value The Object returned by a call to the <code>calculateSummaryOfSummary()</code> method", "field The SummaryField2 for which the summary needs to calculated."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 10", "AIR 1.5"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 4"]}, | |
| { "tagName": "return", | |
| "values": ["The summary value."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Number", | |
| "params": [{ "name": "value", "type": "Object"}, | |
| { "name": "field", "type": "mx.collections.SummaryField2"}]} | |
| ] | |
| } |