ReportGridCellColTitle

Class Overview

The ReportGridCellColTitle represents a title of the column axis.

Classes implementing this interface need to deal with different type of SDK objects:

1. WebTitle: used in view mode, this is the SDK object that represents a title of the column axis.
2. WebSubTitle: used in view mode when attribute forms are being displayed, for each attribute form there will be a corresonding WebSubTitle.
3. WebTemplateUnit: used in design mode, this is the SDK object used in a template for the column axis.

Users can modify the HTML generated for a column title cell by creating a custom class that implements this interface. The easiest way to accomplish this is to extend the out-of-the-box implementation provided by Microstrateg Web, that is the ReportGridCellColTitleImpl.

Summary

[Expand] Inherited Constants

From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell int PIVOT_DECREASE_POSITION Identifier for the pivot button that will decrease the position of the object in the collection, for example, move it to the left in case of row title, or move it up if a column title int PIVOT_INCREASE_POSITION Identifier for the pivot button that will increase the position of the object in the collection, for example, move it to the right in case of row title, or move it down if a column title int PIVOT_REMOVE Identifier for the pivot button that will remove the object from the template int PIVOT_SWITCH_AXIS Identifier for the pivot button that will change of axis the object in the template, for example, move it to columns in case of row title, or move it to rows if a column title int PIVOT_TO_PAGE_BY Identifier for the pivot button that will move the object to the page by section

[Expand] Inherited Methods
From interface com.microstrategy.web.app.transforms.ReportGridCellTitle abstract boolean canAddShortcutMetric(int shortcutMetricType) Returns whether specified shortcut metric could be created based on current cell. abstract WebEvent getAddShortcutMetricEvent(int shortcutMetricType) Returns the WebEvent to add shortcut metric based on current cell. abstract WebSubTitle getSubTitle() Returns the underlying SDK object associated with this cell. abstract int getSubtitleIndex() If attribute forms are displayed, returns the position of the WebSubTitle within the subtitles collection. abstract WebTemplateUnit getWebTemplateUnit() Obtain the WebTemplateUnit instance associated with this class abstract WebTitle getWebTitle() Obtain the WebTitle instance associated with this class abstract void init(TransformContext context, WebTemplateUnit unit) This method is called to initialize the cell in design mode. abstract void init(WebComponent wc, WebTitle title, HashMap cachedObjects) This method is deprecated. please use the interface that takes a TransformContext object instance as parameter abstract void init(WebComponent wc, WebTemplateUnit unit, HashMap cachedObjects) This method is deprecated. please use the interface that takes a TransformContext object instance as parameter abstract void init(TransformContext context, WebTitle title) This method is called to initialize the cell in view mode. abstract void setSubTitle(WebSubTitle subtitle) Registers the underlying SDK object associated with this cell. abstract void setSubTitleIndex(int subtitleIndex) Registers the position of the underlying WebSubTitle within the subtitles collection.
From interface com.microstrategy.web.app.transforms.ReportGridDisplayCell abstract void addExtraAttribute(String attributeName, String attributeValue) Define extra tag attributes and their values that shall be included on the table cell definition for the current instance being rendered abstract boolean canAddThresholds() Utility method for determining if the cell object is enabled for displaying the user the option to add advanced thresholds abstract boolean canDrill() Utility methood for determining if the cell object is enabled for displaying the user the option to drill on it abstract boolean canDrillAdvanced() Utility methood for determining if the cell object is enabled for displaying the user the option for advanced drilling on it abstract boolean canEditControl() Utility methood for determining if the cell object is enabled for displaying the user the option to edit control abstract boolean canEditMetricFilter() Utility method for determining if the cell object is enabled editing a metric filter abstract boolean canFilterOn() Utility methood for determining if the cell object is enabled for displaying the user the option to filter on it abstract boolean canFilterOnSelection() abstract boolean canFormat() Utility methood for determining if the cell object is enabled for displaying the user the option to format it abstract boolean canHaveDerivedElements() abstract boolean canHyperLink() Utility method for determining if the cell object is enabled for displaying the user the option to navigate to custom hyperlinks abstract boolean canInsertShortcutMetric() Utility methood for determining if the cell object is enabled for displaying the user the option to insert shortcut metrics based on it abstract boolean canMetricFilterOn() Utility method for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it abstract boolean canModifyAttributeForm() Utility methood for determining if the cell object is enabled for displaying the user the option to modify the attribute forms on it abstract boolean canOpenAlerts() abstract boolean canPivot(int type) Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it according to the type specified abstract boolean canPivot() Utility methood for determining if the cell object is enabled for displaying the user the option to pivot it abstract boolean canQuickGroup() abstract boolean canRemoveFromGrid() Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the grid. abstract boolean canRemoveFromReport() Utility methood for determining if the cell object is enabled for displaying the user the option to remove it from the report abstract boolean canRename() Utility methood for determining if the cell object is enabled for displaying the user the option to rename it abstract boolean canSort() Utility methood for determining if the cell object is enabled for displaying the user the option to sort it abstract void generateOutput(MarkupOutput mo) This is the main entry point to generate the output of the cell. abstract String getAccessibilityInfo() This method is deprecated. addExtraAttribute(String, String) is used instead for specifying the accessibility information, for example, addExtraAttribute("scope", "row"); abstract String getCellID() Returns the id for this cell, this should be the one used as the ID attribute of TD tag. abstract int getCellType() This method is deprecated. The cell type is not significant anymore for the application. abstract int getColSpan() Returns the column span for this cell, this should be the one used as the COLSPAN attribute of TD tag. abstract WebEvent getControlElementSelectorEvent(RWControl control, String elementList) abstract WebEvent getDerivedElementsEvent() abstract WebEvent getDrillEvent(WebDrillPath dp, String elementKey, WebTitle title) Returns the WebEvent to drill from the cell to the given drill path. abstract WebDrillPath getDrillPathWithHighImportance() Obtain the Drill path with high importance information for the current cell being analyzed. abstract String getExtraInfo() Returns the text assigned as extra information of the cell. abstract String getExtraStyle() Returns the extra style information required for the formatting of the cell. abstract WebEvent getFilterOnEvent() Get the event for filter on the cell header instance abstract String getHeaderContent(WebHeader header) This method is deprecated. The Transform doesn't call this method. Users who require to customize the text-content of a header should override getText() abstract int getKey() abstract WebEvent getOpenFormatEditorEvent() Get the event for opening the format editor abstract WebEvent getRenameEvent() Get the event for renaming the current cell abstract int getRowSpan() Returns the row span for this cell, this should be the one used as the ROWSPAN attribute of TD tag. abstract WebEvent getSetFormatEditorTargetEvent() Get the event for setting the current target of the format editor to be this cell instance abstract String getStyle() Returns the css class name associated with the cell. abstract String getText() Returns the text content of this cell. abstract String getTooltip() Returns the tooltip text for this cell. abstract String getWidth() Returns the width for this cell, this should be the one used as the WIDTH attribute of TD tag. abstract void init(TransformContext context) Initializes the instance. abstract void init(WebComponent wc, FormalParameters formalParas) This method is deprecated. This method is not used by the Transform anymore. To initialize empty cells it now uses init(TransformContext). abstract void init(WebComponent wc, HashMap cachedObjects) This method is deprecated. use the init interface that receives a ReportGridTransformImpl.Context object abstract void init(FormalParameters formalParas) This method is deprecated. This method is not used by the Transform anymore. To initialize empty cells it now uses init(TransformContext). abstract boolean isRW() Utility methood for determining whether it is a RW execution. abstract void reset() Reset all of the instance variables. abstract void setAccessibilityInfo(String accessibilityInfo) This method is deprecated. please use addExtraAttribute(String, String) instead, for example, addExtraAttribute("scope", "row"); abstract void setCellID(String cellID) Registers the id for this cell, this should be used as the ID attribute of TD tag. abstract void setColSpan(int colSpan) Registers the column span for this cell, this should be used as the COLSPAN attribute of TD tag. abstract void setContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the content should override generateContent(MarkupOutput) abstract void setContextMenu(String contextMenu) This method is deprecated. use the context menu infrastructure for defining this information, or the addExtraAttribute(String, String) method for adding tag attributes. abstract void setExtraInfo(String extraInfo) Registers any extra information that should be appended as part of the TD's open tag. abstract void setExtraStyle(String value, boolean append) Updates values to the STYLE attribute of the TD tag. abstract void setExtraStyle(String extraStyle) This method is deprecated. use instead abstract void setHTML(String html) This method is deprecated. The Transform doesn't call this method. Users who require to customize the HTML should override generateOutput(MarkupOutput) abstract void setInnerHTML(String innerHTML) This method is deprecated. The Transform doesn't call this method. Users who require to customize the inner HTML should override generateInnerHTML(MarkupOutput) abstract void setPostContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the post-content should override generatePostContent(MarkupOutput) abstract void setPreContent(String content) This method is deprecated. The Transform doesn't call this method. Users who require to customize the pre-content should override generatePreContent(MarkupOutput) abstract void setRowSpan(int rowSpan) Registers the row span for this cell, this should be used as the ROWSPAN attribute of TD tag. abstract void setStyle(String style) Registers the css style name associated with the cell. abstract void setText(String text) Registers the text content of this cell. abstract void setTooltip(String tooltip) Registers the text for the tooltop of this cell. abstract void setWidth(String width) Registers the width for this cell, this should be used as WIDTH attribute of TD tag.