AbstractReportGridDisplayCell

Constructor used for creating a generic display cell.

Define extra tag attributes and their values that shall be included on the table cell definition for the current instance being rendered

Adds values to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Information added through this method is appended to other information currently assigned to this attribute.

Utility methood for determining if the cell object is enabled for displaying the user the option to add threshold to it

Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it

Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it

Utility methood for determining if the cell object is enabled for displaying the user the option to edit control

Utility method for determining if the cell object is enabled editing a metric filter

Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it

Utility methood for determining if the cell object is enabled for displaying the user the option to format it

Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks

Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on it

Utility method for determining if the cell object is enabled for displaying the user the option to apply a metric filter on it

Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it

Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it

Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specified

Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid.

Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report

Utility methood for determining if the cell object is enabled for displaying the user the option to rename it

Utility methood for determining if the cell object is enabled for displaying the user the option to sort it

Utility method to clone this object.

This is the main entry point to generate the output of the cell.

This method is the one used by the Transform to delegate execution. It is responsible for generating the complete HTML output for the cell.

Developers can overwrite the generateOutput(MarkupOutput) method to set any text they want to display for the cell.

Returns any extra information registered by the Transform to be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508).

Returns the base bean associated with this display cell. The base bean should be used to calculate features and other general functionality from the underlying WebComponent.

Returns the id for this cell, this will be used as the ID attribute of TD tag.

Returns the cell type, a value from the EnumReportGridDisplayCellTypes enumeration.

Returns the column span for this cell as registered by the Transform. This is used as the COLSPAN attribute of TD tag.

Returns the WebEvent to drill from the cell to the given drill path.

Returns the WebEvent to drill from the cell to the given drill path.

Obtain the Drill path with high importance information for the current cell being analyzed

Returns the text assigned by the Transform as extra information of the cell. This text is appended to the TD's open tag.

Returns the extra style information required for the formatting of the cell as registered by the Transform. This text is assigned to the STYLE attribute of the TD tag.

get extra url for the cell

For those cells that uses a WebHeader as their underlying WebObject, this method returns the cell's text content.

Get the event for opening the format editor for the requested target.

Returns the report bean associated with this display cell

Returns the mode from EnumReportDesignMode

Returns the row span for this cell as registered by the Transform, this is used as the ROWSPAN attribute of TD tag.

Get the event for setting the current target of the format editor to be this cell instance

Returns the css class name associated with the cell as registered by the Transform.
If set, this is the one assigned to the CLASS attribute of the TD tag to control its formatting.

Returns the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, it returns the corresponding WebSubTitle; when in design mode, this returns null.
It always returns null if the instance represents an empty cell.

If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection.

Returns the text content of this cell. This represents the actual text displayed by the web browser.

Returns the tooltip text for this cell as registered by the Transform. This is the text displayed by the browser when the cursor goes over the cell.

Returns the view bean associated with this display cell

Returns the width for this cell as registered by the Transform, this is used as the WIDTH attribute of TD tag.

Initializes the instance.

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Initializes an ReportGridDisplayCell. This is used to initialize empty cells that have no underlying WebObject.

Indicates if the underlying object of a cell is a metric header.

Indicates if the cell is being rendered in the context of report writing (documents).

Reset all of the instance variables. This method is very important when improve the memory performance: we create only one instance for a particular cell type and reuse it instead of creating a new instance for each concrete grid cell. Therefore, it saves a lot of memory. For implementation of this method, please follow the workflow of how all the instance variables are initialized in the class hierarchy when a new instance is created: superclass instance variables are initialized first, subclass instance variables are initialized second. Note: for the purpose of cell reuse.

Registers any extra information that should be appended as part of the TD's open tag only when the cell will be rendered in Accessibility Mode (508). This can be used, for example, to include extra attributes used by screen-reader browsers.

Registers the id for this cell, this is used as the ID attribute of TD tag.

Sets the type for this cell, the value should be from the EnumReportGridDisplayCellTypes enumeration.

Sets the col span for this cell

Registers the main content of the cell. When a non-null content is registered, the content of the cell is replaced by this text and the cell does not call the generateContent method.

Registers the text used to enabled context menus for this cell. This text is appended to the TD's open tag.

Sets the drillPath for this cell. This is used to generate the drill link of the cell.

Registers any extra information that should be appended as part of the TD's open tag. This can be used, for example, to include extra attributes into the cell.

Updates values to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Based on the value of append, Information added through this method is appended to other information currently assigned to this attribute.

Registers any extra information required for the formatting of the cell.
This text is assigned to the STYLE attribute of the TD tag. The style assigned this way will only apply to this cell. Notice this method actually replaces the value of the style attribute with the provided parameter. If you actually require to add more information to the style attribute, you should use the addToStyle(String) method instead.

set extra url for the cell

Registers the HTML for this cell. When a non-null html is registered, the whole output of the cell is replaced with this text by the generateOutput method.

Registers the inner HTML for this cell. When a non-null innerHTML is registered, all the HTML within the TD tag is replaced by this text and the cell does not call the generateInnerHTML method.

Registers the post-content of the cell. When a non-null content is registered, the post-content of the cell is replaced by this text and the cell does not call the generatePostContent method.

Registers the pre-content of the cell. When a non-null content is registered, the pre-content of the cell is replaced by this text and the cell does not call the generatePreContent method.

Registers the row span for this cell, this is used as the ROWSPAN attribute of TD tag.

Registers the css style name associated with the cell.
This text will be assigned as the CLASS attribute of the TD tag to control the format of the cells that share the same CLASS.

Registers the underlying SDK object associated with this cell. If the report is in execute mode and attribute forms are displayed, the Transform calls this method to associate a WebSubTitle with the cell.

Registers the position of the underlying WebSubTitle within the subtitles collection.

Registers the text content of this cell. When a non-null text is registered, this text is used as the core content of the cell.

Registers the text for the tooltop of this cell. This is used as the TITLE attribute of TD tag.

Registers the width for this cell, this is used as WIDTH attribute of TD tag.

Adds into the Map instance the tag attributes required for processing context menus.

Adds into the Map instance the tag attributes required for processing context menus.

Adds into the Map instance the tag attributes required to enable drag and drop operations.

Generate generic tooltip information for the current cell being rendered. Might include description, drill and generic hints as enabled and available.

Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.

Whether to convert nonbreaking spaces (char 160) to normal spaces (char 32) on metric values. Used for Exporting to Excel on French Environments.

Whether to decode the Euro symbol on the metric values

Whether to HTML-encode metric values (based on the preference value)

Creates an <a> tag from the EventManager with the Iframe information required if supported.

Generates the core HTML for this cell. By default, this method just calls the generateText to include the cell's text.

Developers can either use the setContent(String) method to set any text they want to display for the contents of the cell or override this method to inherit its functionality and build on top of it.

The following is an example of the code that is executed by this method:

 public void generateContent(MarkupOutput mo) {
     generateText(mo);
 }
 

As an example, the following code could be used to extend this method to add a <BR> tag after content in any of the classes that extend AbstractReportGridDisplayCell:

 public void generateContent(MarkupOutput mo) {
     super.generateContent(mo);

     mo.append("<br>");
 }
 

Generate the context menu for this cell.

Generate drag and drop properties used in javascript.

Returns a Map with the tag attributes that should be added to the cell's definition to enable drag and drop operations.
Notice this method has been deprecated for performance reasons. If it's necessary to include extra attributes related to context-menus override the addDragAndDropAttributes(Map) method. Although this method is still invoked under normal cell execution, it now returns null. If a subclass overrides this method and returns a Map instance, the members of the Map are appended to the cell's tag attributes.

generate output for checkboxes for drill

Generate the drill check box HTML information for this cell.

generate output for checkboxes for drill

Generates the tag information for a check box for drilling, if all privileges and conditions required are met

Generate open anchor for drill link for header elements

Generate open anchor for drill link for header elements

generate output for the checkbox for Filter on Selections

Generate the filter on selections check box HTML information

generate output for the checkbox for Filter on Selections

Generates the tag information for a check box for filter on selection, if all privileges and conditions required are met

Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.

Generate the drilling context menus for cells that use WebHeader as their underlying SDK object.

Generate the sort context menus for cells that use WebHeader as their underlying SDK object.

Generate the sort context menus for cells that use WebHeader as their underlying SDK object.

This method generates the HTML that goes inside of the <TD> tag. It divides the output by calling three methods:

1. generateContent: generates the core portion of the HTML, it include the cell's text and its corresponding HTML.
2. generatePreContent: generates the HTML that goes before the content. This is used to generate the checkboxes for drilling.
3. generatePostContent: generates the HTML that goes after the content. This is used to generate sorting and pivoting buttons.

Developers can either use the setInnerHTML(String) method to set any text they want for the inner HTML or override this method to inherit its functionality and build on top of it.

 protected void generateInnerHTML(MarkupOutput mo) {
     generatePreContent(mo);
     generateContent(mo);
     generatePostContent(mo);
 }
 

Generate the javascript images for collapse and expand for outline mode.

Generate the name of the subtotal type next to the header element for outline mode.

Generate pivot buttons.

Generates the postContent of the cell. The post-Content means the html content after the core content of the cell. Usually this method generates sort and pivot buttons as well as subtotals for outline mode.

Developers can either use the setPostContent(String) method to set any text they want to display after the contents of the cell or override this method to inherit its functionality and build on top of it.

 public void generatePostContent(MarkupOutput mo) {
     super.generatePostContent(mo);

     mo.append("<INPUT TYPE=\"SUBMIT\" NAME=\"Submit request\" />");
 }
 

Generates the preContent of the cell. The pre-Content means the html content before the core content of the cell. An example would be a checkbox before the text.
By default, this method generates images for grids in outline mode, drilling checkboxes and filter on selection checkboxes.

Developers can either use the setPreContent(String) method to set any text they want to display before the contents of the cell or override this method to inherit its functionality and build on top of it.

 public void generatePreContent(MarkupOutput mo) {
     super.generatePreContent(mo);

     mo.append("<LI>");
 }
 

Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.

Generate the drilling context menus for cells that use WebRowValue as their underlying SDK object.

Generate the sort button tag information for this object

Generate sort button for this cell.

Generates the text of the cell. This is the the text that gets displayed by the browser.

Developers can either use the setText(String) method to set any text they want to display for the cell or override this method to inherit its functionality and build on top of it.

 public void generateText(MarkupOutput mo) {
     String text = getText();

     if ("".equals(text) || " ".equals(text)) {
         mo.append("-");
     } else {
         super.generateText(mo);
     }

 }
 

Generates the HTML when the metric value is a "quick symbol" threshold.

Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.

Generate the drilling context menus for cells that use WebTitle as their underlying SDK object.

Generate the sort context menus for cells that use WebTitle as their underlying SDK object.

Generate the sort context menus for cells that use WebTitle as their underlying SDK object.