java.lang.Object | ||
↳ | com.microstrategy.web.app.transforms.AbstractReportGridDisplayCell | |
↳ | com.microstrategy.web.app.transforms.AbstractReportGridCellHeader |
![]() |
![]() |
This class serves as base implementation for other classes such as
ReportGridCellColHeaderImpl
and ReportGridCellRowHeaderImpl
which render Cell Header information of a Grid to be presented to the user.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | AbstractReportGridCellHeader.AxisDepth |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AbstractReportGridCellHeader() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean |
canAddThresholds()
Utility method for determining if the cell object is enabled for
displaying the user the option to add threshold to it
| ||||||||||
boolean |
canDrill()
Utility methood for determining if the cell object is enabled for displaying the user
the option to drill on it
| ||||||||||
boolean |
canDrillAdvanced()
Utility methood for determining if the cell object is enabled for
displaying the user the option for advanced drilling on it
| ||||||||||
boolean |
canEditControl()
Utility methood for determining if the cell object is enabled for displaying the user
the option to edit control
| ||||||||||
boolean |
canFilterOn()
Utility methood for determining if the cell object is enabled for
displaying the user the option to filter on it
| ||||||||||
boolean | canFilterOnSelection() | ||||||||||
boolean |
canFormat()
Utility methood for determining if the cell object is enabled for
displaying the user the option to format it
| ||||||||||
boolean | canHaveDerivedElements() | ||||||||||
boolean |
canHyperLink()
Utility method for determining if the cell object is enabled for displaying the
user the option to navigate to custom hyperlinks
| ||||||||||
boolean |
canMetricFilterOn()
Utility method for determining if the cell object is enabled for displaying the user
the option to apply a metric filter on it
| ||||||||||
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
| ||||||||||
boolean | canOpenAlerts() | ||||||||||
boolean | canQuickGroup() | ||||||||||
boolean |
canRemoveFromGrid()
Utility methood for determining if the cell object is enabled for
displaying the user the option to remove it from the grid.
| ||||||||||
boolean |
canRemoveFromReport()
Utility methood for determining if the cell object is enabled for
displaying the user the option to remove it from the report
| ||||||||||
boolean |
canRename()
Utility methood for determining if the cell object is enabled for
displaying the user the option to rename it
| ||||||||||
WebEvent | getDerivedElementsEvent() | ||||||||||
WebDrillPath |
getDrillPathWithHighImportance()
generate drilling url parameters for DHTML mode
| ||||||||||
WebEvent |
getFilterOnEvent()
Get the event for filter on the cell header instance
| ||||||||||
WebEvent |
getInsertMetricPercentToTotalEvent(int axisBitMap, String attributeID)
Get the event for inserting a new metric based on Percent to Total
| ||||||||||
WebEvent |
getInsertMetricPercentToTotalEvent(int axisBitMap)
Get the event for inserting a new metric based on Percent to Total
| ||||||||||
WebEvent |
getInsertMetricRankEvent(String attributeID, int sortOrder)
Get the event for inserting a new metric based on a rank
| ||||||||||
WebEvent |
getInsertMetricTransformationEvent(String transformationID, int formulaType)
Get the event for inserting a new metric based on a transformation
| ||||||||||
int | getKey() | ||||||||||
WebEvent |
getOpenFormatEditorEvent()
Get the event for opening the format editor for the requested target.
| ||||||||||
WebEvent |
getRenameEvent()
Get the event for renaming the current cell
| ||||||||||
WebEvent |
getSetFormatEditorTargetEvent()
Get the event for setting the current target of the format editor to be this cell instance
| ||||||||||
WebHeader |
getWebHeader()
Obtain the
WebHeader instance associated with this class | ||||||||||
WebTemplateMetric |
getWebTemplateMetric()
Obtain the
WebTemplateMetric instance directly associated with
this class | ||||||||||
WebTemplateMetric |
getWebTemplateMetric(boolean retrieve)
Obtain the
WebTemplateMetric instance associated with this class | ||||||||||
boolean | hasMetricFilterCondition() | ||||||||||
void |
init(WebComponent wc, WebTemplateMetric metric, HashMap cachedObjects)
This method is deprecated.
use the
init(TransformContext, WebTemplateMetric)
interface instead
| ||||||||||
void |
init(TransformContext context, WebTemplateMetric metric)
This method is called to initialize the cell in design mode.
| ||||||||||
boolean | isDerivedMetric() | ||||||||||
boolean |
isMetric()
Indicates if the underlying object of a cell is a metric header.
| ||||||||||
boolean |
isMetricDrillable(WebHeader header, WebDrillPath drillPath)
return whether the header has a drillable metric
| ||||||||||
boolean | isTemplateMetric(WebHeader header) | ||||||||||
boolean | isTypeMetric() | ||||||||||
void |
reset()
Reset all of the instance variables.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
addContextMenuAttributes(Map atts)
Obtain the tag attributes that should be added to the cell's definition
for processing context menus
Map instance with the attribute context menu information
| ||||||||||
void | addToHeaderMetricValueJsonMap(String key, String value) | ||||||||||
boolean | canExpandCollapse() | ||||||||||
boolean | canFilter() | ||||||||||
boolean |
canHyperlinkForCurrentHTMLMode()
On the OOB implementation this will return true if isDHTML returns true, but subclasses might override it.
| ||||||||||
boolean |
cellNeedsLink()
Utility method for determining if the current cell being displayed needs to be a link or
not, for example, in case of drilling available.
| ||||||||||
void |
generateContent(MarkupOutput mo)
Extends
generateContent by adding a URL link to the cell's
text. | ||||||||||
AnchorTag | generateControlAnchor() | ||||||||||
AnchorTag |
generateDrillAnchor()
Utility method for generating the
AnchorTag instance with all the
drill information if available for the current cell being displayed by
this instance. | ||||||||||
Tag |
generateDrillCheckBoxTag()
Generates the tag information for a check box for drilling, if all privileges
and conditions required are met
| ||||||||||
AnchorTag |
generateElementAnchor()
Utility method for generating the
AnchorTag instance for the
element being rendered . | ||||||||||
Tag |
generateFilterOnSelectionCheckBoxTag()
Generates the tag information for a check box for filter on selection, if all privileges
and conditions required are met
| ||||||||||
AnchorTag | generateHyperLinkAnchor() | ||||||||||
void | generateRAPreContent(MarkupOutput mo) | ||||||||||
AnchorTag | generateStaticHyperLinkAnchor() | ||||||||||
void |
generateText(MarkupOutput mo)
Generate the text of the cell
| ||||||||||
String |
generateTooltipContent()
Generates the string with the tooltip information to be assigned to the
TITLE attribute of the cell tag for this instance
| ||||||||||
AbstractReportGridCellHeader.AxisDepth |
getAxisDepth()
Depth is 1-based
| ||||||||||
void | getCellAttributes(Map attributes) | ||||||||||
void |
getCellLevelAttributes(Map cell)
CTY indicates the cell type UPT indicates the template unit that it
belongs to, in the format of "axis,position"
| ||||||||||
String |
getDrillParametersForDHTML(WebDrillPath dp)
Returns parameters required for drilling when using javascript for cells
that use
WebHeader as their underlying SDK
object. | ||||||||||
int | getMaxPosition() | ||||||||||
String | getMetricID() | ||||||||||
String |
getOnClickAttForDrillPath(WebDrillPath drillPathWithHighImportance)
Some subclases wont need the onclick attribute at all, overriding the method and returning null will help on that case
| ||||||||||
String | getParentElementIndex() | ||||||||||
String | getParentFormValueIndex() | ||||||||||
int | getPosition() | ||||||||||
WebEvent |
getSelectorEvent()
get the selector Event to gnereate the anchor in HTML mode
| ||||||||||
StringBuffer |
getURLBuffer()
This method is deprecated.
if the link information for drilling should be modified,
please update the
generateDrillAnchor() method.
| ||||||||||
boolean | hasRuntimeUnitLimit() | ||||||||||
abstract boolean | isDrillAvailable() | ||||||||||
abstract boolean |
isDrillPathAvailable(WebHeader header)
Utility method to determine if the current header has drill information
available
| ||||||||||
boolean | isHeaderMVJsonMovable() | ||||||||||
boolean | isTotal() | ||||||||||
void | processHyperLinkNavigationInfo() | ||||||||||
void |
setWebHeader(WebHeader header)
Define the
WebHeader instance to be rendered. | ||||||||||
void |
setWebTemplateMetric(WebTemplateMetric metric)
Define the
WebTemplateMetric instance to be rendered. | ||||||||||
boolean |
shouldHiliteOnServer()
Indicate if it's necessary to hilight the selected element on server side.
| ||||||||||
boolean |
showPivotForLastAttrRowInCol()
When 'Remove Extra Column' is cheched, and a Attribute is placed as last row in Column then its title is not visible.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Utility method 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 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 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 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
generate drilling url parameters for DHTML mode
Get the event for filter on the cell header instance
WebEvent
instance initialized for filtering on the information of this cellGet the event for inserting a new metric based on Percent to Total
axisBitMap | identifier of the axis to be used for calculating the metric information.
Values expected come from the EnumDSSXMLAxesBitMap enumeration. |
---|---|
attributeID | identifier of the attribute at which the metric will be calculated |
WebEvent
initialized with the event information for inserting a new metric.
Get the event for inserting a new metric based on Percent to Total
axisBitMap | identifier of the axis to be used for calculating the metric information.
Values expected come from the EnumDSSXMLAxesBitMap enumeration. |
---|
WebEvent
initialized with the event information for inserting a new metric.
Get the event for inserting a new metric based on a rank
attributeID | identifier of the attribute at which the metric will be calculated |
---|---|
sortOrder | int with the sort order to be used on the new rank metric. Values expected
include SORT_ORDER_ASCENDING and
SORT_ORDER_DESCENDING |
WebEvent
initialized with the event information for inserting a new metric.
Get the event for inserting a new metric based on a transformation
transformationID | identifier of the role of the transformation to be used |
---|---|
formulaType | identifier of the type of formula to be used. Values expected come from the EnumDSSXMLMetricFormulaType enumeration |
WebEvent
initialized with the event information for inserting a new metric.
Get the event for opening the format editor for the requested target.
WebEvent
initialized instance. If it could not be generated, it will
return null
Get the event for renaming the current cell
WebEvent
instance initialized with the information for renaming the current
cell.Get the event for setting the current target of the format editor to be this cell instance
WebEvent
instance initialized for setting the target of the format editor
to be the current cell instance.Obtain the WebTemplateMetric
instance directly associated with
this class
WebTemplateMetric
instance from where the information to
be rendered by this class will be retrieved.
Obtain the WebTemplateMetric
instance associated with this class
retrieve | boolean flag that if true indicates it will search also on the header information and the template's metric collection for the metric represented here. |
---|
WebTemplateMetric
instance from where the information to
be rendered by this class will be retrieved.
This method is deprecated.
use the init(TransformContext, WebTemplateMetric)
interface instead
Initialize this class with the cell information to consider for HTML generation
wc | WebComponent base instance |
---|---|
metric | WebTemplateMetric instance related with the cell to be
rendered |
cachedObjects | HashMap instance with information relevant to this instance for HTML generation. |
This method is called to initialize the cell in design mode. It receives
a WebTemplateMetric
as the underlying SDK object.
context | TransformContext instance initialized with the grid's
transform information. |
---|---|
metric | WebTemplateMetric instance corresponding to the cell
to be displayed.
|
Indicates if the underlying object of a cell is a metric header.
return whether the header has a drillable metric
header | the header object |
---|---|
drillPath | the drill path |
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.
Obtain the tag attributes that should be added to the cell's definition for processing context menus Map instance with the attribute context menu information
atts | Map where attributes will be appended. |
---|
On the OOB implementation this will return true if isDHTML returns true, but subclasses might override it.
Utility method for determining if the current cell being displayed needs to be a link or not, for example, in case of drilling available.
Extends generateContent
by adding a URL link to the cell's
text.
Developers can either use the setContent(String)
method to set any text
they want to display as the cell's contents or override this method to
inherit its functionality and build on top of it.
As an example, the following code could be used to extend this method to
add a <BR> tag after cell's content:
public void generateContent(MarkupOutput mo) { super.generateContent(mo); mo.append("<br>"); }
mo | the output object |
---|
Generates the tag information for a check box for drilling, if all privileges and conditions required are met
Tag
instance initialized with the information of a check box for
requesting drill manipulations. If not enabled or available, returns null
Generates the tag information for a check box for filter on selection, if all privileges and conditions required are met
Tag
instance initialized with the information of a check box for
requesting a filter on selection manipulations. If not enabled or available, returns null
Generate the text of the cell
mo | MarkupOutput instance where the HTML contents
generated will be saved
|
---|
Generates the string with the tooltip information to be assigned to the TITLE attribute of the cell tag for this instance
CTY indicates the cell type UPT indicates the template unit that it belongs to, in the format of "axis,position"
Returns parameters required for drilling when using javascript for cells
that use WebHeader
as their underlying SDK
object.
dp | the drill path |
---|
Some subclases wont need the onclick attribute at all, overriding the method and returning null will help on that case
canHyperLink()
returns false
This method is deprecated.
if the link information for drilling should be modified,
please update the generateDrillAnchor()
method.
Specify URL information to be used as drilling information for the header being rendered
Utility method to determine if the current header has drill information available
header | WebHeader instance to analyze |
---|
Define the WebTemplateMetric
instance to be rendered.
metric | WebTemplateMetric instance from where the information
to render by this class will be retrieved.
|
---|
Indicate if it's necessary to hilight the selected element on server side.
When 'Remove Extra Column' is cheched, and a Attribute is placed as last row in Column then its title is not visible. Therefore if the Attribute Elements is the last row in Column headers, we need show pivot buttons for each attribute element.