Package com.microstrategy.web.app.utils

Class HTMLHelper

java.lang.Object

com.microstrategy.web.app.utils.HTMLHelper

public class HTMLHelper
extends java.lang.Object

This class attempts to ease the construction of HTML content inside a Markup Output object. All of the methods in this class are public static so that it's not required to create an instance of this class.

With the introduction of the TAGS infrastructure numerous methods of this class have been deprecated. At this point, the usage of this class is not recommended except for a few methods like:

• encode(String)
• displayError(MarkupOutput out, String className, String methodName, Exception e, String title, String message)
• convertInchesToPixel(java.lang.String, int, java.util.Locale, int)
• convertColorDecimalToHex(java.lang.String)
• convertColorHexToDecimal(java.lang.String)

For more information about the Tags infrastrucuture, refere to TagsFactory.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CSS_ERROR_MESSAGE
static java.lang.String	CSS_ERROR_TITLE
static java.lang.String	DEFAULT_FORM_METHOD
static java.lang.String	DEFAULT_FORM_NAME
static java.lang.String	INPUT_TYPE_BUTTON
static java.lang.String	INPUT_TYPE_CHECKBOX
static java.lang.String	INPUT_TYPE_HIDDEN
static java.lang.String	INPUT_TYPE_RADIO
static java.lang.String	INPUT_TYPE_SUBMIT
static java.lang.String	INPUT_TYPE_TEXT

Constructor Summary

Constructors

Constructor	Description
HTMLHelper()	Creates new HTMLHelper

Method Summary

Modifier and Type	Method	Description
static void	appendScriptTag(MarkupOutput mo, AppContext appContext, java.lang.String filePath)	Append script tag to MarkupOutput to load script file
static void	appendStyleLinkTag(MarkupOutput mo, AppContext appContext, java.lang.String cssFile)	Append css style link tag to MarkupOutput to load css file
static java.lang.String	computeTextboxSize(java.lang.String value, int max)
static java.lang.String	convertColorBGRtoRGB(java.lang.String colorHexCode)	Converts the hexadecimal representation of a color into its RRGGBB format or BBGGRR.
static java.lang.String	convertColorDecimalToHex(java.lang.String colorCode)	Converts the integer representation of a color into its hexadecimal representation.
static java.lang.String	convertColorDecimalToRGB(int color)	Converts the decimal representation of a color into its RRGGBB format.
static java.lang.String	convertColorDecimalToRGB(java.lang.String colorCode)	Converts the decimal representation of a color into its RRGGBB format.
static java.lang.String	convertColorHexToDecimal(java.lang.String colorCode)	Converts the hexadecimal color code (e.g.
static java.lang.String	convertColorHSBToHex(int hue, int saturation, int brightness)	Converts the hsb components of a color into its hexadecimal representation.
static int[]	convertColorRGBToHSB(int r, int g, int b)	Converts the red, green and blue components of a color into hsb components.
static java.lang.String	convertFormattedValue(java.lang.String value, java.util.Locale locale)	Converts any value with decimal into locale dependent format.
static java.lang.String	convertImageUri(java.lang.String value)	Adjusts image URI.
static java.lang.String	convertInchesToPixel(java.lang.String inches, int dpiConversion, java.util.Locale locale, int zoomFactor)	Converts inches into pixels.
static double	convertPixelsToInches(double pixels, int dpiConversion, int zoomFactor)	Converts pixels to inches
static java.lang.String	convertPixelsToInches(java.lang.String pixels, int dpiConversion, java.util.Locale locale, int zoomFactor)	Converts pixels into inches.
static double	convertPixelsToPoints(double pixels, int dpiConversion, int zoomFactor)	Convert pixels to points
static double	convertPtsToInches(double pts)	Converts points into inches.
static double	convertPtsToPixels(double pts, int dpiConversion, int zoomFactor)	Convert points to pixels
static java.lang.String	decode(java.lang.String oldStr)	Given an HTML encoded string, returns its decoded version (using plain characters instead of browser's specifc encoding).
static void	displayError(MarkupOutput transOut, java.lang.String className, java.lang.String methodName, java.lang.Exception e, java.lang.String title, java.lang.String message)	Writes an error message.
static void	displayError(MarkupOutput out, java.lang.String className, java.lang.String methodName, java.lang.Exception e, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo)	Deprecated. This is method has been deprecated as css-classes are not optional anymore.
static void	displayError(MarkupOutput out, java.lang.String className, java.lang.String methodName, java.lang.Exception e, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)	Writes an error message.
static java.lang.String	encode(java.lang.String oldStr)	Encodes a string using HTML encoding.
static java.lang.String	encode(java.lang.String oldStr, boolean encodeSpaces)
static java.lang.String	encodeEscapeApostrophe(java.lang.String oldStr)
static java.lang.String	encodeExcludeSubStr(java.lang.String excludeStr, java.lang.String wholeStr)	/** encode object details, the description part will not encode if allowing html on object description
static java.lang.String	encodeForAllowHtmlOnMetrics(java.lang.String oldStr)
static java.lang.String	encodeForTooltip(java.lang.String tooltipStr)
static java.lang.String	euroEncode(java.lang.String oldStr)	Deprecated. The application doesn't require to encode the Euro symbol.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext)	Fills a COMBO box with the contents of an XML file.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext, java.lang.String comboKey, java.lang.String localeID)	Fills a COMBO box with the contents of an XML file.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String name, java.lang.String size, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext)	Deprecated. Tags should be generated using the Tags infrastructure.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String name, java.lang.String size, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext, boolean addDefault, java.lang.String defaultContent, java.lang.String defaultValue, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String name, java.lang.String size, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext, boolean addDefault, java.lang.String defaultContent, java.lang.String defaultValue, java.lang.String extraParameters, WebComponent baseBean)	Deprecated. Tags should be generated using the Tags infrastructure.
static boolean	fillComboFromXML(MarkupOutput mo, int indent, java.lang.String name, java.lang.String size, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static boolean	fillComboFromXML(MarkupOutput mo, WebComponent baseBean, int indent, java.lang.String selectedValue, java.lang.String xmlFile, AppContext appContext, java.lang.String comboKey, java.lang.String localeID)	Fills a COMBO box with the contents of an XML file.
static boolean	fillComboPaperList(MarkupOutput mo, int indent, java.lang.String name, java.lang.String size, java.lang.String selectedValue, PaperSizesList paperList, AppContext appContext)	Deprecated. Tags should be generated using the Tags infrastructure.
static SelectTag	fillComboPaperList(java.lang.String name, java.lang.String selectedValue, PaperSizesList paperList, AppContext appContext)	Deprecated. Use fillComboPaperList(String, String, ShortcutList, AppContext)
static SelectTag	fillComboPaperList(java.lang.String name, java.lang.String selectedValue, ShortcutList paperList, AppContext appContext)	Generates a select list containing the elements from the configuration list
static int	fixPixelsForBase96(int pixels, int dpiConversion, int zoomFactor)	Adjusts pixels for zoom and dpi assuming a base dpi of 96.
static java.lang.String	fixPointsForZoom(java.lang.String points, int zoomFactor)	Fixes the point values used for font size and weight based on DPI conversion factor and zoom factors.
static java.lang.String	formatAttributeFormDisplay(java.lang.String attName, java.lang.String formName)	Deprecated. Use ExpressionHelper.formatAttributeFormDisplay(java.lang.String, java.lang.String).
static java.lang.String	formatAttributeFormValue(java.lang.String attId, java.lang.String formId, int formDataType, java.lang.String attName, java.lang.String formName)	Deprecated. Use ExpressionHelper.formatAttributeFormValue(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String).
static java.lang.String	formatAttributeFormValueForSingleAttr(java.lang.String formId, int formDataType, java.lang.String formName)	Deprecated. Use ExpressionHelper.formatAttributeFormValueForSingleAttr(java.lang.String, int, java.lang.String).
static java.lang.String	formatAttributeValue(java.lang.String attId, java.lang.String attName)	Deprecated. Use ExpressionHelper.formatObjectInfoValue(java.lang.String, int, java.lang.String).
static java.lang.String	formatObjectInfoValue(java.lang.String id, int type, java.lang.String name)	Deprecated. Use ExpressionHelper.formatObjectInfoValue(java.lang.String, int, java.lang.String).
static void	generateBUTTON(MarkupOutput mo, int indent, java.lang.String name, java.lang.String value, java.lang.String style)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateBUTTON(MarkupOutput mo, int indent, java.lang.String name, java.lang.String value, java.lang.String style, java.lang.String type, boolean isDisabled)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateCheckBox(MarkupOutput mo, int indent, java.lang.String name, java.lang.String currentValue)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateCheckBox(MarkupOutput mo, int indent, java.lang.String name, java.lang.String currentValue, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateCloseAnchor(MarkupOutput mo)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateCloseAnchor(java.lang.StringBuffer sb)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateComboBox(MarkupOutput mo, int indent, java.lang.String name, HashList options, java.lang.String currentValue)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateComboBox(MarkupOutput mo, int indent, java.lang.String name, HashList options, java.lang.String currentValue, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateComboBox(MarkupOutput mo, int indent, java.lang.String name, java.lang.String[][] options, java.lang.String currentValue)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateComboBox(MarkupOutput mo, int indent, java.lang.String name, java.lang.String[][] options, java.lang.String currentValue, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static Tag[]	generateComboOptions(WebComponent bean, AppContext appContext, ShortcutList list, java.lang.String selectedValue)	Helper metod that returns an array of option Tags to be used in a combobox.
static Tag[]	generateComboOptions(WebComponent bean, AppContext appContext, ShortcutList list, java.lang.String selectedValue, boolean useEventIDOnly)	Helper metod that returns an array of option Tags to be used in a combobox.
static void	generateDynamicScript(MarkupOutput mo, AppContext appContext, java.lang.String fileName, java.lang.String key)	Adds a script tag with a link to dynamically load a JavaScript file.
static void	generateEventOrderForList(MarkupOutput mo, java.util.ArrayList eventList, NamespaceEncoder nse)
static void	generateFONT(MarkupOutput mo, int indent, java.lang.String fontFace, int fontSize)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateHiddenInputsForEvent(MarkupOutput mo, int indent, WebEvent event)	Deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent) instead.
static void	generateHiddenInputsForEvent(MarkupOutput mo, int indent, WebEvent event, boolean isDhtml)	Deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean) instead.
static void	generateHiddenInputsForEvent(MarkupOutput mo, int indent, WebEvent event, boolean isDhtml, int state)	Deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean, int) instead.
static void	generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event)	Generates the set of hidden inputs associated with a given event using the minal state info.
static void	generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml)	Generates the set of hidden inputs associated with a given event using the minal state info.
static void	generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml, int state)	Generates the set of hidden inputs associated with a given event.
static void	generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml, int state, boolean renderState)
static void	generateHiddenInputsForEventList(MarkupOutput mo, int indent, java.util.ArrayList eventList)	Deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, NamespaceEncoder nse)
static void	generateHiddenInputsForEventList(MarkupOutput mo, int indent, java.util.ArrayList eventList, boolean isDhtml)	Deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, NamespaceEncoder nse)
static void	generateHiddenInputsForEventList(MarkupOutput mo, int indent, java.util.ArrayList eventList, boolean isDhtml, int state)	Deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, int state, NamespaceEncoder nse)
static void	generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, java.util.ArrayList eventList, boolean isDhtml, int state, NamespaceEncoder nse)	Generates those hidden inputs associated with the given event list.
static void	generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, java.util.ArrayList eventList, boolean isDhtml, NamespaceEncoder nse)	Generates those hidden inputs associated with the given event list.
static void	generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, java.util.ArrayList eventList, NamespaceEncoder nse)	Generates those hidden inputs associated with the given event list.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, int width, int height)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, int width, int height, java.lang.String alt, int border)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, java.lang.String alt)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String imgFolder, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String imgFolder, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String id, java.lang.String imgFolder, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(MarkupOutput mo, int indent, java.lang.String src, java.lang.String width, java.lang.String height, java.lang.String alt, int border, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMG(java.lang.StringBuffer mo, int indent, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMGForSubmit(MarkupOutput mo, int indent, java.lang.String name, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMGForSubmit(MarkupOutput mo, int indent, java.lang.String name, java.lang.String imgFolder, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMGForSubmit(MarkupOutput mo, int indent, java.lang.String name, java.lang.String src, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMGForSubmit(java.lang.StringBuffer mo, int indent, java.lang.String name, java.lang.String src, int width, int height, java.lang.String alt, int border, java.lang.String align)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIMGForSubmit(java.lang.StringBuffer mo, int indent, java.lang.String name, java.lang.String src, java.lang.String alt, int border, java.lang.String align, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateIndent(MarkupOutput mo, int indent)	Deprecated. Transforms don't indent their output anymore.
static void	generateIndent(java.lang.StringBuffer mo, int indent)	Deprecated. Transforms don't indent their output anymore.
static void	generateINPUT(MarkupOutput mo, int indent, java.lang.String type, java.lang.String name, java.lang.String value, boolean checked)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateINPUT(MarkupOutput mo, int indent, java.lang.String type, java.lang.String name, java.lang.String value, boolean checked, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateINPUT(MarkupOutput mo, int indent, java.lang.String type, java.lang.String name, java.lang.String value, boolean checked, java.lang.String duplicateHiddenInputValue, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateINPUT(java.lang.StringBuffer mo, int indent, java.lang.String type, java.lang.String name, java.lang.String value, boolean checked, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static java.lang.String	generateJavaScriptMethodCall(java.lang.String methodName, java.lang.String[] args, boolean includeReturn, int indexForThis)	Utility method to generate Javascript method call in HTML.
static void	generateOPTION(MarkupOutput mo, int indent, java.lang.String value, java.lang.String content, boolean selected, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateOPTION(MarkupOutput mo, int indent, java.lang.String value, java.lang.String content, boolean selected, java.lang.String extraParameters, boolean encodeData)	Deprecated. Tags should be generated using the Tags infrastructure.
static Tag	generateOPTION(java.lang.String value, java.lang.String content, boolean selected)	Returns an option Tag with the information provided
static java.lang.String	generateSkipNavigationLinkHeader(AppContext appContext, java.lang.String anchorName)	Deprecated. Transforms don't generate this link anymore.
static java.lang.String	generateSkipNavigationLinkTarget(AppContext appContext, java.lang.String anchorName)	Deprecated. Transforms don't generate this link anymore.
static void	generateSPAN(MarkupOutput mo, int indent, java.lang.String cssName, java.lang.String content)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateSPAN(MarkupOutput mo, int indent, java.lang.String cssName, java.lang.String content, boolean encodeContent)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTABLE(MarkupOutput mo, int indent, java.lang.String width, java.lang.String border, java.lang.String cellSpacing, java.lang.String cellPadding, java.lang.String bgColor, java.lang.String cssName)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTABLE(MarkupOutput mo, int indent, java.lang.String width, java.lang.String border, java.lang.String cellSpacing, java.lang.String cellPadding, java.lang.String bgColor, java.lang.String cssName, java.lang.String id)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTABLE(MarkupOutput mo, int indent, java.lang.String width, java.lang.String border, java.lang.String cellSpacing, java.lang.String cellPadding, java.lang.String bgColor, java.lang.String cssName, java.lang.String id, java.lang.String summary)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTABLE(MarkupOutput mo, int indent, java.lang.String width, java.lang.String border, java.lang.String cellSpacing, java.lang.String cellPadding, java.lang.String bgColor, java.lang.String cssName, java.lang.String id, java.lang.String summary, java.lang.String extraStyle)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTABLE(MarkupOutput mo, int indent, java.lang.String width, java.lang.String border, java.lang.String cellSpacing, java.lang.String cellPadding, java.lang.String bgColor, java.lang.String background, java.lang.String cssName, java.lang.String id, java.lang.String summary, java.lang.String extraStyle)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTEXTAREA(MarkupOutput mo, int indent, java.lang.String name, java.lang.String value, int columns, int rows, java.lang.String style)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTEXTBOX(MarkupOutput mo, int indent, java.lang.String name, java.lang.String value, java.lang.String size, java.lang.String maxLength, java.lang.String style)	Deprecated. Tags should be generated using the Tags infrastructure.
static void	generateTEXTBOX(MarkupOutput mo, int indent, java.lang.String name, java.lang.String value, java.lang.String size, java.lang.String maxLength, java.lang.String style, java.lang.String extraParameters)	Deprecated. Tags should be generated using the Tags infrastructure.
static java.lang.String	getAppVersion()
static java.lang.String	getFormattedValue(java.lang.String value, java.util.Locale locale)	Converts any value with decimal to the corrected format.
static java.lang.String	getOfficeLink()	Deprecated. This method has been deprecated.
static java.lang.String	getOfficeLink(AppContext appContext)	Retrieves the Office Link URL from the default or Admin Preferences.
static java.lang.String	getQuickSymbolImageSource(int type)	Deprecated. replaced by EnumQuickSymbol.get(int) and EnumQuickSymbol.getImageSource()
static java.lang.String	getQuickSymbolString(int type)	Deprecated. replaced by EnumQuickSymbol.get(int) and EnumQuickSymbol.getWingdingsString()
static java.lang.String	getQuickSymbolUnicode(int type)	Deprecated. see EnumQuickSymbol
static java.lang.String	getQuickSymbolUnicodeByChar(char character)	Deprecated. should not be used - see EnumQuickSymbol
static java.lang.String	getRequestKeysString(BeanContext context)	Returns the string representation of the request keys as an & delimited list of name=value pairs.
static java.lang.String	getResourcePathWithVersion(java.lang.String originResourcePath, AppContext appContext)	Append web version parameter to resource path if it's not disabled in debug flag E.g. ..
static java.lang.String	getWebVersionHashCode(AppContext appContext)	Get hash code of web version Used to append as version parameter when loading resource
static boolean	isDefaultPreferenceValue(java.lang.String preferenceName, java.lang.String preferenceValue)	This method checks if the given preference exists with in the Admin Preferences, and if its value is the given one.
static boolean	isPluginResource(java.lang.String resourcePath)
static ImageTag	newImageTag(java.lang.String src, java.lang.String width, java.lang.String height, java.lang.String alt)	Convenience method that creates a IMG tag from the TagsFactory.
static InputTag	newInputCheck(java.lang.String name, java.lang.String value, boolean checked, NamespaceEncoder nse)	Convenience method that creates a checkbox from the TagsFactory.
static InputTag	newInputHidden(java.lang.String name, java.lang.String value, NamespaceEncoder nse)	Convenience method that creates a hidden input from the TagsFactory.
static InputTag	newInputImage(java.lang.String name, java.lang.String src, java.lang.String width, java.lang.String height, java.lang.String title, NamespaceEncoder nse)	Convenience method that creates an image input from the TagsFactory.
static InputTag	newInputNumber(java.lang.String name, java.lang.String value, java.lang.String minValue, java.lang.String maxValue, NamespaceEncoder nse)
static InputTag	newInputRadio(java.lang.String name, java.lang.String value, boolean checked, NamespaceEncoder nse)	Convenience method that creates a radio button from the TagsFactory.
static InputTag	newInputRadio(java.lang.String id, java.lang.String name, java.lang.String value, boolean checked, NamespaceEncoder nse)	Convenience method that creates a radio button from the TagsFactory.
static InputTag	newInputSubmit(java.lang.String name, java.lang.String value, NamespaceEncoder nse)	Convenience method that creates a submit button from the TagsFactory.
static InputTag	newInputText(java.lang.String name, java.lang.String value, java.lang.String size, java.lang.String maxLength, NamespaceEncoder nse)	Convenience method that creates a text field from the TagsFactory.
protected static ParameterBuilder	newURIBuilder(AppContext appContext)	Creates a new ParameterBuilder from the AppContext.
static void	renderQuickSymbolforText(MarkupOutput out, java.lang.String text, boolean isIE)	Deprecated. should not use this - see EnumQuickSymbol

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_TYPE_RADIO

public static final java.lang.String INPUT_TYPE_RADIO

See Also:

Constant Field Values

INPUT_TYPE_CHECKBOX

public static final java.lang.String INPUT_TYPE_CHECKBOX

See Also:

Constant Field Values

INPUT_TYPE_TEXT

public static final java.lang.String INPUT_TYPE_TEXT

See Also:

Constant Field Values

INPUT_TYPE_SUBMIT

public static final java.lang.String INPUT_TYPE_SUBMIT

See Also:

Constant Field Values

INPUT_TYPE_HIDDEN

public static final java.lang.String INPUT_TYPE_HIDDEN

See Also:

Constant Field Values

INPUT_TYPE_BUTTON

public static final java.lang.String INPUT_TYPE_BUTTON

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

DEFAULT_FORM_METHOD

public static final java.lang.String DEFAULT_FORM_METHOD

See Also:

Constant Field Values

DEFAULT_FORM_NAME

public static final java.lang.String DEFAULT_FORM_NAME

See Also:

Constant Field Values

CSS_ERROR_TITLE

public static final java.lang.String CSS_ERROR_TITLE

See Also:

Constant Field Values

CSS_ERROR_MESSAGE

public static final java.lang.String CSS_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

HTMLHelper

public HTMLHelper()

Creates new HTMLHelper

Method Detail

generateSkipNavigationLinkHeader

@Deprecated
public static java.lang.String generateSkipNavigationLinkHeader(AppContext appContext,
                                                                java.lang.String anchorName)

Deprecated.

Transforms don't generate this link anymore. It's generated directly in the JSP.

Display the skip navigation link required for supporting screen readers

Parameters:

appContext - a valid instance of AppContext

anchorName - the name that the skip navigation anchor will have (target)

Returns:

a String with the HTML content to be displayed for the Skip Navigation link.

generateSkipNavigationLinkTarget

@Deprecated
public static java.lang.String generateSkipNavigationLinkTarget(AppContext appContext,
                                                                java.lang.String anchorName)

Deprecated.

Transforms don't generate this link anymore. It's generated directly in the JSP.

Display the skip navigation link target required for supporting screen readers

Parameters:

appContext - a valid instance of AppContext

anchorName - the name that the skip navigation anchor will have (target)

Returns:

a String with the HTML content to be displayed for the Skip Navigation link.

generateIndent

@Deprecated
public static void generateIndent(MarkupOutput mo,
                                  int indent)

Deprecated.

Transforms don't indent their output anymore.

Generate a number of tabs to indent the line...

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

generateIndent

@Deprecated
public static void generateIndent(java.lang.StringBuffer mo,
                                  int indent)

Deprecated.

Transforms don't indent their output anymore.

Generate a number of tabs to indent the line...

Parameters:

mo - StringBuffer object to use.

indent - the indentation level to generate for

generateSPAN

@Deprecated
public static void generateSPAN(MarkupOutput mo,
                                int indent,
                                java.lang.String cssName,
                                java.lang.String content)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a SPAN tag with a specific css and text.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

cssName - the css class name

content - the content of the span

generateSPAN

@Deprecated
public static void generateSPAN(MarkupOutput mo,
                                int indent,
                                java.lang.String cssName,
                                java.lang.String content,
                                boolean encodeContent)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a SPAN tag with a specific css and text.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

cssName - the css class name

content - the content of the span

encodeContent - weather encode the content

generateFONT

@Deprecated
public static void generateFONT(MarkupOutput mo,
                                int indent,
                                java.lang.String fontFace,
                                int fontSize)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a FONT tag with a specific face and size.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

fontFace - the value of the FACE attribute

fontSize - the value of the SIZE attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               java.lang.String alt)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source and alt etc. The BORDER is set to 0 and the ALT tag is empty.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

alt - the value of the ALT attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               int width,
                               int height)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc. The BORDER is set to 0 and the ALT tag is empty.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               java.lang.String width,
                               java.lang.String height,
                               java.lang.String alt,
                               int border,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

extraParameters - any extra attributes to add to the tag

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String imgFolder,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

imgFolder - The relative path in the application for the images folder.

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String id,
                               java.lang.String imgFolder,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

id - the image ID

imgFolder - The relative path in the application for the images folder.

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String imgFolder,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

imgFolder - The relative path in the application for the images folder.

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               java.lang.String alt,
                               int border,
                               java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateIMG

@Deprecated
public static void generateIMG(MarkupOutput mo,
                               int indent,
                               java.lang.String src,
                               java.lang.String alt,
                               int border,
                               java.lang.String align,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMG

@Deprecated
public static void generateIMG(java.lang.StringBuffer mo,
                               int indent,
                               java.lang.String src,
                               int width,
                               int height,
                               java.lang.String alt,
                               int border,
                               java.lang.String align,
                               java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag with specific source, height, width, etc....

Parameters:

mo - StringBuffer object to use.

indent - the indentation level to generate for

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMGForSubmit

@Deprecated
public static void generateIMGForSubmit(MarkupOutput mo,
                                        int indent,
                                        java.lang.String name,
                                        java.lang.String imgFolder,
                                        java.lang.String src,
                                        int width,
                                        int height,
                                        java.lang.String alt,
                                        int border,
                                        java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag for submitting a form

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

imgFolder - The relative path in the application for the images folder.

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateIMGForSubmit

@Deprecated
public static void generateIMGForSubmit(MarkupOutput mo,
                                        int indent,
                                        java.lang.String name,
                                        java.lang.String src,
                                        int width,
                                        int height,
                                        java.lang.String alt,
                                        int border,
                                        java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag for submitting a form

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateIMGForSubmit

@Deprecated
public static void generateIMGForSubmit(MarkupOutput mo,
                                        int indent,
                                        java.lang.String name,
                                        java.lang.String src,
                                        java.lang.String alt,
                                        int border,
                                        java.lang.String align,
                                        java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMAGE INPUT tag with specific source, name, alt, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

src - the value of the SRC attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMGForSubmit

@Deprecated
public static void generateIMGForSubmit(java.lang.StringBuffer mo,
                                        int indent,
                                        java.lang.String name,
                                        java.lang.String src,
                                        java.lang.String alt,
                                        int border,
                                        java.lang.String align,
                                        java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMAGE INPUT tag with specific source, name, alt, etc....

Parameters:

mo - StringBuffer object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

src - the value of the SRC attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

extraParameters - any other properties or events that should be defined

generateIMGForSubmit

@Deprecated
public static void generateIMGForSubmit(java.lang.StringBuffer mo,
                                        int indent,
                                        java.lang.String name,
                                        java.lang.String src,
                                        int width,
                                        int height,
                                        java.lang.String alt,
                                        int border,
                                        java.lang.String align)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an IMG tag for submitting a form

Parameters:

mo - StringBuffer object to use

indent - the indentation level to generate for

name - the value of the NAME attribute

src - the value of the SRC attribute

width - the value of the WIDTH attribute

height - the value of the HEIGHT attribute

alt - the value of the ALT attribute

border - the value of the BORDER attribute

align - the value of the ALIGN attribute

generateINPUT

@Deprecated
public static void generateINPUT(MarkupOutput mo,
                                 int indent,
                                 java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean checked)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag with specific type, name, value, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

type - the value of the TYPE attribute

name - the value of the NAME attribute

value - the value of the VALUE attribute

checked - whether the CHECKED attribute is set to 1.

generateINPUT

@Deprecated
public static void generateINPUT(MarkupOutput mo,
                                 int indent,
                                 java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean checked,
                                 java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag with specific type, name, value, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

type - the value of the TYPE attribute

name - the value of the NAME attribute

value - the value of the VALUE attribute

checked - whether the CHECKED attribute is set to 1.

extraParameters - any other attributes or events to add to the tag

generateINPUT

@Deprecated
public static void generateINPUT(MarkupOutput mo,
                                 int indent,
                                 java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean checked,
                                 java.lang.String duplicateHiddenInputValue,
                                 java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag with specific type, name, value, etc....

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

type - the value of the TYPE attribute

name - the value of the NAME attribute

value - the value of the VALUE attribute

duplicateHiddenInputValue - the value of a hidden input to be created as duplicate of the input tag that it's going to be created. This is meant to be used with checkboxes, having a value usually of "0" (zero). If it's not to be used, it should receive a null.

checked - whether the CHECKED attribute is set to 1.

extraParameters - any other attributes or events to add to the tag

generateINPUT

@Deprecated
public static void generateINPUT(java.lang.StringBuffer mo,
                                 int indent,
                                 java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean checked,
                                 java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag with specific type, name, value, etc....

Parameters:

mo - StringBuffer object to use.

indent - the indentation level to generate for

type - the value of the TYPE attribute

name - the value of the NAME attribute

value - the value of the VALUE attribute

checked - whether the CHECKED attribute is set to 1.

extraParameters - any other attributes or events to add to the tag

generateBUTTON

@Deprecated
public static void generateBUTTON(MarkupOutput mo,
                                  int indent,
                                  java.lang.String name,
                                  java.lang.String value,
                                  java.lang.String style)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag for submit button

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

value - the value of the VALUE attribute

style - the value of the CLASS attribute

generateBUTTON

@Deprecated
public static void generateBUTTON(MarkupOutput mo,
                                  int indent,
                                  java.lang.String name,
                                  java.lang.String value,
                                  java.lang.String style,
                                  java.lang.String type,
                                  boolean isDisabled)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag for a button (normal button or submit button)

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

value - the value of the VALUE attribute

style - the value of the CLASS attribute

type - the value of the type attribute

isDisabled - the value of the DISABLED attribute

generateTEXTBOX

@Deprecated
public static void generateTEXTBOX(MarkupOutput mo,
                                   int indent,
                                   java.lang.String name,
                                   java.lang.String value,
                                   java.lang.String size,
                                   java.lang.String maxLength,
                                   java.lang.String style)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag for text box

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

value - the value of the VALUE attribute

size - the value of the SIZE attribute

maxLength - the value of the MAXLENGTH attribute

style - the value of the CLASS attribute

generateTEXTBOX

@Deprecated
public static void generateTEXTBOX(MarkupOutput mo,
                                   int indent,
                                   java.lang.String name,
                                   java.lang.String value,
                                   java.lang.String size,
                                   java.lang.String maxLength,
                                   java.lang.String style,
                                   java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate an INPUT tag for text box

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

value - the value of the VALUE attribute

size - the value of the SIZE attribute

maxLength - the value of the MAXLENGTH attribute

style - the value of the CLASS attribute

extraParameters - the value of extra Parameters

generateTEXTAREA

@Deprecated
public static void generateTEXTAREA(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    java.lang.String value,
                                    int columns,
                                    int rows,
                                    java.lang.String style)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TEXTAREA tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

value - the value of the VALUE attribute

columns - the value of the COLS attribute

rows - the value of the ROWS attribute

style - the CSS style to use

generateTABLE

@Deprecated
public static void generateTABLE(MarkupOutput mo,
                                 int indent,
                                 java.lang.String width,
                                 java.lang.String border,
                                 java.lang.String cellSpacing,
                                 java.lang.String cellPadding,
                                 java.lang.String bgColor,
                                 java.lang.String cssName,
                                 java.lang.String id)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TABLE tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

width - the value of the WIDTH attribute

border - the value of the BORDER attribute

cellSpacing - the value of the CELLSPACING attribute

cellPadding - the value of the CELLPADDING attribute

bgColor - the value of the BGCOLOR attribute

cssName - the value of the STYLE attribute

id - the value of the ID attribute

generateTABLE

@Deprecated
public static void generateTABLE(MarkupOutput mo,
                                 int indent,
                                 java.lang.String width,
                                 java.lang.String border,
                                 java.lang.String cellSpacing,
                                 java.lang.String cellPadding,
                                 java.lang.String bgColor,
                                 java.lang.String cssName,
                                 java.lang.String id,
                                 java.lang.String summary,
                                 java.lang.String extraStyle)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TABLE tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

width - the value of the WIDTH attribute

border - the value of the BORDER attribute

cellSpacing - the value of the CELLSPACING attribute

cellPadding - the value of the CELLPADDING attribute

bgColor - the value of the BGCOLOR attribute

cssName - the value of the CLASS attribute

id - the value of the ID attribute

summary - the value of the SUMMARY attribute

extraStyle - the value of the STYLE attribute

generateTABLE

@Deprecated
public static void generateTABLE(MarkupOutput mo,
                                 int indent,
                                 java.lang.String width,
                                 java.lang.String border,
                                 java.lang.String cellSpacing,
                                 java.lang.String cellPadding,
                                 java.lang.String bgColor,
                                 java.lang.String background,
                                 java.lang.String cssName,
                                 java.lang.String id,
                                 java.lang.String summary,
                                 java.lang.String extraStyle)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TABLE tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

width - the value of the WIDTH attribute

border - the value of the BORDER attribute

cellSpacing - the value of the CELLSPACING attribute. If parameter is empty, CELLSPACING attribute will not be set on table.

cellPadding - the value of the CELLPADDING attribute. If parameter is empty, CELLSPADDING attribute will not be set on table.

bgColor - the value of the BGCOLOR attribute

cssName - the value of the CLASS attribute

background - the value of the BACKGROUND attribute

id - the value of the ID attribute

summary - the value of the SUMMARY attribute

extraStyle - the value of the STYLE attribute

generateTABLE

@Deprecated
public static void generateTABLE(MarkupOutput mo,
                                 int indent,
                                 java.lang.String width,
                                 java.lang.String border,
                                 java.lang.String cellSpacing,
                                 java.lang.String cellPadding,
                                 java.lang.String bgColor,
                                 java.lang.String cssName,
                                 java.lang.String id,
                                 java.lang.String summary)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TABLE tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

width - the value of the WIDTH attribute

border - the value of the BORDER attribute

cellSpacing - the value of the CELLSPACING attribute

cellPadding - the value of the CELLPADDING attribute

bgColor - the value of the BGCOLOR attribute

cssName - the value of the STYLE attribute

id - the value of the ID attribute

summary - the value of the SUMMARY attribute

generateTABLE

@Deprecated
public static void generateTABLE(MarkupOutput mo,
                                 int indent,
                                 java.lang.String width,
                                 java.lang.String border,
                                 java.lang.String cellSpacing,
                                 java.lang.String cellPadding,
                                 java.lang.String bgColor,
                                 java.lang.String cssName)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generate a TABLE tag

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

width - the value of the WIDTH attribute

border - the value of the BORDER attribute

cellSpacing - the value of the CELLSPACING attribute

cellPadding - the value of the CELLPADDING attribute

bgColor - the value of the BGCOLOR attribute

cssName - the value of the CLASS attribute

fillComboPaperList

@Deprecated
public static boolean fillComboPaperList(MarkupOutput mo,
                                         int indent,
                                         java.lang.String name,
                                         java.lang.String size,
                                         java.lang.String selectedValue,
                                         PaperSizesList paperList,
                                         AppContext appContext)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Generates an select list containing the elements from the configuration list

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

size - the value of the SIZE attribute

selectedValue - the value of marked as the seletected one.

paperList - the List to render

appContext - the AppContext object to use to find the file.

Returns:

whether it found the selected item.

fillComboPaperList

@Deprecated
public static SelectTag fillComboPaperList(java.lang.String name,
                                           java.lang.String selectedValue,
                                           PaperSizesList paperList,
                                           AppContext appContext)

Deprecated.

Use fillComboPaperList(String, String, ShortcutList, AppContext)

Generates a select list containing the elements from the configuration list

Parameters:

name - String the value of the NAME attribute

selectedValue - String the value of marked as the seletected one.

paperList - PaperSizesList the List to render

appContext - AppContext the AppContext object to use to find the file.

Returns:

SelectTag the com box as a Tag instance

Since:

MicroStrategy Web 8.0.0

fillComboPaperList

public static SelectTag fillComboPaperList(java.lang.String name,
                                           java.lang.String selectedValue,
                                           ShortcutList paperList,
                                           AppContext appContext)

Generates a select list containing the elements from the configuration list

Parameters:

name - String the value of the NAME attribute

selectedValue - String the value of marked as the seletected one.

paperList - ShortcutList the List to render

appContext - AppContext the AppContext object to use to find the file.

Returns:

SelectTag the com box as a Tag instance

Since:

MicroStrategy Web 9.0.0

fillComboFromXML

@Deprecated
public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String name,
                                       java.lang.String size,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

size - the value of the SIZE attribute

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

Returns:

whether it found the selected item.

fillComboFromXML

@Deprecated
public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String name,
                                       java.lang.String size,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext,
                                       java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

size - the value of the SIZE attribute *

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

extraParameters - any other properties or events that should be defined on the combo box. For example: ONCHANGE=\"update();\"

Returns:

whether it found the selected item.

fillComboFromXML

@Deprecated
public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String name,
                                       java.lang.String size,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext,
                                       boolean addDefault,
                                       java.lang.String defaultContent,
                                       java.lang.String defaultValue,
                                       java.lang.String extraParameters,
                                       WebComponent baseBean)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

size - the value of the SIZE attribute *

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

addDefault - indicates whether a new option entry should be created at the beginning for simulating a default value entry on the combo box.

defaultContent - the text of the new default option will hold - if applicable

defaultValue - the value of the new default option will hold - if applicable

extraParameters - any other properties or events that should be defined on the combo box. For example: ONCHANGE=\"update();\"

baseBean - The basebean used for features.

Returns:

whether it found the selected item.

fillComboFromXML

@Deprecated
public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String name,
                                       java.lang.String size,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext,
                                       boolean addDefault,
                                       java.lang.String defaultContent,
                                       java.lang.String defaultValue,
                                       java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

size - the value of the SIZE attribute *

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

addDefault - indicates whether a new option entry should be created at the beginning for simulating a default value entry on the combo box.

defaultContent - the text the new default option will hold - if applicable

defaultValue - the value of the new default option will hold - if applicable

extraParameters - any other properties or events that should be defined on the combo box. For example: ONCHANGE=\"update();\"

Returns:

whether it found the selected item.

generateComboOptions

public static Tag[] generateComboOptions(WebComponent bean,
                                         AppContext appContext,
                                         ShortcutList list,
                                         java.lang.String selectedValue)

Helper metod that returns an array of option Tags to be used in a combobox. The list of options is taken from the given ShortcutList. This method makes sure that the features in the Shortcut are correctly applied to the Option

Since:

MicroStrategy Web 8.0.0

generateComboOptions

public static Tag[] generateComboOptions(WebComponent bean,
                                         AppContext appContext,
                                         ShortcutList list,
                                         java.lang.String selectedValue,
                                         boolean useEventIDOnly)

Helper metod that returns an array of option Tags to be used in a combobox. The list of options is taken from the given ShortcutList. This method makes sure that the features in the Shortcut are correctly applied to the Option

Since:

MicroStrategy Web 8.0.0

fillComboFromXML

public static boolean fillComboFromXML(MarkupOutput mo,
                                       WebComponent baseBean,
                                       int indent,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext,
                                       java.lang.String comboKey,
                                       java.lang.String localeID)

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

comboKey - if a key is to be searched for on the xmlFile (list_options tag)

localeID - if a localeID is to be searched for on the xmlFile (list_options tag)

Returns:

whether it found the selected item.

fillComboFromXML

public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext,
                                       java.lang.String comboKey,
                                       java.lang.String localeID)

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

comboKey - if a key is to be searched for on the xmlFile (list_options tag)

localeID - if a localeID is to be searched for on the xmlFile (list_options tag)

Returns:

whether it found the selected item.

fillComboFromXML

public static boolean fillComboFromXML(MarkupOutput mo,
                                       int indent,
                                       java.lang.String selectedValue,
                                       java.lang.String xmlFile,
                                       AppContext appContext)

Fills a COMBO box with the contents of an XML file.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

selectedValue - the value of marked as the seletected one.

xmlFile - the filename of the XML file to use

appContext - the AppContext object to use to find the file.

Returns:

whether it found the selected item.

generateComboBox

@Deprecated
public static void generateComboBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    java.lang.String[][] options,
                                    java.lang.String currentValue,
                                    java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a combobox with the list of given options. The option who matches the current value is automatically selected. The extraParameters argument might include other <SELECT> attributes to be added to the HTML to be generated.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

options - a two-dimensional array with the values and text to use for each one of the options

currentValue - the value of the currently selected option

extraParameters - any other attributes that should be defined when creating the combo box.

generateComboBox

@Deprecated
public static void generateComboBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    java.lang.String[][] options,
                                    java.lang.String currentValue)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a combobox with the list of given options. The option who matches the current value is automatically selected.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

options - a two-dimensional array with the values and text to use for each one of the options

currentValue - the value of the currently selected option

generateComboBox

@Deprecated
public static void generateComboBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    HashList options,
                                    java.lang.String currentValue,
                                    java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a combobox with the list of given options. The option who matches the current value is automatically selected. The extraParameters argument might include other <SELECT> attributes to be added to the HTML to be generated.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

options - hash list with the values and text to use for each one of the options

currentValue - the value of the currently selected option

extraParameters - any other attributes that should be defined when creating the combo box.

generateOPTION

public static Tag generateOPTION(java.lang.String value,
                                 java.lang.String content,
                                 boolean selected)

Returns an option Tag with the information provided

Parameters:

value - String with the value of the option

content - String with the text to be displayed for that option

selected - boolean indicating if it's currently selected

Returns:

Tag

generateOPTION

@Deprecated
public static void generateOPTION(MarkupOutput mo,
                                  int indent,
                                  java.lang.String value,
                                  java.lang.String content,
                                  boolean selected,
                                  java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders an <OPTION> tag with the information provided

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

value - String with the value of the option

content - String with the text to be displayed for that option

selected - boolean indicating if it's currently selected

extraParameters - any other attributes or events that shall be added to the tag.

generateOPTION

@Deprecated
public static void generateOPTION(MarkupOutput mo,
                                  int indent,
                                  java.lang.String value,
                                  java.lang.String content,
                                  boolean selected,
                                  java.lang.String extraParameters,
                                  boolean encodeData)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders an <OPTION> tag with the information provided

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

value - String with the value of the option

content - String with the text to be displayed for that option

selected - boolean indicating if it's currently selected

extraParameters - any other attributes or events that shall be added to the tag.

generateComboBox

@Deprecated
public static void generateComboBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    HashList options,
                                    java.lang.String currentValue)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a combobox with the list of given options. The option who matches the current value is automatically selected.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

options - hash list with the values and text to use for each one of the options

currentValue - the value of the currently selected option

generateCheckBox

@Deprecated
public static void generateCheckBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    java.lang.String currentValue,
                                    java.lang.String extraParameters)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a checkbox given a value. If the value is 1, the box is rendered checked.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

currentValue - the value of the check box

extraParameters - the extra parameters to be rendered with this checkbox

generateCheckBox

@Deprecated
public static void generateCheckBox(MarkupOutput mo,
                                    int indent,
                                    java.lang.String name,
                                    java.lang.String currentValue)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Renders a checkbox given a value. If the value is 1, the box is rendered checked.

Parameters:

mo - MarkupOutput object to use.

indent - the indentation level to generate for

name - the value of the NAME attribute

currentValue - the value of the check box

generateCloseAnchor

@Deprecated
public static void generateCloseAnchor(MarkupOutput mo)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Closes an anchor tag.

Parameters:

mo - MarkupOutput object to use.

generateCloseAnchor

@Deprecated
public static void generateCloseAnchor(java.lang.StringBuffer sb)

Deprecated.

Tags should be generated using the Tags infrastructure. See TagsFactory.

Closes an anchor tag.

Parameters:

sb - StringBuffer object to use.

displayError

public static void displayError(MarkupOutput transOut,
                                java.lang.String className,
                                java.lang.String methodName,
                                java.lang.Exception e,
                                java.lang.String title,
                                java.lang.String message)

Writes an error message.

Parameters:

transOut - the output

className - the class that originated the error

methodName - the method where the error was originated

e - the exception caught that caused the error

title - the title for the error message

message - the error message to display

displayError

@Deprecated
public static void displayError(MarkupOutput out,
                                java.lang.String className,
                                java.lang.String methodName,
                                java.lang.Exception e,
                                java.lang.String title,
                                java.lang.String message,
                                java.lang.String errorInfo,
                                java.lang.String contactInfo)

Deprecated.

This is method has been deprecated as css-classes are not optional anymore.

Writes an error message.

Parameters:

out - the output

className - the class that originated the error

methodName - the method where the error was originated

e - the exception caught that caused the error

title - the title for the error message

message - the error message to display

errorInfo - the error information

displayError

public static void displayError(MarkupOutput out,
                                java.lang.String className,
                                java.lang.String methodName,
                                java.lang.Exception e,
                                java.lang.String title,
                                java.lang.String message,
                                java.lang.String errorInfo,
                                java.lang.String contactInfo,
                                Tag extra)

Writes an error message.

Parameters:

out - the output

className - the class that originated the error

methodName - the method where the error was originated

e - the exception caught that caused the error

title - the title for the error message

message - the error message to dispal

extra - a Tag containing any extra information to display with the error

Since:

MicroStrategy Web 8.0.0

euroEncode

@Deprecated
public static java.lang.String euroEncode(java.lang.String oldStr)

Deprecated.

The application doesn't require to encode the Euro symbol.

Encodes the Euro symbol within the given string.

Parameters:

oldStr - The string to encode

Returns:

the encoded string, changing only the euro character into its display representation

encode

public static java.lang.String encode(java.lang.String oldStr)

Encodes a string using HTML encoding. This is the type of encoding that enables a browser to correctly display all characters.

Parameters:

oldStr - String to encode

Returns:

an HTML encoded string.

encode

public static java.lang.String encode(java.lang.String oldStr,
                                      boolean encodeSpaces)

encodeEscapeApostrophe

public static java.lang.String encodeEscapeApostrophe(java.lang.String oldStr)

encodeForTooltip

public static java.lang.String encodeForTooltip(java.lang.String tooltipStr)

encodeForAllowHtmlOnMetrics

public static java.lang.String encodeForAllowHtmlOnMetrics(java.lang.String oldStr)

encodeExcludeSubStr

public static java.lang.String encodeExcludeSubStr(java.lang.String excludeStr,
                                                   java.lang.String wholeStr)

/** encode object details, the description part will not encode if allowing html on object description

Parameters:

excludeStr - String the substring which will not be encode in the whole string

wholeStr - String the entire string

Since:

MicroStrategy Web 9.0.0

decode

public static java.lang.String decode(java.lang.String oldStr)

Given an HTML encoded string, returns its decoded version (using plain characters instead of browser's specifc encoding).

Parameters:

oldStr - String to decode

Returns:

an HTML decoded string.

getFormattedValue

public static java.lang.String getFormattedValue(java.lang.String value,
                                                 java.util.Locale locale)

Converts any value with decimal to the corrected format. For example, the spanish version of 8.5 is 8,5 and the output is formatted to 8.5

Since:

MicroStrategy Web 8.0.0

convertFormattedValue

public static java.lang.String convertFormattedValue(java.lang.String value,
                                                     java.util.Locale locale)

Converts any value with decimal into locale dependent format. For example, the spanish version of 8.5 is 8,5 and the output is formatted to 8,5

Since:

MicroStrategy Web 9.0.0

convertInchesToPixel

public static java.lang.String convertInchesToPixel(java.lang.String inches,
                                                    int dpiConversion,
                                                    java.util.Locale locale,
                                                    int zoomFactor)

Converts inches into pixels.

Parameters:

inches - String with the inches values

dpiConversion - Conversion factor to convert from inches to pixels

locale - current locate

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

the the conversion of inches to pixels.

Since:

MicroStrategy Web 8.0.0

convertPixelsToInches

public static java.lang.String convertPixelsToInches(java.lang.String pixels,
                                                     int dpiConversion,
                                                     java.util.Locale locale,
                                                     int zoomFactor)

Converts pixels into inches.

Parameters:

pixels - String with the pixels value

dpiConversion - Conversion factor to convert from inches to pixels

locale - current locate

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

the the conversion of inches to pixels.

Since:

MicroStrategy Web 8.0.0

convertPixelsToInches

public static double convertPixelsToInches(double pixels,
                                           int dpiConversion,
                                           int zoomFactor)

Converts pixels to inches

Parameters:

pixels - double value with the number of pixels to convert to inches

dpiConversion - Conversion factor to convert from inches to pixels

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

the conversion of pixels to inches.

Since:

MicroStrategy Web 8.0.1

convertPtsToPixels

public static double convertPtsToPixels(double pts,
                                        int dpiConversion,
                                        int zoomFactor)

Convert points to pixels

Parameters:

pts - double value with the number of points to convert to pixels.

dpiConversion - Conversion factor to convert from inches to pixels

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

double value with the number of pixels given the point units indicated

Since:

MicroStrategy Web 8.0.1

convertPixelsToPoints

public static double convertPixelsToPoints(double pixels,
                                           int dpiConversion,
                                           int zoomFactor)

Convert pixels to points

Parameters:

pixels - double value with the number of pixels to convert to points.

dpiConversion - Conversion factor to convert from inches to pixels

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

double value with the number of points given the pixel units indicated

Since:

MicroStrategy Web 8.0.1

convertPtsToInches

public static double convertPtsToInches(double pts)

Converts points into inches.

Parameters:

pts - String with the pts values

Returns:

the conversion of pts to pixels.

Since:

MicroStrategy Web 8.0.0

fixPixelsForBase96

public static int fixPixelsForBase96(int pixels,
                                     int dpiConversion,
                                     int zoomFactor)

Adjusts pixels for zoom and dpi assuming a base dpi of 96.

Parameters:

pixels - The number of pixels

dpiConversion - Conversion factor to convert from inches to pixels

zoomFactor - The zoom level at which the user wants to see the objects

Returns:

the number of pixels using the dpi and zoom factor.

Since:

MicroStrategy Web 8.0.0

fixPointsForZoom

public static java.lang.String fixPointsForZoom(java.lang.String points,
                                                int zoomFactor)

Fixes the point values used for font size and weight based on DPI conversion factor and zoom factors.

Parameters:

points - String with the points values

Returns:

the the conversion of inches to pixels.

Since:

MicroStrategy Web 8.0.0

convertColorDecimalToHex

public static java.lang.String convertColorDecimalToHex(java.lang.String colorCode)

Converts the integer representation of a color into its hexadecimal representation.

Parameters:

colorCode - a String with the decimal representation of the code to translate

Returns:

the hexadecimal color code as requested (as CCCCCC). If anything goes wrong, returns a null string.

convertColorHSBToHex

public static java.lang.String convertColorHSBToHex(int hue,
                                                    int saturation,
                                                    int brightness)

Converts the hsb components of a color into its hexadecimal representation.

Parameters:

hue - a String with the hue component of a color

saturation - a String with the saturation component of a color

brightness - a String with the brightness component of a color

Returns:

the hexadecimal color code as requested (e.g. CCCCCC). If anything goes wrong, returns a null string.

Since:

MicroStrategy Web 8.0.0

convertColorRGBToHSB

public static int[] convertColorRGBToHSB(int r,
                                         int g,
                                         int b)

Converts the red, green and blue components of a color into hsb components.

Parameters:

r - an int with the red component of a color

g - an int with the green component of a color

b - an int with the blue component of a color

Returns:

an array of ints containing the hue, saturation and brightness of the requested color.

Since:

MicroStrategy Web 8.0.0

convertColorBGRtoRGB

public static java.lang.String convertColorBGRtoRGB(java.lang.String colorHexCode)

Converts the hexadecimal representation of a color into its RRGGBB format or BBGGRR.

Parameters:

colorHexCode - a String with the hexadecimal representation of the code to translate

Returns:

the hexadecimal color code as requested. If original was RGB, the result is its BGR format, and viceversa

convertColorHexToDecimal

public static java.lang.String convertColorHexToDecimal(java.lang.String colorCode)

Converts the hexadecimal color code (e.g. #CCCCCC) sent as parameter to its decimal representation

Parameters:

colorCode - a String containing the hexadecimal representation of the color to translate

Returns:

a String with the integer value of the hexadecimal code. If anything goes wrong, returns a null.

convertColorDecimalToRGB

public static java.lang.String convertColorDecimalToRGB(java.lang.String colorCode)

Converts the decimal representation of a color into its RRGGBB format.

Parameters:

colorCode - a String containing the decimal representation of the color to translate

Returns:

a String with the integer value of the hexadecimal code. If anything goes wrong, returns a null.

Since:

MicroStrategy Web 9.0.0

convertColorDecimalToRGB

public static java.lang.String convertColorDecimalToRGB(int color)

Converts the decimal representation of a color into its RRGGBB format.

Parameters:

color - a String containing the decimal representation of the color to translate

Returns:

a String with the integer value of the hexadecimal code. If anything goes wrong, returns a null.

Since:

MicroStrategy Web 9.0.0

formatObjectInfoValue

@Deprecated
public static java.lang.String formatObjectInfoValue(java.lang.String id,
                                                     int type,
                                                     java.lang.String name)

Deprecated.

Use ExpressionHelper.formatObjectInfoValue(java.lang.String, int, java.lang.String).

With the given parameters, returns the string used by some event-handlers to identify an object-info. This string can then be used as the value of an <INPUT> tag to submit it in a form.

Parameters:

id - object-id

type - object-type

name - object-name

Returns:

A string value used to identify an object-info.

formatAttributeFormValue

@Deprecated
public static java.lang.String formatAttributeFormValue(java.lang.String attId,
                                                        java.lang.String formId,
                                                        int formDataType,
                                                        java.lang.String attName,
                                                        java.lang.String formName)

Deprecated.

Use ExpressionHelper.formatAttributeFormValue(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String).

With the given parameters, returns the string used by some event-handlers to identify an attribute form. This string can then be used as the value of an <INPUT> tag to submit it in a form.

Parameters:

attId - Attribute id

formId - Form-id

formDataType - Form's data-type

attName - Attribute name

formName - Form name

Returns:

A string value used to identify an attribute-form.

formatAttributeValue

@Deprecated
public static java.lang.String formatAttributeValue(java.lang.String attId,
                                                    java.lang.String attName)

Deprecated.

Use ExpressionHelper.formatObjectInfoValue(java.lang.String, int, java.lang.String).

With the given parameters, returns the string used by some event-handlers to identify an attribute. This string can then be used as the value of an <INPUT> tag to submit it in a form.

Parameters:

attId - Attribute id

attName - Attribute name

Returns:

A string value used to identify an attribute-form.

formatAttributeFormDisplay

@Deprecated
public static java.lang.String formatAttributeFormDisplay(java.lang.String attName,
                                                          java.lang.String formName)

Deprecated.

Use ExpressionHelper.formatAttributeFormDisplay(java.lang.String, java.lang.String).

Returns the string used to display an attribute form to the end user. This method shows the attribute's name followed by the attribute form enclosed in parenthesis.

Parameters:

attName - Attribute's name

formName - Attribute form's name.

Returns:

A string to display the attribute form to the end user.

formatAttributeFormValueForSingleAttr

@Deprecated
public static java.lang.String formatAttributeFormValueForSingleAttr(java.lang.String formId,
                                                                     int formDataType,
                                                                     java.lang.String formName)

Deprecated.

Use ExpressionHelper.formatAttributeFormValueForSingleAttr(java.lang.String, int, java.lang.String).

Returns the string used by some event-handlers to identify an attribute form when there can only be a single attribute in the request. This string can then be used as the value of an <INPUT> tag to submit it in a form.

Parameters:

formId - Form-id

formDataType - Form's data-type

formName - Form name

Returns:

String

getRequestKeysString

public static java.lang.String getRequestKeysString(BeanContext context)

Returns the string representation of the request keys as an & delimited list of name=value pairs.

Parameters:

context - BeanContext to retrieve the request keys.

Returns:

String representation of the corresponding request keys.

generateHiddenInputsForEvent

@Deprecated
public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                int indent,
                                                WebEvent event)

Deprecated.

Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent) instead.

Generates the set of hidden inputs associated with a given event

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

event - The corresponding WebEvent.

generateHiddenInputsForEvent

public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                ParameterBuilder paramBldr,
                                                int indent,
                                                WebEvent event)

Generates the set of hidden inputs associated with a given event using the minal state info.

Since:

MicroStrategy Web 8.0.0

See Also:

generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml, int state)

generateHiddenInputsForEvent

@Deprecated
public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                int indent,
                                                WebEvent event,
                                                boolean isDhtml)

Deprecated.

Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean) instead.

Generates the set of hidden inputs associated with a given event

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

event - The corresponding WebEvent.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

generateHiddenInputsForEvent

public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                ParameterBuilder paramBldr,
                                                int indent,
                                                WebEvent event,
                                                boolean isDhtml)

Generates the set of hidden inputs associated with a given event using the minal state info.

Since:

MicroStrategy Web 8.0.0

See Also:

generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml, int state)

generateHiddenInputsForEvent

@Deprecated
public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                int indent,
                                                WebEvent event,
                                                boolean isDhtml,
                                                int state)

Deprecated.

Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean, int) instead.

Generates the set of hidden inputs associated with a given event.

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

event - The corresponding WebEvent.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

state - If page-state is to be added, this parameter (whose values come from EnumWebPersistableState) determines how much state.

generateHiddenInputsForEvent

public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                ParameterBuilder paramBldr,
                                                int indent,
                                                WebEvent event,
                                                boolean isDhtml,
                                                int state)

Generates the set of hidden inputs associated with a given event. This method will use either the ParameterBuilder (if provided) or the event itself (otherwise).

Parameters:

mo - MarkupOutput object to use

paramBldr - ParameterBuilder responsible to create the hidden inputs.

indent - default indentation to use.

event - The corresponding WebEvent.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

state - If page-state is to be added, this parameter (whose values come from EnumWebPersistableState) determines how much state.

Since:

MicroStrategy Web 8.0.0

generateHiddenInputsForEvent

public static void generateHiddenInputsForEvent(MarkupOutput mo,
                                                ParameterBuilder paramBldr,
                                                int indent,
                                                WebEvent event,
                                                boolean isDhtml,
                                                int state,
                                                boolean renderState)

generateHiddenInputsForEventList

@Deprecated
public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    int indent,
                                                    java.util.ArrayList eventList,
                                                    boolean isDhtml,
                                                    int state)

Deprecated.

use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, int state, NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

eventList - List of events.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

state - If page-state is to be added, this parameter (whose values come from EnumWebPersistableState) determines how much state.

generateHiddenInputsForEventList

@Deprecated
public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    int indent,
                                                    java.util.ArrayList eventList,
                                                    boolean isDhtml)

Deprecated.

use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

eventList - List of events.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

generateHiddenInputsForEventList

@Deprecated
public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    int indent,
                                                    java.util.ArrayList eventList)

Deprecated.

use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

indent - default indentation to use.

eventList - List of events.

generateHiddenInputsForEventList

public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    ContainerServices cntrSvcs,
                                                    int indent,
                                                    java.util.ArrayList eventList,
                                                    boolean isDhtml,
                                                    int state,
                                                    NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

cntrSvcs - ContainerServices to create new ParameterBuilder instances

indent - default indentation to use.

eventList - List of events.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

state - If page-state is to be added, this parameter (whose values come from EnumWebPersistableState) determines how much state.

nse - Used to encode the input's names (see newInputHidden(java.lang.String, java.lang.String, com.microstrategy.web.platform.NamespaceEncoder))

Since:

MicroStrategy Web 8.0.0

generateEventOrderForList

public static void generateEventOrderForList(MarkupOutput mo,
                                             java.util.ArrayList eventList,
                                             NamespaceEncoder nse)

Since:

MicroStrategy Web 9.0.0

generateHiddenInputsForEventList

public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    ContainerServices cntrSvcs,
                                                    int indent,
                                                    java.util.ArrayList eventList,
                                                    boolean isDhtml,
                                                    NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

cntrSvcs - ContainerServices to create new ParameterBuilder instances

indent - default indentation to use.

eventList - List of events.

isDhtml - if true, the page state hidden inputs are added dynamically using JavaScript.

nse - Used to encode the input's names (see newInputHidden(java.lang.String, java.lang.String, com.microstrategy.web.platform.NamespaceEncoder))

Since:

MicroStrategy Web 8.0.0

generateHiddenInputsForEventList

public static void generateHiddenInputsForEventList(MarkupOutput mo,
                                                    ContainerServices cntrSvcs,
                                                    int indent,
                                                    java.util.ArrayList eventList,
                                                    NamespaceEncoder nse)

Generates those hidden inputs associated with the given event list. Using this method callers can ensure the page's state hidden inputs are only included once.

Parameters:

mo - MarkupOutput object to use

cntrSvcs - ContainerServices to create new ParameterBuilder instances

indent - default indentation to use.

eventList - List of events.

nse - Used to encode the input's names (see newInputHidden(java.lang.String, java.lang.String, com.microstrategy.web.platform.NamespaceEncoder))

Since:

MicroStrategy Web 8.0.0

getWebVersionHashCode

public static java.lang.String getWebVersionHashCode(AppContext appContext)

Get hash code of web version Used to append as version parameter when loading resource

Parameters:

appContext - Current AppContext

Returns:

hash code of web version

getAppVersion

public static java.lang.String getAppVersion()

getResourcePathWithVersion

public static java.lang.String getResourcePathWithVersion(java.lang.String originResourcePath,
                                                          AppContext appContext)

Append web version parameter to resource path if it's not disabled in debug flag E.g. ../javascript/example.js?v=12345 Version parameter is used to disable browser resource cache when code version updates.

Parameters:

originResourcePath - Original resource path without parameter

page - Current PageComponent object

Returns:

Resource path with version if needed

isPluginResource

public static boolean isPluginResource(java.lang.String resourcePath)

appendScriptTag

public static void appendScriptTag(MarkupOutput mo,
                                   AppContext appContext,
                                   java.lang.String filePath)

Append script tag to MarkupOutput to load script file

Parameters:

mo - MarkupOutput object to use

appContext - Current AppContext

filePath - The name of the JavaScript file

appendStyleLinkTag

public static void appendStyleLinkTag(MarkupOutput mo,
                                      AppContext appContext,
                                      java.lang.String cssFile)

Append css style link tag to MarkupOutput to load css file

Parameters:

mo - MarkupOutput object to use

appContext - Current AppContext

cssFile - The name of the css file

generateDynamicScript

public static void generateDynamicScript(MarkupOutput mo,
                                         AppContext appContext,
                                         java.lang.String fileName,
                                         java.lang.String key)

Adds a script tag with a link to dynamically load a JavaScript file. This is used by the Transforms to ensure a script file is included in the HTML output.

Parameters:

mo - MarkupOutput object to use

appContext - Used to determine if certain features are available

fileName - The name of the JavaScript file

key - A unique key that identifies this file in the page.

isDefaultPreferenceValue

public static boolean isDefaultPreferenceValue(java.lang.String preferenceName,
                                               java.lang.String preferenceValue)

This method checks if the given preference exists with in the Admin Preferences, and if its value is the given one.

This method will return true by default. It only returns false if the preference exists but its value doesn't correspond to the given one.

Parameters:

preferenceName - Name of preference

preferenceValue - Value of preference.

Returns:

false if the given value doesn't correspond to the value saved in the preference. true otherwise.

Since:

MicroStrategy Web 7.5.1

newURIBuilder

protected static ParameterBuilder newURIBuilder(AppContext appContext)

Creates a new ParameterBuilder from the AppContext. If the AppContext is null, or the AppContext has no ContainerServices, this method returns null.

Parameters:

appContext - Where the ParameterBuilder should be retrieved.

Returns:

A new instance of a ParameterBuilder if available.

Since:

MicroStrategy Web 8.0.0

newImageTag

public static ImageTag newImageTag(java.lang.String src,
                                   java.lang.String width,
                                   java.lang.String height,
                                   java.lang.String alt)

Convenience method that creates a IMG tag from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

Parameters:

src - Sets the img's "src"

width - Sets the img's "width"

height - Sets the img's "height"

alt - Sets the img's "Alt"

Returns:

An ImageTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

newInputText

public static InputTag newInputText(java.lang.String name,
                                    java.lang.String value,
                                    java.lang.String size,
                                    java.lang.String maxLength,
                                    NamespaceEncoder nse)

Convenience method that creates a text field from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provide, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

value - Used for the Input's value.

size - Used for the EnumHTMLTags.ATT_SIZE attribute.

maxLength - Used for the EnumHTMLTags.ATT_MAXLENGTH attribute.

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

newInputNumber

public static InputTag newInputNumber(java.lang.String name,
                                      java.lang.String value,
                                      java.lang.String minValue,
                                      java.lang.String maxValue,
                                      NamespaceEncoder nse)

newInputSubmit

public static InputTag newInputSubmit(java.lang.String name,
                                      java.lang.String value,
                                      NamespaceEncoder nse)

Convenience method that creates a submit button from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provided, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

value - Used for the Input's value.

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

newInputRadio

public static InputTag newInputRadio(java.lang.String id,
                                     java.lang.String name,
                                     java.lang.String value,
                                     boolean checked,
                                     NamespaceEncoder nse)

Convenience method that creates a radio button from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provided, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

id - used for the EnumHTMLTags.ATT_ID attribute

name - Used for the EnumHTMLTags.ATT_NAME attribute

value - Used for the Input's value.

checked - If true sets the EnumHTMLTags.ATT_CHECKED attribute to "1".

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 9.0.0

newInputRadio

public static InputTag newInputRadio(java.lang.String name,
                                     java.lang.String value,
                                     boolean checked,
                                     NamespaceEncoder nse)

Convenience method that creates a radio button from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provided, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

value - Used for the Input's value.

checked - If true sets the EnumHTMLTags.ATT_CHECKED attribute to "1".

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

generateJavaScriptMethodCall

public static java.lang.String generateJavaScriptMethodCall(java.lang.String methodName,
                                                            java.lang.String[] args,
                                                            boolean includeReturn,
                                                            int indexForThis)

Utility method to generate Javascript method call in HTML.

Parameters:

methodName - javascript method name

args - arguments for the method call

includeReturn - True indicates that "return" would be generated in the method call.

indexForThis - specifies index for "this" in the method call. value of -1 implies that "this" does'nt need to be included.

Returns:

String with the Javascript call code generated

Since:

MicroStrategy Web 8.1.0

newInputCheck

public static InputTag newInputCheck(java.lang.String name,
                                     java.lang.String value,
                                     boolean checked,
                                     NamespaceEncoder nse)

Convenience method that creates a checkbox from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provide, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

value - Used for the Input's value.

checked - If true sets the EnumHTMLTags.ATT_CHECKED attribute to "1".

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

newInputHidden

public static InputTag newInputHidden(java.lang.String name,
                                      java.lang.String value,
                                      NamespaceEncoder nse)

Convenience method that creates a hidden input from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provide, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

value - Used for the Input's value.

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

newInputImage

public static InputTag newInputImage(java.lang.String name,
                                     java.lang.String src,
                                     java.lang.String width,
                                     java.lang.String height,
                                     java.lang.String title,
                                     NamespaceEncoder nse)

Convenience method that creates an image input from the TagsFactory. It receives as parameters those attributes most commonly used for this type of input. All parameters are optional, if they are not specified, they are not set as part of the tag's attributes.

If a NamespaceEncoder is provided, it will be used to encode the tag's name. This is only required when the application is run in the context of a Portal.

Parameters:

name - Used for the EnumHTMLTags.ATT_ID and EnumHTMLTags.ATT_NAME attributes

src - Used for the EnumHTMLTags.ATT_SRC attribute.

width - Used for the EnumHTMLTags.ATT_WIDTH attribute.

height - Used for the EnumHTMLTags.ATT_HEIGHT attribute.

title - Used for the EnumHTMLTags.ATT_TITLE attribute.

nse - If provided, is used to encode the EnumHTMLTags.ATT_NAME attribute.

Returns:

An InputTag populated with the given values.

Since:

MicroStrategy Web 8.0.0

getOfficeLink

@Deprecated
public static java.lang.String getOfficeLink()

Deprecated.

This method has been deprecated. Use the method HTMLHelper.getOfficeLink(AppContext appContext) instead.

Retrieves the Office Link URL from the default or Admin Preferences.

Since:

MicroStrategy Web 8.0.0

getOfficeLink

public static java.lang.String getOfficeLink(AppContext appContext)

Retrieves the Office Link URL from the default or Admin Preferences.

Since:

MicroStrategy Web 8.0.1

getQuickSymbolImageSource

@Deprecated
public static java.lang.String getQuickSymbolImageSource(int type)

Deprecated.

replaced by EnumQuickSymbol.get(int) and EnumQuickSymbol.getImageSource()

Returns the image source to be used for quick symbol threshold replacement in 508 mode.

Parameters:

type - int EnumDSSXMLSymbol

Returns:

String image source

Since:

MicroStrategy Web 9.0.0

renderQuickSymbolforText

@Deprecated
public static void renderQuickSymbolforText(MarkupOutput out,
                                            java.lang.String text,
                                            boolean isIE)

Deprecated.

should not use this - see EnumQuickSymbol

Generates the HTML the text as a "quick symbol"

Parameters:

out - the output object

text -

Since:

MicroStrategy Web 9.0.0

getQuickSymbolString

@Deprecated
public static java.lang.String getQuickSymbolString(int type)

Deprecated.

replaced by EnumQuickSymbol.get(int) and EnumQuickSymbol.getWingdingsString()

Returns the wingdings string that visually represents the supplied quick symbol type.

Parameters:

type - int EnumDSSXMLSymbol

Returns:

String single character to be rendered using WingDings

Since:

MicroStrategy Web 9.0.0

getQuickSymbolUnicode

@Deprecated
public static java.lang.String getQuickSymbolUnicode(int type)

Deprecated.

see EnumQuickSymbol

Returns the unicode id that visually represents the supplied quick symbol type.

Parameters:

type - int EnumDSSXMLSymbol

Returns:

String single character to be rendered using WingDings

Since:

MicroStrategy Web 9.0.0

getQuickSymbolUnicodeByChar

@Deprecated
public static java.lang.String getQuickSymbolUnicodeByChar(char character)

Deprecated.

should not be used - see EnumQuickSymbol

Returns the unicode id that visually represents the supplied quick symbol type by orginal char.

Parameters:

character - char

Returns:

String unicode which will be used for Firefox

Since:

MicroStrategy Web 9.0.0

computeTextboxSize

public static java.lang.String computeTextboxSize(java.lang.String value,
                                                  int max)

Since:

MicroStrategy Web 9.0.0

convertImageUri

public static java.lang.String convertImageUri(java.lang.String value)

Adjusts image URI.

For firefox, backslashes "\" in URI is encoded as a character "%5C" which causes images cannot be displayed. Backslashes in path component of URI would be replaced by forward slash.

Parameters:

value - original URI

Returns:

the adjusted URI.

Since:

MicroStrategy Web Polaris