The PageByBean is used to display the page-by axis for reports, and the group-by section for documents. Conceptually these components are the same: each is a collection of units (usually attributes) that the end-user can modify by adding, removing or changing the position of the units within the collection (pivoting).

These units control the data displayed to the user: when the report or document is executed each unit is displayed with a combo-box that lists its elements, the data is automatically filtered based on the currently selected element.

Although conceptually the same, the underlying SDK objects that manipulate the page-by axis and the group-by section are different. The goal of the PageByBean and its related classes is to abstract these differences.

This bean is associated with a target-bean, which by default can only be a ReportBean or a RWBean. From this target-bean it will populate its list of units, each of which implements the PageByUnit interface. The PageByBean.getUnits() method returns the enumeration of these units.

Application bean type for the PageBy bean

AddUnit, Delete, DeleteUnit, DisplayAttrForms, DisplayType, Generic, PivotEvent, SelectElements, Sorts