Class ReportGridDisplayCellColTitle
- java.lang.Object
-
- com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
-
- com.microstrategy.web.app.transforms.ReportGridDisplayCellColTitle
-
- All Implemented Interfaces:
ReportGridCell
,ReportGridCellColTitle
,ReportGridCellTitle
,ReportGridDisplayCell
,java.lang.Cloneable
public class ReportGridDisplayCellColTitle extends ReportGridDisplayCellImpl implements ReportGridCellColTitle
Deprecated.Please use the ReportGridCellColTitle interface or extend the ReportGridCellColTitleImpl class.This class represents a Column Title cell cell of the report grid.
This class has been deprecated along with all the ReportGridDisplayCell classes.
In its place, the Transform manipulates the cells through the ReportGridCell interface.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
ReportGridDisplayCell.Context
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
_advDrillEditorProcessEvent, _advdrillEvent, _appliedSorts, _cachedObjects, _drillEditorName, _drillEditorProcessEvent, _drillEvent, _drillFilterOnSelectionProcessEvent, _drillFilterPageBy, _imgBasePath, _isIFrameRequest, _isNetscape, _itemsAddedToContextMenu, _maxColHeaderDepth, _sortEvent, _sortSubtotalColPosition, _sortSubtotalPostion, _specifyIDForCell, _specifyWidthForCell, _text, formalParas, rb
-
Fields inherited from interface com.microstrategy.web.app.transforms.ReportGridCellColTitle
SORT_TYPE_ASCENDING, SORT_TYPE_DESCENDING
-
Fields inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
PIVOT_DECREASE_POSITION, PIVOT_INCREASE_POSITION, PIVOT_REMOVE, PIVOT_SWITCH_AXIS, PIVOT_TO_PAGE_BY
-
-
Constructor Summary
Constructors Constructor Description ReportGridDisplayCellColTitle()
Deprecated.Constructor for displaying column title in execute modeReportGridDisplayCellColTitle(ReportBean rb, WebTemplateUnit unit, java.util.HashMap cachedObjects)
Deprecated.Constructor used for template editor in design mode.ReportGridDisplayCellColTitle(ReportBean rb, WebTitle title, java.util.HashMap cachedObjects)
Deprecated.Constructor for displaying column title in execute modeReportGridDisplayCellColTitle(FormalParameters formalParas)
Deprecated.Constructor used for creating a generic display cell.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canAddShortcutMetric(int shortcutMetricType)
Deprecated.Returns whether specified shortcut metric could be created based on current cell.void
generateColTitleContent(MarkupOutput mo)
Deprecated.protected void
generateContent(MarkupOutput mo)
Deprecated.Override the protected method of ReportDisplayCellImpl.protected void
generateContextMenu(MarkupOutput mo)
Deprecated.Override the protected method in ReportDisplayCellImpl.protected void
generatePivotButtons(MarkupOutput mo)
Deprecated.Override the protected method in ReportDisplayCellImpl.protected void
generateTooltip(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.WebEvent
getAddShortcutMetricEvent(int shortcutMetricType)
Deprecated.Returns the WebEvent to add shortcut metric based on current cell.int
getCellType()
Deprecated.Returns the cell typeWebEvent
getDerivedElementsEvent()
Deprecated.WebEvent
getFilterOnEvent()
Deprecated.Get the event for filter on the cell header instanceint
getKey()
Deprecated.WebEvent
getOpenFormatEditorEvent()
Deprecated.Get the event for opening the format editorWebEvent
getRenameEvent()
Deprecated.Get the event for renaming the current cellWebEvent
getSetFormatEditorTargetEvent()
Deprecated.Get the event for setting the current target of the format editor to be this cell instanceWebEvent
getSortEvent(int type)
Deprecated.Get theWebEvent
instance with the information for sorting the current cell valuesint
getSubtitleIndex()
Deprecated.Returns the subtitle index for this cellWebTemplateUnit
getWebTemplateUnit()
Deprecated.if in report design mode, return the WebTemplateUnit object associated with this cell; if in report execute mode, return nullWebTitle
getWebTitle()
Deprecated.if in report execute mode, return the WebTitle object associated with this cell if in report design mode, return nullvoid
init(TransformContext context, WebTemplateUnit unit)
Deprecated.This method is called to initialize the cell in design mode.void
init(TransformContext context, WebTitle title)
Deprecated.This method is called to initialize the cell in view mode.void
init(WebComponent wc, WebTemplateUnit unit, java.util.HashMap cachedObjects)
Deprecated.This method is called to initialize the cell in design mode.void
init(WebComponent wc, WebTitle title, java.util.HashMap cachedObjects)
Deprecated.This method is called to initialize the cell in view mode.protected void
initDNDForDesignMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a column title cell in design modeprotected void
initDNDForExecuteMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a column title cell in execute modeboolean
isSortAscending()
Deprecated.boolean
isSorted()
Deprecated.void
reset()
Deprecated.Reset all of the instance variables.-
Methods inherited from class com.microstrategy.web.app.transforms.ReportGridDisplayCellImpl
addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, clone, convertNonbreakingSpaceOnMV, decodeEuro, encodeMV, generateDragAndDrop, generateDrillCheckBox, generateDrillCheckBox, generateDrillOpenLink, generateFilterOnSelectionCheckBox, generateFilterOnSelectionCheckBox, generateHeaderDrillContextMenu, generateHeaderSortContextMenu, generateInnerHTML, generateOutlineModeImage, generateOutlineSubTotalName, generateOutput, generatePostContent, generatePreContent, generateRowValueDrillContextMenu, generateSortButton, generateTitleDrillContextMenu, generateTitleSortContextMenu, generateTooltipContent, generateTooltipForHeaders, generateTooltipForRowValue, generateTooltipForTitles, getAccessibilityInfo, getCellID, getColHeaderWebMetric, getColSpan, getContextMenuAttributes, getContextMenuManager, getControlElementSelectorEvent, getCssPrefix, getDescription, getDescriptor, getDrillEvent, getDrillPath, getDrillPathWithHighImportance, getEventManager, getExtraInfo, getExtraStyle, getExtraUrl, getFPIntValue, getFPStringValue, getHeaderContent, getHeaderDrillParametersForDHTML, getHeaderDrillPathWithHighImportance, getHeaderDrillURL, getImgName, getMaxSortAllowed, getPostTextForMetricValue, getPostTextForNonMetricValue, getPreTextForMetricValue, getPreTextForNonMetricValue, getReportBean, getReportDesignMode, getRowSpan, getRowValueDrillElements, getRowValueDrillParametersForDHTML, getRowValueDrillPathWithHighImportance, getRowValueDrillURL, getShowDescriptionAsTooltip, getSortStatus, getStyle, getSubTitle, getText, getTitleDrillParametersForDHTML, getTitleDrillURL, getTooltip, getWidth, init, init, init, init, initDragAndDrop, isContextMenuEnabled, isDesignMode, isDragAndDropEnabled, isFPTrue, isFPTrue, isHeaderNeedLink, isIFrameEnabled, isIFrameRequest, isItemsAddedToContextMenu, isMetric, isMetricDrillable, isOutlineModeEnabled, isRowValueNeedLink, isRW, isSortAscending, isTitleNeedLink, setAccessibilityInfo, setCellID, setCellType, setColSpan, setContent, setContextMenu, setDescription, setDrillPath, setExtraInfo, setExtraStyle, setExtraStyle, setExtraUrl, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setStyleForNonBuiltInFormat, setSubTitle, setSubTitleIndex, setText, setTooltip, setWidth, showBanding, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillRMC, showDrillRMCMetric, showFilterOnSelectionCheckBox, showFormattingRMC, showPivot, showPivotRMC, showRemove, showRemoveRMC, showRenameRMC, showSortButtonsForAttributes, showSortButtonsForMetrics, showSortRMCForAttributes, showSortRMCForMetrics, showSubTitle, useBuiltInFormat
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridCellTitle
getSubTitle, setSubTitle, setSubTitleIndex
-
Methods inherited from interface com.microstrategy.web.app.transforms.ReportGridDisplayCell
addExtraAttribute, canAddThresholds, canDrill, canDrillAdvanced, canEditControl, canEditMetricFilter, canFilterOn, canFilterOnSelection, canFormat, canHaveDerivedElements, canHyperLink, canInsertShortcutMetric, canMetricFilterOn, canModifyAttributeForm, canOpenAlerts, canPivot, canPivot, canQuickGroup, canRemoveFromGrid, canRemoveFromReport, canRename, canSort, generateOutput, getAccessibilityInfo, getCellID, getColSpan, getControlElementSelectorEvent, getDrillEvent, getDrillPathWithHighImportance, getExtraInfo, getExtraStyle, getHeaderContent, getRowSpan, getStyle, getText, getTooltip, getWidth, init, init, init, init, isRW, setAccessibilityInfo, setCellID, setColSpan, setContent, setContextMenu, setExtraInfo, setExtraStyle, setExtraStyle, setHTML, setInnerHTML, setPostContent, setPreContent, setRowSpan, setStyle, setText, setTooltip, setWidth
-
-
-
-
Constructor Detail
-
ReportGridDisplayCellColTitle
public ReportGridDisplayCellColTitle()
Deprecated.Constructor for displaying column title in execute mode- Since:
- MicroStrategy Web 8.0.0
-
ReportGridDisplayCellColTitle
public ReportGridDisplayCellColTitle(FormalParameters formalParas)
Deprecated.Constructor used for creating a generic display cell.- Parameters:
formalParas
- all the formal parameters from the report transform. Used to control some output generation. For example, the cssPrefix is needed for the empty cells in design mode.
-
ReportGridDisplayCellColTitle
public ReportGridDisplayCellColTitle(ReportBean rb, WebTemplateUnit unit, java.util.HashMap cachedObjects)
Deprecated.Constructor used for template editor in design mode. As single action doesn't apply the changes to I-server until "Execute"/"Sava as" button is done, ReportGrid is not updated, so we shall not use WebHeader to build this DisplayCell- Parameters:
rb
- the associated report beanunit
- the associated template unitcachedObjects
- cached object, used to store some information shared across multiple cells
-
ReportGridDisplayCellColTitle
public ReportGridDisplayCellColTitle(ReportBean rb, WebTitle title, java.util.HashMap cachedObjects)
Deprecated.Constructor for displaying column title in execute mode- Parameters:
rb
- associated report beantitle
- assocated column titlecachedObjects
- cached object, used to store some information shared across multiple cells
-
-
Method Detail
-
reset
public void reset()
Deprecated.Description copied from interface:ReportGridDisplayCell
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.- Specified by:
reset
in interfaceReportGridDisplayCell
- Overrides:
reset
in classReportGridDisplayCellImpl
-
getCellType
public int getCellType()
Deprecated.Returns the cell type- Specified by:
getCellType
in interfaceReportGridDisplayCell
- Overrides:
getCellType
in classReportGridDisplayCellImpl
- Returns:
- the cell type: EnumReportGridDisplayCellTypes.EnumReportGridDisplayCellTypeColTitle. The cell type is read-only.
-
init
public void init(TransformContext context, WebTitle title)
Deprecated.Description copied from interface:ReportGridCellTitle
This method is called to initialize the cell in view mode. It receives aWebTitle
instance as the underlying SDK object- Specified by:
init
in interfaceReportGridCellTitle
- Parameters:
context
-TransformContext
instance initialized with the grid's transform information.title
-WebTitle
instance corresponding to the cell to be displayed.- Since:
- MicroStrategy Web 8.0.1
-
init
public void init(TransformContext context, WebTemplateUnit unit)
Deprecated.Description copied from interface:ReportGridCellTitle
This method is called to initialize the cell in design mode. It receives aWebTemplateUnit
instance as the underlying SDK object- Specified by:
init
in interfaceReportGridCellTitle
- Parameters:
context
-TransformContext
instance initialized with the grid's transform information.unit
-WebTemplateUnit
instance corresponding to the cell to display.- Since:
- MicroStrategy Web 8.0.1
-
getWebTitle
public WebTitle getWebTitle()
Deprecated.if in report execute mode, return the WebTitle object associated with this cell if in report design mode, return null- Specified by:
getWebTitle
in interfaceReportGridCellTitle
- Returns:
- the WebTitle object
-
getWebTemplateUnit
public WebTemplateUnit getWebTemplateUnit()
Deprecated.if in report design mode, return the WebTemplateUnit object associated with this cell; if in report execute mode, return null- Specified by:
getWebTemplateUnit
in interfaceReportGridCellTitle
- Returns:
- the WebTemplateUnit object
-
init
public void init(WebComponent wc, WebTitle title, java.util.HashMap cachedObjects)
Deprecated.Description copied from interface:ReportGridCellTitle
This method is called to initialize the cell in view mode. It receives aWebTitle
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellTitle
- Parameters:
wc
- The bean being transformed.title
- TheWebTitle
corresponding to this cell.cachedObjects
- AHashMap
populated by the transform and used to store information shared across multiple cells.- Since:
- MicroStrategy Web 8.0.0
-
init
public void init(WebComponent wc, WebTemplateUnit unit, java.util.HashMap cachedObjects)
Deprecated.Description copied from interface:ReportGridCellTitle
This method is called to initialize the cell in design mode. It receives aWebTemplateUnit
as the underlying SDK object.- Specified by:
init
in interfaceReportGridCellTitle
- Parameters:
wc
- The bean being transformed.unit
- TheWebTemplateUnit
corresponding to this cell.cachedObjects
- AHashMap
populated by the transform and used to store information shared across multiple cells.- Since:
- MicroStrategy Web 8.0.0
-
generateColTitleContent
public void generateColTitleContent(MarkupOutput mo)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
generateContent
protected void generateContent(MarkupOutput mo)
Deprecated.Override the protected method of ReportDisplayCellImpl.- Overrides:
generateContent
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 7.5.1
-
generatePivotButtons
protected void generatePivotButtons(MarkupOutput mo)
Deprecated.Override the protected method in ReportDisplayCellImpl.- Overrides:
generatePivotButtons
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object
-
generateContextMenu
protected void generateContextMenu(MarkupOutput mo)
Deprecated.Override the protected method in ReportDisplayCellImpl.- Overrides:
generateContextMenu
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object
-
initDNDForDesignMode
protected void initDNDForDesignMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a column title cell in design mode- Overrides:
initDNDForDesignMode
in classReportGridDisplayCellImpl
- Parameters:
item
- theDragAndDropItem
item
-
initDNDForExecuteMode
protected void initDNDForExecuteMode(DragAndDropItem item)
Deprecated.initialize a drag and drop item for a column title cell in execute mode- Overrides:
initDNDForExecuteMode
in classReportGridDisplayCellImpl
- Parameters:
item
- theDragAndDropItem
item
-
generateTooltip
protected void generateTooltip(MarkupOutput mo)
Deprecated.Generate the tool tip for this cell.- Overrides:
generateTooltip
in classReportGridDisplayCellImpl
- Parameters:
mo
- the output object
-
getSubtitleIndex
public int getSubtitleIndex()
Deprecated.Description copied from class:ReportGridDisplayCellImpl
Returns the subtitle index for this cell- Specified by:
getSubtitleIndex
in interfaceReportGridCellTitle
- Overrides:
getSubtitleIndex
in classReportGridDisplayCellImpl
- Returns:
- subtitle
- Since:
- MicroStrategy Web 8.0.0
-
getFilterOnEvent
public WebEvent getFilterOnEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for filter on the cell header instance- Specified by:
getFilterOnEvent
in interfaceReportGridDisplayCell
- Overrides:
getFilterOnEvent
in classReportGridDisplayCellImpl
- Returns:
WebEvent
instance initialized for filtering on the information of this cell- Since:
- MicroStrategy Web 8.0.1
-
getOpenFormatEditorEvent
public WebEvent getOpenFormatEditorEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for opening the format editor- Specified by:
getOpenFormatEditorEvent
in interfaceReportGridDisplayCell
- Overrides:
getOpenFormatEditorEvent
in classReportGridDisplayCellImpl
- Returns:
WebEvent
instance initialized for opening the format editor- Since:
- MicroStrategy Web 8.0.1
-
getSetFormatEditorTargetEvent
public WebEvent getSetFormatEditorTargetEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for setting the current target of the format editor to be this cell instance- Specified by:
getSetFormatEditorTargetEvent
in interfaceReportGridDisplayCell
- Overrides:
getSetFormatEditorTargetEvent
in classReportGridDisplayCellImpl
- Returns:
WebEvent
instance initialized for setting the target of the format editor to be the current cell instance.- Since:
- MicroStrategy Web 8.0.1
-
getRenameEvent
public WebEvent getRenameEvent()
Deprecated.Description copied from interface:ReportGridDisplayCell
Get the event for renaming the current cell- Specified by:
getRenameEvent
in interfaceReportGridDisplayCell
- Overrides:
getRenameEvent
in classReportGridDisplayCellImpl
- Returns:
WebEvent
instance initialized with the information for renaming the current cell.- Since:
- MicroStrategy Web 8.0.1
-
getDerivedElementsEvent
public WebEvent getDerivedElementsEvent()
Deprecated.- Specified by:
getDerivedElementsEvent
in interfaceReportGridDisplayCell
- Overrides:
getDerivedElementsEvent
in classReportGridDisplayCellImpl
- Since:
- MicroStrategy Web 9.0.0
-
getKey
public int getKey()
Deprecated.- Specified by:
getKey
in interfaceReportGridDisplayCell
- Overrides:
getKey
in classReportGridDisplayCellImpl
- Returns:
- int value with the key information about the cell being analyzed.
- Since:
- MicroStrategy Web 8.0.1
-
isSorted
public boolean isSorted()
Deprecated.- Specified by:
isSorted
in interfaceReportGridCellColTitle
- Returns:
- boolean value indicating if the current cell is sorted or not
- Since:
- MicroStrategy Web 8.0.2
-
isSortAscending
public boolean isSortAscending()
Deprecated.- Specified by:
isSortAscending
in interfaceReportGridCellColTitle
- Returns:
- boolean value indicating if the current cell is sorted ascending or not
- Since:
- MicroStrategy Web 8.0.2
-
getSortEvent
public WebEvent getSortEvent(int type)
Deprecated.Description copied from interface:ReportGridCellColTitle
Get theWebEvent
instance with the information for sorting the current cell values- Specified by:
getSortEvent
in interfaceReportGridCellColTitle
- Parameters:
type
- int value with the identifier for the sort order to generate. Values expected includeReportGridCellColTitle.SORT_TYPE_ASCENDING
andReportGridCellColTitle.SORT_TYPE_DESCENDING
- Returns:
- WebEvent
- Since:
- MicroStrategy Web 8.0.2
-
getAddShortcutMetricEvent
public WebEvent getAddShortcutMetricEvent(int shortcutMetricType)
Deprecated.Description copied from interface:ReportGridCellTitle
Returns the WebEvent to add shortcut metric based on current cell.- Specified by:
getAddShortcutMetricEvent
in interfaceReportGridCellTitle
- Parameters:
shortcutMetricType
- The metric type in (@link EnumShortcutMetricTypes}.
-
canAddShortcutMetric
public boolean canAddShortcutMetric(int shortcutMetricType)
Deprecated.Description copied from interface:ReportGridCellTitle
Returns whether specified shortcut metric could be created based on current cell.- Specified by:
canAddShortcutMetric
in interfaceReportGridCellTitle
- Parameters:
shortcutMetricType
- The metric type in (@link EnumShortcutMetricTypes}.
-
-