public class

ViewBeanTransformHelper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.ViewBeanTransformHelper

Class Overview

ViewBeanTransformHelper Provides utility functions used in report transforms

Summary

Constants
String CACHED_ADVANCED_DRILL_EDITOR_PROCESS_EVENT
String CACHED_ADVANCED_DRILL_EVENT
String CACHED_APPLIED_SORT_ARRAY
String CACHED_DRILL_EDITOR_NAME
String CACHED_DRILL_EDITOR_PROCESS_EVENT
String CACHED_DRILL_EVENT
String CACHED_DRILL_FILTERONSELECTION_PROCESS_EVENT
String CACHED_DRILL_FILTER_PAGEBY
String CACHED_FORMAL_PARAMETERS
String CACHED_IFRAME_REQUEST
String CACHED_IMAGE_FOLDER
String CACHED_IS_NETSCAPE
String CACHED_MAX_COL_HEADER_DEPTH
String CACHED_SORT_EVENT
String CACHED_SORT_SUBTOTAL_POSITION
String CACHED_SPECIFY_ID_FOR_FOR_TITLE_CELL
String CACHED_SPECIFY_WIDTH_FOR_CELL
String CACHED_URL_TYPICAL_BEAN_STATES
String DRILL_RETAIN_THRESHOLDS_NO
String DRILL_RETAIN_THRESHOLDS_USE_DRILL_PATH
String DRILL_RETAIN_THRESHOLDS_YES
String LOCK_COLUMN_HEADERS_PROPERTY_NAME
String LOCK_COLUMN_HEADERS_PROPERTY_OFF
String LOCK_COLUMN_HEADERS_PROPERTY_ON
String LOCK_HEADERS_PROPERTY_GROUP
String LOCK_ROW_HEADERS_PROPERTY_NAME
String LOCK_ROW_HEADERS_PROPERTY_OFF
String LOCK_ROW_HEADERS_PROPERTY_ON
int MAX_CACHED_OBJECTS
String SORT_ASCENDING
String SORT_DESCENDING
Public Constructors
ViewBeanTransformHelper()
Public Methods
static String ReadReportSettings(ViewBean vb, String PropertySet, String PropertyName)
get report property value
static boolean checkReportSettingsDefault(ViewBean vb, String PropertySet, String PropertyName)
check if this report property is set to default
static String determineDrillRetainParent(ViewBean vb, String preferenceValue)
This method is deprecated. This method is no longer used. The backend determines the value of this setting if it is set to use report definition.
static String determineDrillRetainThreshold(ViewBean vb, String preferenceValue)
This method is deprecated. This method is no longer used. The backend determines the value of this setting if it is set to use report definition.
static void generateAttributeFormContextMenu(ViewBean vb, WebTemplateUnit tu, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, String datasetID)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellAttributeForms
static String generateAttributeFormListForContextMenus(WebWorkingSet ws, WebAttribute att, boolean isRWDoc)
Generates a String with the list of attribute forms.
static String generateAttributeFormListForContextMenus(WebWorkingSet ws, WebTemplateAttribute wta, boolean isRWDoc)
Generates a String with the list of attribute forms.
static void generateClientSideRemoveContextMenu(ViewBean vb, int pos, ContextMenu rhMenu, boolean enableExtraRemove)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static String generateColHeaderSortDisplayString(ViewBean vb, WebHeader header)
generate the sort display for column header.
static String generateColHeaderSortID(ViewBean vb, WebHeader header)
generat the sort id for column header
static String generateColTitleSortID(WebTitle title, WebAttributeForm attForm)
static String generateColTitleSortID(WebSubTitle parentSubTitle, WebSubTitle childSubTitle)
generate the sort id for col title.
static void generateFilterOnContextMenu(ViewBean vb, WebObjectInfo objInfo, String unitAlias, ContextMenu cm, EventManager eventManager, boolean isIFrame)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFilterOn
static void generateFormattingContextMenu(ViewBean vb, int axis, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFormat
static void generateFormattingContextMenu(ViewBean vb, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFormat
static void generateFormattingContextMenuForRWB(ViewBean vb, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager, String viewerID)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFormat
static void generateFormattingContextMenuForRWB(ViewBean vb, ContextMenu rhMenu, String viewerID)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFormat
static void generateFormattingContextMenuForRWB(ViewBean vb, int axis, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager, String viewerID)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellFormat
static Block generateFormattingInfoBlock(WebTemplate template, AppContext context)
static void generateFormattingInfoBlock(WebTemplate template, AppContext context, Block all)
static void generateGraphProperties(WebGraph graphObject, AppContext appContext, Block rootBlock)
static Block generateGraphPropertiesInfoBlock(WebGraph graph, AppContext context)
static String generateHeaderSortDisplayString(ViewBean vb, WebHeader header, int axis)
generate the sort display for column header.
static String generateHeaderSortID(ViewBean vb, WebHeader header, int axis, int sortAxis)
generat the sort id for column header
static void generateMoveContextMenu(ViewBean vb, int axis, int pos, boolean isFirst, boolean isLast, ContextMenu rhMenu, ContextMenuManager cmm)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellMove
static boolean generateMoveContextMenu(ViewBean vb, int pos, boolean isFirst, boolean isLast, boolean applyNow, String extraUrl, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellMove
static void generateMoveContextMenu(ViewBean vb, int axis, int pos, boolean isFirst, boolean isLast, boolean applyNow, String extraUrl, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellMove
static boolean generateMoveContextMenu(ViewBean vb, int pos, boolean isFirst, boolean isLast, ContextMenu rhMenu, ContextMenuManager cmm)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellMove
static void generateRemoveClientSideContextMenu(ViewBean vb, int axis, int pos, ContextMenu rhMenu, boolean enableExtraRemove)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static void generateRemoveContextMenu(ViewBean vb, int pos, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static void generateRemoveTemplateUnitContextMenu(ViewBean vb, int axis, int pos, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static void generateRemoveWorkingSetAllMetricsContextMenu(ViewBean vb, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static void generateRemoveWorkingSetUnitContextMenu(ViewBean vb, WebObjectInfo object, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid
static void generateRenameContextMenu(ViewBean vb, int key, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRename
static void generateRenameContextMenuForRWB(ViewBean vb, int key, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRename
static String generateRowHeaderSortID(ViewBean vb, WebHeader header)
generat the sort id for column header
static String generateRowTitleSortID(WebSubTitle parentSubTitle, WebSubTitle childSubTitle)
generate the sort id for row title.
static String generateRowTitleSortID(WebTitle title, WebSubTitle subTitle)
generate the sort id for row title
static String generateRowTitleSortID(WebTitle title, WebAttributeForm attForm)
static void generateShortcutMetricsContextMenu(ViewBean vb, String metricID, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager, boolean isIFrame)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellInsertMetric
static String generateTitleSortID(WebTitle title, WebAttributeForm attForm, int axis)
static WebEvent getAddAttFormEvent(ViewBean vb, String attID, String attFormID, boolean isBase, String toPos, String datasetID)
static String getAddAttFormLink(ViewBean vb, String attID, String attFormID, boolean isBase, int toPos, String extraURL, boolean addState, EventManager eventManager, String datasetID)
static Block getBlockProps(WebTemplate template, String[] properties, int axis, int position, int level, AppContext context)
static int getDefaultOutlineModeExpansionLevel(ViewBean vb)
final static String[] getFeaturesList()
static void getGridBoneFormalParameters(Transform t, JsonGenerator json)
Sets formal paramters used by grid bones for client-side template manipulations as properties of a JsonGenerator.
static JsonGenerator getGridFeatures(WebFeatures featuresManager, boolean isDesignMode)
Creates a json generator for the client-side template features property.
static JsonGenerator getGridFeatures(WebFeatures featuresManager, boolean isDesignMode, boolean hasMetrics)
This method is deprecated. No replacement.
static JsonGenerator getGridFeatures(WebComponent bean, boolean isDesignMode, boolean hasMetrics)
This method is deprecated. No replacement.
static JsonGenerator getGridFeatures(WebComponent bean, boolean isDesignMode)
Creates a json generator for the client-side template features property.
static WebEvent getMoveMetricEvent(ViewBean vb, String fromPos, String toPos, boolean applyNow)
get an event object for a move metric action
static String getMoveMetricLink(ViewBean vb, String fromPos, String toPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)
This method is deprecated. please use the transform and cell information for pivot manipulations
static String getObjectDescription(WebTemplateUnit unit)
static String getObjectID(WebTemplateUnit unit)
static String getObjectIDInfo(WebTemplateUnit unit)
Based on the type of unit instance, obtain its ID
static int getObjectSubType(WebTemplateUnit unit)
static int getObjectType(WebTemplateUnit unit)
static int getObjectTypeInfo(WebTemplateUnit unit)
Get the object type defined for the WebTemplateUnit specified
static WebEvent getOpenAttFormEditorEvent(ViewBean vb, String attID)
static String getOpenAttFormEditorLink(ViewBean vb, String attID, String extraURL, boolean addState, EventManager eventManager)
static int getOutlineModeMaxLevels(ViewBean vb)
static WebHeaders getPageByHeadersByIndex(ViewBean vb, WebGridHeaders pageHeaders, int titleIndex)
get the index for a pageby header
static WebEvent getRemoveAttFormEvent(ViewBean vb, String attID, String attFormID, boolean isBase, String datasetID)
static String getRemoveAttFormLink(ViewBean vb, String attID, String attFormID, boolean isBase, String extraURL, boolean addState, EventManager eventManager, String datasetID)
static WebEvent getRemoveMetricEvent(ViewBean vb, String metricPos, boolean applyNow)
get an event object for a remove metric action
static String getRemoveMetricLink(ViewBean vb, String metricPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)
This method is deprecated. please consult the transform class for remove manipulations
static WebEvent getRemoveTemplateUnitEvent(ViewBean vb, String fromAxis, String fromPos, boolean applyNow)
get an event object for a remove action
static String getRemoveUnitLink(ViewBean vb, String fromAxis, String fromPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)
This method is deprecated. please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid; or about the generation of remove manipulations available on ReportGridDisplayCell
static WebEvent getRemoveWorkingSetAllMetricsEvent(ViewBean vb, boolean applyNow)
static WebEvent getRemoveWorkingSetUnitEvent(ViewBean vb, WebObjectInfo object, boolean applyNow)
static String getReportPropertyValue(ViewBean vb, String propertyName)
static String getReportStyleID(ViewBean vb)
get report style id from report property
static String getReportStyleLocalizedName(ViewBean vb)
get report localized style name
static String getReportStyleName(ViewBean vb)
get report style name from report property
static WebEvent getSinglePivotEvent(ViewBean vb, String fromAxis, String fromPos, String toAxis, String toPos, boolean applyNow)
This method is deprecated. Please use EventManager and event details available on transform related classes such as ReportGridDisplayCell for generating this information.
static String getSinglePivotLink(ViewBean vb, String fromAxis, String fromPos, String toAxis, String toPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)
This method is deprecated. Please use EventManager and event details available on transform related classes such as ReportGridDisplayCell for generating this information.
static int getSortsubtotalPostion(ViewBean vb)
This method is deprecated. Please use getSortsubtotalPostion(ViewBean vb, int axis)
static int getSortsubtotalPostion(ViewBean vb, int axis)
get the subtotal position for sorting
static int getSortsubtotalPostion(WebTemplate template, int axis)
get the subtotal position for sorting
static int getToPageByPosition(ViewBean vb)
get the target position for a pivot to pageby axis action
static String getUnitCellId(String gridBoneId, int axis, int depth, int subDepth)
static WebObjectInfo getWebObjectInfo(WebTemplateUnit unit)
This method is deprecated. No replacement.
static boolean ignoreOldStyle(ViewBean vb)
whether the report is old or new formatting
static boolean isDrillPathsInOldFormat(ViewBean vb)
static String mapCssFileNameToStyleName(String fileName)
map a css file name to a style name
static String mapStyleNameToCssFileName(String styleName)
map a style name to a css file name
static void renderColTags(int dpi, double zoom, MarkupOutput out, ViewBean vb)
This method is deprecated. transforms should extend ReportGridTransformImpl and use protected method renderColTagsHtml
static void setFormalParameters(WebComponent wc, boolean designMode, FormalParameters formalParameters)
Sets the template formal parameters
static String setReportPropertyValue(ViewBean vb, String propertyName, String propertyValue)
static boolean showAttributeForms(ViewBean vb)
Check whether to show the attribute form names on the view bean
[Expand]
Inherited Methods
From class java.lang.Object

Constants

protected static final String CACHED_ADVANCED_DRILL_EDITOR_PROCESS_EVENT

Constant Value: "5"

protected static final String CACHED_ADVANCED_DRILL_EVENT

Constant Value: "3"

protected static final String CACHED_APPLIED_SORT_ARRAY

Constant Value: "8"

protected static final String CACHED_DRILL_EDITOR_NAME

Constant Value: "9"

protected static final String CACHED_DRILL_EDITOR_PROCESS_EVENT

Constant Value: "4"

protected static final String CACHED_DRILL_EVENT

Constant Value: "1"

protected static final String CACHED_DRILL_FILTERONSELECTION_PROCESS_EVENT

Constant Value: "6"

protected static final String CACHED_DRILL_FILTER_PAGEBY

Constant Value: "12"

protected static final String CACHED_FORMAL_PARAMETERS

Constant Value: "17"

protected static final String CACHED_IFRAME_REQUEST

Constant Value: "11"

protected static final String CACHED_IMAGE_FOLDER

Constant Value: "2"

protected static final String CACHED_IS_NETSCAPE

Constant Value: "13"

protected static final String CACHED_MAX_COL_HEADER_DEPTH

Constant Value: "16"

protected static final String CACHED_SORT_EVENT

Constant Value: "7"

protected static final String CACHED_SORT_SUBTOTAL_POSITION

Constant Value: "10"

protected static final String CACHED_SPECIFY_ID_FOR_FOR_TITLE_CELL

Constant Value: "15"

protected static final String CACHED_SPECIFY_WIDTH_FOR_CELL

Constant Value: "14"

protected static final String CACHED_URL_TYPICAL_BEAN_STATES

Constant Value: "0"

public static final String DRILL_RETAIN_THRESHOLDS_NO

Constant Value: "0"

public static final String DRILL_RETAIN_THRESHOLDS_USE_DRILL_PATH

Constant Value: "2"

public static final String DRILL_RETAIN_THRESHOLDS_YES

Constant Value: "1"

public static final String LOCK_COLUMN_HEADERS_PROPERTY_NAME

Constant Value: "LockColumnHeaders"

public static final String LOCK_COLUMN_HEADERS_PROPERTY_OFF

Constant Value: "0"

public static final String LOCK_COLUMN_HEADERS_PROPERTY_ON

Constant Value: "1"

public static final String LOCK_HEADERS_PROPERTY_GROUP

Constant Value: "Template Formatting"

public static final String LOCK_ROW_HEADERS_PROPERTY_NAME

Constant Value: "LockRowHeaders"

public static final String LOCK_ROW_HEADERS_PROPERTY_OFF

Constant Value: "0"

public static final String LOCK_ROW_HEADERS_PROPERTY_ON

Constant Value: "1"

protected static final int MAX_CACHED_OBJECTS

Constant Value: 17 (0x00000011)

public static final String SORT_ASCENDING

Constant Value: "1"

public static final String SORT_DESCENDING

Constant Value: "0"

Public Constructors

public ViewBeanTransformHelper ()

Public Methods

public static String ReadReportSettings (ViewBean vb, String PropertySet, String PropertyName)

get report property value

Parameters
vb the ViewBean object
PropertySet the property set name
PropertyName the property name
Returns
  • the property value

public static boolean checkReportSettingsDefault (ViewBean vb, String PropertySet, String PropertyName)

check if this report property is set to default

Parameters
vb the ViewBean object
PropertySet the property set name
PropertyName the property name
Returns
  • the property value

public static String determineDrillRetainParent (ViewBean vb, String preferenceValue)

This method is deprecated.
This method is no longer used. The backend determines the value of this setting if it is set to use report definition.

get the drill retain parent

Parameters
vb the ViewBean object
preferenceValue value of the preference related with this feature as defined by the user
Returns
  • the drill retain parent

public static String determineDrillRetainThreshold (ViewBean vb, String preferenceValue)

This method is deprecated.
This method is no longer used. The backend determines the value of this setting if it is set to use report definition.

get the drill retain thresholds

Parameters
vb the ViewBean object
preferenceValue the preference value
Returns
  • the drill retain thresholds

public static void generateAttributeFormContextMenu (ViewBean vb, WebTemplateUnit tu, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, String datasetID)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellAttributeForms

Generates the Attribute forms context menu.

Parameters
vb ViewBean the view bean to display
tu WebTemplateUnit the template unit object
isIFrame boolean
rhMenu ContextMenu
cmm ContextMenuManager
datasetID String dataset ID. This assumes is a dataset inside a RW document.

public static String generateAttributeFormListForContextMenus (WebWorkingSet ws, WebAttribute att, boolean isRWDoc)

Generates a String with the list of attribute forms.
This is used for the object browser context menus during client-side manipulations

Parameters
ws WebWorkingSet the working set
att WebTemplateUnit the web attribute object
isRWDoc boolean indicates its an rwd.
Returns
  • a String

public static String generateAttributeFormListForContextMenus (WebWorkingSet ws, WebTemplateAttribute wta, boolean isRWDoc)

Generates a String with the list of attribute forms.
This is used for the context menus on client-side manipulations

Parameters
ws WebWorkingSet the working set
wta WebTemplateAttribute the viewbean template attribute
isRWDoc boolean indicates its an rwd.
Returns
  • a String

public static void generateClientSideRemoveContextMenu (ViewBean vb, int pos, ContextMenu rhMenu, boolean enableExtraRemove)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

generate client-side Remove context menu for single metric

Parameters
vb the ReportBean object
pos metric position
rhMenu ContextMenu object
enableExtraRemove boolean value indicating if Remove From Report option should be displayed if available

public static String generateColHeaderSortDisplayString (ViewBean vb, WebHeader header)

generate the sort display for column header.

Parameters
vb the ViewBean object
header the WebHeader object
Returns
  • the sort display

public static String generateColHeaderSortID (ViewBean vb, WebHeader header)

generat the sort id for column header

Parameters
vb the ViewBean object
header the WebHeader object
Returns
  • the sort id

public static String generateColTitleSortID (WebTitle title, WebAttributeForm attForm)

public static String generateColTitleSortID (WebSubTitle parentSubTitle, WebSubTitle childSubTitle)

generate the sort id for col title.

Parameters
parentSubTitle WebSubTitle object
childSubTitle WebSubTitle object
Returns
  • the sort id

public static void generateFilterOnContextMenu (ViewBean vb, WebObjectInfo objInfo, String unitAlias, ContextMenu cm, EventManager eventManager, boolean isIFrame)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFilterOn

Adds new context menu to either col or row header title for allow end-users to filter on given attribute or metric

Parameters
vb ViewBean
objInfo WebObjectInfo
unitAlias String
cm ContextMenu
eventManager EventManager
isIFrame boolean

public static void generateFormattingContextMenu (ViewBean vb, int axis, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFormat

generate Formatting context menu for template unit.

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object

public static void generateFormattingContextMenu (ViewBean vb, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFormat

generate Formatting context menu for single metric. It uses the value sent as position (pos) minus one.

Parameters
vb the ViewBean object
pos metric position
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object

public static void generateFormattingContextMenuForRWB (ViewBean vb, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager, String viewerID)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFormat

generate Formatting context menu for single metric in case of a view bean in a RW document. It uses the value sent as position (pos) minus one.

Parameters
vb the ViewBean object
pos metric position
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object
viewerID The bone ID of the RW sviewer

public static void generateFormattingContextMenuForRWB (ViewBean vb, ContextMenu rhMenu, String viewerID)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFormat

generate client-side Formatting context menu for template unit in case of a view bean in a RW document.

Parameters
vb the ViewBean object
rhMenu ContextMenu object
viewerID The bone ID of the RW sviewer

public static void generateFormattingContextMenuForRWB (ViewBean vb, int axis, int pos, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager, String viewerID)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellFormat

generate Formatting context menu for template unit in case of a view bean in a RW document.

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object
viewerID The bone ID of the RW sviewer

public static Block generateFormattingInfoBlock (WebTemplate template, AppContext context)

Throws
Exception

public static void generateFormattingInfoBlock (WebTemplate template, AppContext context, Block all)

Throws
Exception

public static void generateGraphProperties (WebGraph graphObject, AppContext appContext, Block rootBlock)

public static Block generateGraphPropertiesInfoBlock (WebGraph graph, AppContext context)

public static String generateHeaderSortDisplayString (ViewBean vb, WebHeader header, int axis)

generate the sort display for column header.

Parameters
vb the ViewBean object
header the WebHeader object
Returns
  • the sort display

public static String generateHeaderSortID (ViewBean vb, WebHeader header, int axis, int sortAxis)

generat the sort id for column header

Parameters
vb the ViewBean object
header the WebHeader object
Returns
  • the sort id

public static void generateMoveContextMenu (ViewBean vb, int axis, int pos, boolean isFirst, boolean isLast, ContextMenu rhMenu, ContextMenuManager cmm)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellMove

generate a client-side move RMC for a template unit

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
isFirst if it's the first unit in the axis
isLast if it's the last unit in the axis
rhMenu ContextMenu object
cmm ContextMenuManager object

public static boolean generateMoveContextMenu (ViewBean vb, int pos, boolean isFirst, boolean isLast, boolean applyNow, String extraUrl, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellMove

generate a move RMC for a single metric

Parameters
vb the ViewBean object
pos metric position
isFirst if it's the first metric
isLast if it's the last metric
applyNow whether to apply change
extraUrl extra url info to the link
isIFrame whether it is iframe
rhMenu ContextMenu object
cmm ContextMenuManager object
eventManager EventManager object
Returns
  • whether the move item is added to the context menu

public static void generateMoveContextMenu (ViewBean vb, int axis, int pos, boolean isFirst, boolean isLast, boolean applyNow, String extraUrl, boolean isIFrame, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellMove

generate a move RMC for a template unit

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
isFirst if it's the first unit in the axis
isLast if it's the last unit in the axis
applyNow whether to apply change
extraUrl extra url info to the link
isIFrame whether it is iframe enabled
rhMenu ContextMenu object
cmm ContextMenuManager object
eventManager EventManager object

public static boolean generateMoveContextMenu (ViewBean vb, int pos, boolean isFirst, boolean isLast, ContextMenu rhMenu, ContextMenuManager cmm)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellMove

generate a client-side move RMC for a single metric

Parameters
vb the ViewBean object
pos metric position
isFirst if it's the first metric
isLast if it's the last metric
rhMenu ContextMenu object
cmm ContextMenuManager object
Returns
  • whether the move item is added to the context menu

public static void generateRemoveClientSideContextMenu (ViewBean vb, int axis, int pos, ContextMenu rhMenu, boolean enableExtraRemove)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

generate client-side Remove context menu for template unit

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
rhMenu ContextMenu object
enableExtraRemove boolean value indicating if Remove From Report option should be displayed if available

public static void generateRemoveContextMenu (ViewBean vb, int pos, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

generate Remove context menu for single metric

Parameters
vb the ViewBean object
pos metric position
applyNow whether to apply change
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object

public static void generateRemoveTemplateUnitContextMenu (ViewBean vb, int axis, int pos, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

generate Remove context menu for template unit

Parameters
vb the ViewBean object
axis template unit axis
pos template unit position
applyNow whether to apply change
extraUrl extra url info to the link
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object

public static void generateRemoveWorkingSetAllMetricsContextMenu (ViewBean vb, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

public static void generateRemoveWorkingSetUnitContextMenu (ViewBean vb, WebObjectInfo object, boolean applyNow, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid

generate Remove context menu for working set specified by axis and position.

Parameters
vb the ViewBean object
object the object to remove from the working set of the report
applyNow whether to apply change
extraUrl extra url info on the url
isIframe whether it is iframe enabled
rhMenu ContextMenu object
eventManager EventManager object

public static void generateRenameContextMenu (ViewBean vb, int key, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRename

public static void generateRenameContextMenuForRWB (ViewBean vb, int key, String extraUrl, boolean isIframe, ContextMenu rhMenu, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRename

public static String generateRowHeaderSortID (ViewBean vb, WebHeader header)

generat the sort id for column header

Parameters
vb the ViewBean object
header the WebHeader object
Returns
  • the sort id

public static String generateRowTitleSortID (WebSubTitle parentSubTitle, WebSubTitle childSubTitle)

generate the sort id for row title.

Parameters
parentSubTitle WebSubTitle object
childSubTitle WebSubTitle object
Returns
  • the sort id

public static String generateRowTitleSortID (WebTitle title, WebSubTitle subTitle)

generate the sort id for row title

Parameters
title WebTitle object
subTitle WebSubTitle object
Returns
  • the sort id

public static String generateRowTitleSortID (WebTitle title, WebAttributeForm attForm)

Parameters
title WebTitle object
attForm WebAttributeForm
Returns
  • the sort id for row title

public static void generateShortcutMetricsContextMenu (ViewBean vb, String metricID, ContextMenu rhMenu, ContextMenuManager cmm, EventManager eventManager, boolean isIFrame)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellInsertMetric

public static String generateTitleSortID (WebTitle title, WebAttributeForm attForm, int axis)

public static WebEvent getAddAttFormEvent (ViewBean vb, String attID, String attFormID, boolean isBase, String toPos, String datasetID)

public static String getAddAttFormLink (ViewBean vb, String attID, String attFormID, boolean isBase, int toPos, String extraURL, boolean addState, EventManager eventManager, String datasetID)

public static Block getBlockProps (WebTemplate template, String[] properties, int axis, int position, int level, AppContext context)

Throws
Exception

public static int getDefaultOutlineModeExpansionLevel (ViewBean vb)

public static final String[] getFeaturesList ()

Returns
  • a copy of the features String array that is sent to the report

public static void getGridBoneFormalParameters (Transform t, JsonGenerator json)

Sets formal paramters used by grid bones for client-side template manipulations as properties of a JsonGenerator.

Parameters
t Transform instance
json JsonGenerator that will accept the new properties

public static JsonGenerator getGridFeatures (WebFeatures featuresManager, boolean isDesignMode)

Creates a json generator for the client-side template features property.

Parameters
featuresManager WebFeatures the report features manager used to check if a feature is available
isDesignMode boolean that indicates if the interface is in design mode or not
Returns

public static JsonGenerator getGridFeatures (WebFeatures featuresManager, boolean isDesignMode, boolean hasMetrics)

This method is deprecated.
No replacement.

Creates a json generator for the client-side template features property.

Parameters
featuresManager WebFeatures the report features manager used to check if a feature is available
isDesignMode boolean that indicates if the interface is in design mode or not
hasMetrics boolen that indicates if the template has metrics
Returns

public static JsonGenerator getGridFeatures (WebComponent bean, boolean isDesignMode, boolean hasMetrics)

This method is deprecated.
No replacement.

Creates a json generator for the client-side template features property.

Parameters
bean WebComponent the report features manager used to check if a feature is available
isDesignMode boolean that indicates if the interface is in design mode or not
hasMetrics boolen that indicates if the template has metrics
Returns

public static JsonGenerator getGridFeatures (WebComponent bean, boolean isDesignMode)

Creates a json generator for the client-side template features property.

Parameters
bean WebComponent the report features manager used to check if a feature is available
isDesignMode boolean that indicates if the interface is in design mode or not
Returns

public static WebEvent getMoveMetricEvent (ViewBean vb, String fromPos, String toPos, boolean applyNow)

get an event object for a move metric action

Parameters
vb the ViewBean object
fromPos the origin position
toPos the target position
applyNow whether to apply change
Returns
  • the event object

public static String getMoveMetricLink (ViewBean vb, String fromPos, String toPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)

This method is deprecated.
please use the transform and cell information for pivot manipulations

get a link for a move metric action

Parameters
vb the ViewBean object
fromPos the origin position
toPos the target position
applyNow whether to apply change
extraURL extra url information to append
addState whether add the beans's state
eventManager EventManager object
Returns
  • the link as String

public static String getObjectDescription (WebTemplateUnit unit)

Parameters
unit WebTemplateUnit object
Returns
  • object description from a template unit.

public static String getObjectID (WebTemplateUnit unit)

Parameters
unit WebTemplateUnit object
Returns
  • object identifier from a template unit.

public static String getObjectIDInfo (WebTemplateUnit unit)

Based on the type of unit instance, obtain its ID

Parameters
unit WebTemplateUnit instance to analyze
Returns
  • String value with the object ID information.

public static int getObjectSubType (WebTemplateUnit unit)

Parameters
unit WebTemplateUnit object
Returns
  • object type from a template unit.

public static int getObjectType (WebTemplateUnit unit)

Parameters
unit WebTemplateUnit object
Returns
  • object type from a template unit.

public static int getObjectTypeInfo (WebTemplateUnit unit)

Get the object type defined for the WebTemplateUnit specified

Parameters
unit WebTemplateUnit instance to analyze
Returns

public static WebEvent getOpenAttFormEditorEvent (ViewBean vb, String attID)

public static String getOpenAttFormEditorLink (ViewBean vb, String attID, String extraURL, boolean addState, EventManager eventManager)

public static int getOutlineModeMaxLevels (ViewBean vb)

public static WebHeaders getPageByHeadersByIndex (ViewBean vb, WebGridHeaders pageHeaders, int titleIndex)

get the index for a pageby header

Parameters
vb the ViewBean object
pageHeaders the pageby headers
titleIndex the index of the pageby item in the pageby axis
Returns
  • the pageby header at that index

public static WebEvent getRemoveAttFormEvent (ViewBean vb, String attID, String attFormID, boolean isBase, String datasetID)

public static String getRemoveAttFormLink (ViewBean vb, String attID, String attFormID, boolean isBase, String extraURL, boolean addState, EventManager eventManager, String datasetID)

public static WebEvent getRemoveMetricEvent (ViewBean vb, String metricPos, boolean applyNow)

get an event object for a remove metric action

Parameters
vb the ViewBean object
metricPos the metric position
applyNow whether to apply change
Returns
  • the event object

public static String getRemoveMetricLink (ViewBean vb, String metricPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)

This method is deprecated.
please consult the transform class for remove manipulations

get a link for a remove metric action

Parameters
vb the ViewBean object
metricPos the metric position
applyNow whether to apply change
extraURL extra url information to append
addState whether add the beans's state
eventManager EventManager object
Returns
  • the link as String

public static WebEvent getRemoveTemplateUnitEvent (ViewBean vb, String fromAxis, String fromPos, boolean applyNow)

get an event object for a remove action

Parameters
vb the ViewBean object
fromAxis the origin axis
fromPos the origin position
applyNow whether to apply change
Returns
  • the event object

public static String getRemoveUnitLink (ViewBean vb, String fromAxis, String fromPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)

This method is deprecated.
please use the new approach for generating context menu options, see ReportCellRemoveFromReport and ReportCellRemoveFromGrid; or about the generation of remove manipulations available on ReportGridDisplayCell

get a link for a remove action

Parameters
vb the ViewBean object
fromAxis the origin axis
fromPos the origin position
applyNow whether to apply change
extraURL extra url information to append
addState whether add the beans's state
eventManager EventManager object
Returns
  • the link as String

public static WebEvent getRemoveWorkingSetAllMetricsEvent (ViewBean vb, boolean applyNow)

public static WebEvent getRemoveWorkingSetUnitEvent (ViewBean vb, WebObjectInfo object, boolean applyNow)

public static String getReportPropertyValue (ViewBean vb, String propertyName)

public static String getReportStyleID (ViewBean vb)

get report style id from report property

Parameters
vb the ViewBean object
Returns
  • report style id

public static String getReportStyleLocalizedName (ViewBean vb)

get report localized style name

Parameters
vb the ViewBean object
Returns
  • localized style name

public static String getReportStyleName (ViewBean vb)

get report style name from report property

Parameters
vb the ViewBean object
Returns
  • report style name from report property

public static WebEvent getSinglePivotEvent (ViewBean vb, String fromAxis, String fromPos, String toAxis, String toPos, boolean applyNow)

This method is deprecated.
Please use EventManager and event details available on transform related classes such as ReportGridDisplayCell for generating this information.

get event object for a pivot action

Parameters
vb the ViewBean object
fromAxis the origin axis
fromPos the origin position
toAxis the target axis
toPos the target position
applyNow whether to apply change
Returns

public static String getSinglePivotLink (ViewBean vb, String fromAxis, String fromPos, String toAxis, String toPos, boolean applyNow, String extraURL, boolean addState, EventManager eventManager)

This method is deprecated.
Please use EventManager and event details available on transform related classes such as ReportGridDisplayCell for generating this information.

get a link for a pivot action

Parameters
vb the ViewBean object
fromAxis the origin axis
fromPos the origin position
toAxis the target axis
toPos the target position
applyNow whether to apply change
extraURL extra url information to append
addState whether add the beans's state
eventManager EventManager object
Returns
  • the link as String

public static int getSortsubtotalPostion (ViewBean vb)

This method is deprecated.
Please use getSortsubtotalPostion(ViewBean vb, int axis)

get the subtotal position for sorting

Parameters
vb the ViewBean object
Returns
  • the subtotal position for sorting

public static int getSortsubtotalPostion (ViewBean vb, int axis)

get the subtotal position for sorting

Parameters
vb the ViewBean object
axis the axis EnumDSSXMLAxisName where the sorting is defined
Returns
  • the subtotal position for sorting

public static int getSortsubtotalPostion (WebTemplate template, int axis)

get the subtotal position for sorting

Parameters
axis the axis EnumDSSXMLAxisName where the sorting is defined
Returns
  • the subtotal position for sorting

public static int getToPageByPosition (ViewBean vb)

get the target position for a pivot to pageby axis action

Parameters
vb the ViewBean object
Returns
  • the target position

public static String getUnitCellId (String gridBoneId, int axis, int depth, int subDepth)

Parameters
gridBoneId identifier of the grid where the unit is located
axis axis location of the unit
depth depth location of the unit in the axis
subDepth sub-depth location of the unit in the axis
Returns
  • a String with an ID value for a Template Unit

public static WebObjectInfo getWebObjectInfo (WebTemplateUnit unit)

This method is deprecated.
No replacement.

Parameters
unit WebTemplateUnit object
Returns

public static boolean ignoreOldStyle (ViewBean vb)

whether the report is old or new formatting

Parameters
vb the ViewBean object
Returns
  • whether the report is old or new formatting

public static boolean isDrillPathsInOldFormat (ViewBean vb)

public static String mapCssFileNameToStyleName (String fileName)

map a css file name to a style name

Parameters
fileName css file name
Returns
  • style name

public static String mapStyleNameToCssFileName (String styleName)

map a style name to a css file name

Parameters
styleName style name
Returns
  • css file name

public static void renderColTags (int dpi, double zoom, MarkupOutput out, ViewBean vb)

This method is deprecated.
transforms should extend ReportGridTransformImpl and use protected method renderColTagsHtml

Renders the col tags for a grid column widths.

Parameters
dpi int containing the dpi of the client
zoom value for zoom property to use
out MarkupOutput instance where the HTML contents to render are to be saved
vb ViewBean base instance

public static void setFormalParameters (WebComponent wc, boolean designMode, FormalParameters formalParameters)

Sets the template formal parameters

Parameters
wc WebComponent base instance
designMode boolean indicating if the environment is design mode or not
formalParameters FormalParameters instance with the values to set

public static String setReportPropertyValue (ViewBean vb, String propertyName, String propertyValue)

public static boolean showAttributeForms (ViewBean vb)

Check whether to show the attribute form names on the view bean

Parameters
vb ViewBean base instance
Returns
  • whether to show the attribute form names