|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IGroup
This interface enables you to get and set the options and conditions for how data is grouped in the report and which options are set for the group. The options that control how data is grouped depend on the type of field that is used in the grouping. For example, if a date field is used to group data, it will have options specific to sorting dates. It is also possible to group data using a specific, user-defined group order. The Options property stores the grouping options.
Depending on the grouping options required, the Options property will be one of the following:
| Group | Options Object Type |
| Normal group | No options |
| Specified grouping | SpecifiedGroupOptions Object |
| Grouping based on date | DateGroupOptions Object |
The only fields that may be used to group data are:
The following are defined as primitive types:
Use the
GroupController.canGroupOn(IField) method to determine if a particular field can be used to
group data.
| Method Summary | |
|---|---|
void |
addSort(int index,
ISort newSort)
For internal use only |
void |
cleanSummarySorts()
For internal use only |
IField |
getConditionField()
Returns which field is being used to group the data. |
ISort |
getConditionFieldSort()
For internal use only |
java.lang.String |
getGroupIdentifier()
For internal use only |
int |
getGroupIndex()
For internal use only. |
IGroupOptions |
getOptions()
Indicates how the group behaves. |
int |
getPrimaryInteractiveSortIndex()
For internal use only |
ISort |
getSort()
Gets the group primary sorting. |
ISort |
getSortBySortFieldName(java.lang.String sortFieldName)
For internal use only |
int |
getSortIndexBySortField(IField sortField)
For internal use only |
Sorts |
getSorts()
For internal use only |
boolean |
isValidSort(ISort newSort,
int index,
boolean bAdd)
For internal use only |
void |
removeSummarySort(ISort summarySort)
For internal use only |
void |
removeSummarySortAt(int index)
For internal use only |
void |
setConditionField(IField conditionField)
Sets which field is being used to group the data. |
void |
setGroupIdentifier(java.lang.String identifier)
For internal use only |
void |
setGroupIndex(int index)
For internal use only. |
void |
setOptions(IGroupOptions options)
Indicates how the group behaves. |
void |
setSort(int index,
ISort newSort)
For internal use only |
void |
setSort(ISort sort)
Sets the group primary sorting. |
void |
setSorts(Sorts sorts)
For internal use only |
| Method Detail |
|---|
IField getConditionField()
Returns which field is being used to group the data.
The only fields that may be used to group data are:
The following are defined as primitive types:
Use the
GroupController.canGroupOn(IField) method to determine if a particular field can be used to
group data.
IField interface.IGroupOptions getOptions()
Indicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following
| Group | Options Object Type |
| Normal group | No options |
| Specified grouping | SpecifiedGroupOptions Object |
| Grouping based on date | DateGroupOptions Object |
IGroupOptions interface.void setConditionField(IField conditionField)
Sets which field is being used to group the data.
The only fields that may be used to group data are:
The following are defined as primitive types:
Use the
GroupController.canGroupOn(IField) method to determine if a particular field can be used to
group data.
conditionField - The field that is being used to group the data as an IField
interface.void setOptions(IGroupOptions options)
Indicates how the group behaves. Depending on the grouping options required, the Options property will be one of the following
| Group | Options Object Type |
| Normal group | No options |
| Specified grouping | SpecifiedGroupOptions Object |
| Grouping based on date | DateGroupOptions Object |
options - The IGroupOptions interface.ISort getSort()
ISort objectGroupSortControllerISort getConditionFieldSort()
void setSort(ISort sort)
sort - an ISort objectGroupSortControllerint getGroupIndex()
void setGroupIndex(int index)
java.lang.String getGroupIdentifier()
void setGroupIdentifier(java.lang.String identifier)
Sorts getSorts()
void setSorts(Sorts sorts)
void addSort(int index,
ISort newSort)
void setSort(int index,
ISort newSort)
void removeSummarySortAt(int index)
void removeSummarySort(ISort summarySort)
ISort getSortBySortFieldName(java.lang.String sortFieldName)
int getSortIndexBySortField(IField sortField)
boolean isValidSort(ISort newSort,
int index,
boolean bAdd)
void cleanSummarySorts()
int getPrimaryInteractiveSortIndex()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||