PageByTransform

It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"

It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
Allowed Values: TRUE/FALSE.

Indicates the help topic for the help page of the editor.

Indicates the type of help topic this editor uses.

This is the flag used in the transform to specify whether to enable auto-submit functionality.
With this functionality, the page-by element selection is automatically submitted using javascript as soon as the element is selected by the end user.
Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges, if it's not DHTML mode, or based on the WebFeatureAutoPageBy Feature.
Allowed Values: TRUE/FALSE.

This is the flag used in the transform to specify whether to enable context menu functionality.
Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges or if it's not DHTML mode.
Allowed Values: TRUE/FALSE.

This is the flag used in the transform to specify whether to enable drag and drop functionality.
Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges or if it's not DHTML mode.
Allowed Values: TRUE/FALSE.

This flag indicates the page by attributes can be arranged or removed from the panel.
Allowed Values: TRUE/FALSE.

This flag indicates the Transform to render the summary section, even if the even is closed.
When this happens, the Transform isOpen returns true even if the underlying PageByBean is closed, and invokes the renderSummary method.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to allow advanced drilling.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to allow drilling to the child only.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to allow drilling on metrics.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to show Right Mouse Click menu for drill.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to show Right Mouse Click menu for drill for metrics.
Allowed Values: TRUE/FALSE.

It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
Allowed Values: TRUE/FALSE.

Returns a map (name/value pairs) with attributes and their corresponding values used with the <div> tag enclosing the body. These attributes are used for javascript and formatting.

Returns a map (name/value pairs) with attributes and their corresponding values used with the <div> tag enclosing the title. These attributes are used for javascript and formatting.

Returns a map (name/value pairs) with attributes and their corresponding values used with the <div> tag enclosing a single page-by unit. These attributes are used for javascript and formatting and include information for drand and drop and context menus.

Returns a textual description of the transform.

Returns the title for the editor. For documents it returns "Grouping", for reports it retursn "Page-by"

Returns the PageByBean being transformed.

Overrides AbstractAppTransform#getSupportedBeanType. Returns:

PageByBean.class

Initialize the css classes to be used by this transform.

Initialize the images to be used by this transform.

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

Indicates whether context-menus are enabled for this Transform. By default context-menus are enabled only if the contextMenus formal parameter has been set.

Indicates to the transform that it should render its content for design mode (in this case, some functionality might be disabled or different).

Returns true is the page-by units list is empty.

Renders the unit alias.

Renders the editor's body. This method will call renderEmptyList(MarkupOutput) or renderList(MarkupOutput) accordingly.

 Tag div = getTagsFactory().newDivTag();

 div.setCssClass(_cssBody);
 div.setStyle("position: relative;");
 div.setAttributes(getAttributesBody());

 if (isListEmpty()) {
 	 renderEmptyList(div.getContent());
 } else {
 	 renderList(div.getContent());
 }

 div.render(out);
 

If the dialog can be closed (that is, the canClose method returns true) it will render the close button.

Renders the title for the editor, just converts the editor title to upper case and appends ":"

Renders a single element list (that is, the dropdown that allows the end-user to select the current element).

By default the list is rendered inside a drop-down box. However if the user doesn't have the DssXmlPrivilegesWebSwitchPageByElements privilege, it will not render a drop-down but just a label with the current selection.

Renders the elements for the given unit. This is the dropdown that allows the users to select the element that will filter the data currently displayed.

Normally, a PageByUnit has a single PageByElementList, therefore it is rendered with a single dropdown, but in some cases (for example, when the PageByUnit corresponds to a dimension) it might have more than one. This method will call renderElementList(MarkupOutput, PageByElementList) for every necessary drop down.

This method is used to render the body when the list of units is empty. It just adds the message "none" to the output.

This method generates the fake page-by units for the attributes that are not on the template.

Renders a button with the link to the help section with the corresponding help topic.

Renders all pageby units (by calling for each one renderUnit).

Renders pivot buttons (if available) for the given unit.

Renders a single selected element label

Renders the selected element label for the given unit.

Renders sort buttons (if available) for the given unit.

Renders the submit button for the element list. Notice however nothing will be rendered if the list is empty, or if the autosubmit is enabled.

Renders the summary of the current selections.
If there are no units it just appends "none". If there are units but it's design mode, since no selections are available it returns an empty list.

Renders the dialog's title. This includes:

1. The editor's title.
2. The help button.
3. The close button.
4. A summary with the current selections.

 Tag div = getTagsFactory().newDivTag();
 Tag spanTitle = div.addChild("span");
 Tag spanButtons = div.addChild("span");
 Tag spanSummary = div.addChild("span");

 div.setCssClass("titleBar");
 div.setAttributes(getAttributesTitle());

 spanTitle.setCssClass("title");
 spanButtons.setCssClass("buttons");
 spanSummary.setCssClass("summary");

 renderEditorTitle(spanTitle.getContent());
 renderHelpButton(spanButtons.getContent());
 renderCloseButton(spanButtons.getContent());
 renderSummary(spanSummary.getContent());

 div.render(out);
 

Renders a single unit. For each unit this method will:

1. render its sort buttons
2. render its alias
3. render its element list
4. render its pivot buttons

 Tag span = getTagsFactory().newSpanTag();

 span.setCssClass("gby");
 span.setAttributes(getAttributesUnit(unit));

 renderSortButtons(span.getContent(), unit);
 renderAlias(span.getContent(), unit);
 renderElements(span.getContent(), unit);
 renderPivotButtons(span.getContent(), unit);

 span.render(out);
 

Main entry point for this transform. This is the method responsible of generating the HTML output.

Indicates the Transform whether it can be closed. Mainly used to decide whether to show the close button or not. There is the case where this needs to be open, even if the bean is closed (e.g. when we're showing the summary but not the dropdowns), in this case the bean is already closed so we don't want to show the button. The other case is in design mode for reports, here by design the dialog cannot be closed.

Returns the event used by the Transform to change the currently selected element.

Returns the event used to close the Transform.

Returns a map (name/value pairs) with attributes and their corresponding values necessary for context-menus used with the <div> tag enclosing a single page-by unit.
This method also builds these menus.

Returns the event used by the Trasnform to delete a pageby unit from the working-set definition. When you simply remove an object from the page-by, the object can still be used in other parts of the report/document definition. When you deleted from the working-set, though, the report definition changes, the unit is not available anymore and the report/document gets re-executed with the new definition.

Returns a map (name/value pairs) with attributes and their corresponding values necessary for drand and drop used with the <div> tag enclosing a single page-by unit.

Returns an initialized Editor instance, this instance is used by the Transform as a helper object to render the help and close buttons.

In HTML mode, all actions (sort, pivot, change element) need to be summited in the same <FORM> tag, therefore the event submitted needs to support all of these and execution the correct action based on an argument. This is the event used by the Transform for this case.

Returns the event used to open the online help in the corresponding section.

This will return the event that the main form should use. In DHTML it returns the changeSelectedElement event. In HTML mode is returns the generic event.

Returns the event used by the Trasnform to pivot a pageby unit. The action argument decides the type of pivot (left, right, to columns, etc).

Returns the event used by the Trasnform to remove a pageby unit. Notice that this event only removes the unit from the page-by section, but the unit is still available for manipulations in the working set definition.

Gets the tooltip for the remove image. This depends on privileges and the target type

This method overwrites the default implementation by determining which script class to use based on properties of the target report, not by what was defined as value of the formal parameter

Returns the event used by the Trasnform to sort a pageby unit.

Method that indicates if auto-submit is enabled for this transform.

Method that indicates if context-menus are enabled for this transform.

Method that indicates if drag and drop is enabled for this transform.

Extends isOpen by returning true even if the PageByBean is closed whenever all the following conditions are met:

• isSummaryWhenClosedEnabled FormalParameter is true.
• it's is view mode
• The list is not empty

Indicates if the target bean should be treated as a RWBean (document).

Indicates if the target bean should be treated as a ReportBean.

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

Renders the image to delete a unit. Deleting actually removes the unit from the working set and may trigger new SQL execution. By default this si only called if removing the unit from the page-by section is not available.

Method that will render all output necessary for client-side manipulations using javascript

Renders the image to pivot a unit. In HTML mode it adds the link for the pivot event. This method is used to render any of the posible pivot actions on a unit. Src will only be used in cases of accessibility support.

Renders the image to pivot a unit. In HTML mode it adds the link for the pivot event. This method is used to render any of the posible pivot actions on a unit.

Renders the image to remove a unit from the page-by section. In HTML mode it adds the link for the remove event.

Renders the image to sort a unit. In HTML mode it adds the link for the sort event. Src will only be used in cases of accessibility support.

Renders the image to sort a unit. In HTML mode it adds the link for the sort event.

Determines whether the transform should render itself or not. Returns the result of !isIFrameRequest() or the result of the hasChanged() method.

Indicates whether this unit can be removed from the report.

Any time you remove the last template unit from a REPORT (not just grid), you'll get the 'template unit is empty' error when executing it. If you're already in view mode (e.g. the report has been executed), when removing this unit the user will get the error, therefore we want to prevent it, therefore we will not allow users to remove if its the las unit in the template.