GridFormatHelper

extends GridWebFormatHelper

java.lang.Object
↳	com.microstrategy.web.beans.GridWebFormatHelper
	↳	com.microstrategy.web.app.beans.GridFormatHelper

Class Overview

This class provides a series of methods that aid on the manipulation of grid formatting properties.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.beans.GridWebFormatHelper

int	LOCAL_TARGET_ALL_METRICS	Constant for representing All Metrics on the report as target for the formatting
int	LOCAL_TARGET_ALL_REPORT	Constant for representing All Report as target for the formatting
int	LOCAL_TARGET_GRID_BORDER	Constant for representing Grid border on the report as target for the formatting
int	LOCAL_TARGET_GRID_CONTAINER	Constant for representing Grid Container on the RWD as target for the formatting

Public Constructors
	GridFormatHelper()

Public Methods
static String	getDefaultNumberDateDescriptor(AppContext appContext, String numberDateLocale, String descriptorId) For the specified locale, obtain which is the descriptor to be used
static String	getNumberDateLocale(AppContext appContext) Based on the user's preferences, obtain which locale should be used for formatting number and dates

[Expand]

Inherited Methods

From class com.microstrategy.web.beans.GridWebFormatHelper

static String	constructNumberFormat(String numberCategory, String thousandSeparator, String decimalPlaces, String currencySymbol, String currencyPosition, String negativeNumbers, String originalFormat) Given the formatting specifications, constructs the string that represents the formatting indicated.
static String	convertColorDecimalToHTMLHex(int colorCode) Converts a color ID retrieved as cell property from the metadata to its HTML hexadecimal representation
static WebFormatContainer	getAxis(WebTemplate wt, int targetAxis) Do the required validation for returning the requested axis' format container
static String	getComparedPropertyValue(WebTemplate template, ArrayList webFormatArray, String propertyGroup, String propertyName, String defaultValue, int originalTargetAxis, int originalTargetPosition, int originalTargetLevel)
static String	getComparedPropertyValue(WebComponent taskBean, ArrayList webFormatArray, String propertyGroup, String propertyName, String defaultValue, int originalTargetAxis, int originalTargetPosition, int originalTargetLevel) Based on the array of web format objects, compare the requested property and determine if they are the same (and what value that shall be) or if they should be marked as default if at least one value is different.
static ArrayList	getGridFormatObjectsArray(WebComponent targetBean, int targetAxis, int targetPosition, int unitType, int targetLevel) Get an array of all the format objects that should be analyzed before showing the current values selected on the editor's interface
static ArrayList	getGridFormatObjectsArray(WebComponent targetBean, int targetAxis, int targetPosition, int targetLevel) Get an array of all the format objects that should be analyzed before showing the current values selected on the editor's interface.
static ArrayList	getGridFormatObjectsArray(boolean getAsRequested, WebComponent targetBean, int targetAxis, int targetPosition, int targetLevel) Get an array of all the format objects that should be analyzed before showing the current values selected on the editor's interface
static ArrayList	getGridFormatObjectsArray(boolean getAsRequested, WebComponent targetBean, int targetAxis, int targetPosition, int unitType, int targetLevel) Get an array of all the format objects that should be analyzed before showing the current values selected on the editor's interface
static ArrayList	getGridFormatObjectsArray(boolean getAsRequested, WebTemplate template, int targetAxis, int targetPosition, int targetLevel)
static WebTemplate	getGridTemplate(WebComponent wc) Get the template object out of the report bean
static WebFormatContainer	getMetric(WebTemplate wt, int indexPosition) Do required validation for returning requested metric's format container
static boolean	getPropertyUseDefault(WebFormat wf, String group, String property) Retrieve the property requested from the `WebFormat` object and determine if default value is to be used on it
static String	getPropertyValue(WebFormat wf, String group, String property) Given the group and property specified as parameters, find and return its value according to the WebFormat object passed as parameter.
static String	getPropertyValue(WebFormat wf, String group, String property, String defaultValue) Given the group and property specified as parameters, find and return its value according to the WebFormat object passed as parameter.
static WebFormatContainer	getTemplateUnit(WebTemplate wt, int targetAxis, int targetPosition) Do required validation for returning requested template unit's format container
static int	getUnitType(int targetAxis, int targetPosition) Given the axis and position, calculate the unit type of the target

From class java.lang.Object

Public Constructors

public GridFormatHelper ()

Public Methods

public static String getDefaultNumberDateDescriptor (AppContext appContext, String numberDateLocale, String descriptorId)

For the specified locale, obtain which is the descriptor to be used

Parameters

appContext	`AppContext` initialized instance
numberDateLocale	the string code of the locale selected by the user
descriptorId	the id of the descriptor requested

Returns

the String value corresponding to the descriptor id sent as parameter

public static String getNumberDateLocale (AppContext appContext)

Based on the user's preferences, obtain which locale should be used for formatting number and dates

Parameters

appContext	`AppContext` initialized instance

Returns

the string code of the locale selected by the user on his/her preferences

Interfaces

Classes

Exceptions

GridFormatHelper

Class Overview

Summary

Public Constructors

public GridFormatHelper ()

Public Methods

public static String getDefaultNumberDateDescriptor (AppContext appContext, String numberDateLocale, String descriptorId)

Parameters

Returns

public static String getNumberDateLocale (AppContext appContext)

Parameters

Returns