public class

HTMLHelper

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.utils.HTMLHelper

Class Overview

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:

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

Summary

Constants
String CSS_ERROR_MESSAGE
String CSS_ERROR_TITLE
String DEFAULT_FORM_METHOD
String DEFAULT_FORM_NAME
String INPUT_TYPE_BUTTON
String INPUT_TYPE_CHECKBOX
String INPUT_TYPE_HIDDEN
String INPUT_TYPE_RADIO
String INPUT_TYPE_SUBMIT
String INPUT_TYPE_TEXT
Public Constructors
HTMLHelper()
Creates new HTMLHelper
Public Methods
static void appendScriptTag(MarkupOutput mo, AppContext appContext, String filePath)
Append script tag to MarkupOutput to load script file
static void appendStyleLinkTag(MarkupOutput mo, AppContext appContext, String cssFile)
Append css style link tag to MarkupOutput to load css file
static String computeTextboxSize(String value, int max)
static String convertColorBGRtoRGB(String colorHexCode)
Converts the hexadecimal representation of a color into its RRGGBB format or BBGGRR.
static String convertColorDecimalToHex(String colorCode)
Converts the integer representation of a color into its hexadecimal representation.
static String convertColorDecimalToRGB(String colorCode)
Converts the decimal representation of a color into its RRGGBB format.
static String convertColorDecimalToRGB(int color)
Converts the decimal representation of a color into its RRGGBB format.
static String convertColorHSBToHex(int hue, int saturation, int brightness)
Converts the hsb components of a color into its hexadecimal representation.
static String convertColorHexToDecimal(String colorCode)
Converts the hexadecimal color code (e.g.
static int[] convertColorRGBToHSB(int r, int g, int b)
Converts the red, green and blue components of a color into hsb components.
static String convertFormattedValue(String value, Locale locale)
Converts any value with decimal into locale dependent format.
static String convertImageUri(String value)
Adjusts image URI.
static String convertInchesToPixel(String inches, int dpiConversion, Locale locale, int zoomFactor)
Converts inches into pixels.
static double convertPixelsToInches(double pixels, int dpiConversion, int zoomFactor)
Converts pixels to inches
static String convertPixelsToInches(String pixels, int dpiConversion, 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 String decode(String oldStr)
Given an HTML encoded string, returns its decoded version (using plain characters instead of browser's specifc encoding).
static void displayError(MarkupOutput out, String className, String methodName, Exception e, String title, String message, String errorInfo, String contactInfo)
This method is deprecated. This is method has been deprecated as css-classes are not optional anymore.
static void displayError(MarkupOutput out, String className, String methodName, Exception e, String title, String message, String errorInfo, String contactInfo, Tag extra)
Writes an error message.
static void displayError(MarkupOutput transOut, String className, String methodName, Exception e, String title, String message)
Writes an error message.
static String encode(String oldStr)
Encodes a string using HTML encoding.
static String encode(String oldStr, boolean encodeSpaces)
static String encodeExcludeSubStr(String excludeStr, String wholeStr)
encode object details, the description part will not encode if allowing html on object description
static String euroEncode(String oldStr)
This method is deprecated. The application doesn't require to encode the Euro symbol.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext, boolean addDefault, String defaultContent, String defaultValue, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String selectedValue, String xmlFile, AppContext appContext, String comboKey, String localeID)
Fills a COMBO box with the contents of an XML file.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static boolean fillComboFromXML(MarkupOutput mo, WebComponent baseBean, int indent, String selectedValue, String xmlFile, AppContext appContext, String comboKey, String localeID)
Fills a COMBO box with the contents of an XML file.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String selectedValue, String xmlFile, AppContext appContext)
Fills a COMBO box with the contents of an XML file.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext, boolean addDefault, String defaultContent, String defaultValue, String extraParameters, WebComponent baseBean)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static boolean fillComboFromXML(MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static boolean fillComboPaperList(MarkupOutput mo, int indent, String name, String size, String selectedValue, PaperSizesList paperList, AppContext appContext)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static SelectTag fillComboPaperList(String name, String selectedValue, PaperSizesList paperList, AppContext appContext)
This method is deprecated. Use fillComboPaperList(String, String, ShortcutList, AppContext)
static SelectTag fillComboPaperList(String name, 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 String fixPointsForZoom(String points, int zoomFactor)
Fixes the point values used for font size and weight based on DPI conversion factor and zoom factors.
static String formatAttributeFormDisplay(String attName, String formName)
This method is deprecated. Use formatAttributeFormDisplay(String, String).
static String formatAttributeFormValue(String attId, String formId, int formDataType, String attName, String formName)
This method is deprecated. Use formatAttributeFormValue(String, String, int, String, String).
static String formatAttributeFormValueForSingleAttr(String formId, int formDataType, String formName)
This method is deprecated. Use formatAttributeFormValueForSingleAttr(String, int, String).
static String formatAttributeValue(String attId, String attName)
This method is deprecated. Use formatObjectInfoValue(String, int, String).
static String formatObjectInfoValue(String id, int type, String name)
This method is deprecated. Use formatObjectInfoValue(String, int, String).
static void generateBUTTON(MarkupOutput mo, int indent, String name, String value, String style)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateBUTTON(MarkupOutput mo, int indent, String name, String value, String style, String type, boolean isDisabled)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateCheckBox(MarkupOutput mo, int indent, String name, String currentValue, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateCheckBox(MarkupOutput mo, int indent, String name, String currentValue)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateCloseAnchor(StringBuffer sb)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateCloseAnchor(MarkupOutput mo)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateComboBox(MarkupOutput mo, int indent, String name, HashList options, String currentValue, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateComboBox(MarkupOutput mo, int indent, String name, String[][] options, String currentValue)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateComboBox(MarkupOutput mo, int indent, String name, String[][] options, String currentValue, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateComboBox(MarkupOutput mo, int indent, String name, HashList options, String currentValue)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static Tag[] generateComboOptions(WebComponent bean, AppContext appContext, ShortcutList list, 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, 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, String fileName, String key)
Adds a script tag with a link to dynamically load a JavaScript file.
static void generateEventOrderForList(MarkupOutput mo, ArrayList eventList, NamespaceEncoder nse)
static void generateFONT(MarkupOutput mo, int indent, String fontFace, int fontSize)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateHiddenInputsForEvent(MarkupOutput mo, int indent, WebEvent event, boolean isDhtml)
This method is deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean) 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, int indent, WebEvent event)
This method is deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent) instead.
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)
Generates the set of hidden inputs associated with a given event using the minal state info.
static void generateHiddenInputsForEvent(MarkupOutput mo, int indent, WebEvent event, boolean isDhtml, int state)
This method is deprecated. Use generateHiddenInputsForEvent(MarkupOutput, ParameterBuilder, int, WebEvent, boolean, int) instead.
static void generateHiddenInputsForEvent(MarkupOutput mo, ParameterBuilder paramBldr, int indent, WebEvent event, boolean isDhtml, int state, boolean renderState)
static void generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, NamespaceEncoder nse)
Generates those hidden inputs associated with the given event list.
static void generateHiddenInputsForEventList(MarkupOutput mo, int indent, ArrayList eventList, boolean isDhtml, int state)
This method is deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, int state, NamespaceEncoder nse)
static void generateHiddenInputsForEventList(MarkupOutput mo, int indent, ArrayList eventList, boolean isDhtml)
This method is deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, NamespaceEncoder nse)
static void 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.
static void generateHiddenInputsForEventList(MarkupOutput mo, int indent, ArrayList eventList)
This method is deprecated. use generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, NamespaceEncoder nse)
static void generateHiddenInputsForEventList(MarkupOutput mo, ContainerServices cntrSvcs, int indent, ArrayList eventList, boolean isDhtml, NamespaceEncoder nse)
Generates those hidden inputs associated with the given event list.
static void generateIMG(MarkupOutput mo, int indent, String src, int width, int height, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, String width, String height, String alt, int border, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String id, String imgFolder, String src, int width, int height, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, int width, int height, String alt, int border)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, int width, int height)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String imgFolder, String src, int width, int height, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String imgFolder, String src, int width, int height, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, String alt)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(StringBuffer mo, int indent, String src, int width, int height, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMG(MarkupOutput mo, int indent, String src, int width, int height, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMGForSubmit(MarkupOutput mo, int indent, String name, String src, int width, int height, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMGForSubmit(MarkupOutput mo, int indent, String name, String imgFolder, String src, int width, int height, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMGForSubmit(MarkupOutput mo, int indent, String name, String src, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMGForSubmit(StringBuffer mo, int indent, String name, String src, int width, int height, String alt, int border, String align)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIMGForSubmit(StringBuffer mo, int indent, String name, String src, String alt, int border, String align, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateINPUT(StringBuffer mo, int indent, String type, String name, String value, boolean checked, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateINPUT(MarkupOutput mo, int indent, String type, String name, String value, boolean checked, String duplicateHiddenInputValue, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateINPUT(MarkupOutput mo, int indent, String type, String name, String value, boolean checked, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateINPUT(MarkupOutput mo, int indent, String type, String name, String value, boolean checked)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateIndent(MarkupOutput mo, int indent)
This method is deprecated. Transforms don't indent their output anymore.
static void generateIndent(StringBuffer mo, int indent)
This method is deprecated. Transforms don't indent their output anymore.
static String generateJavaScriptMethodCall(String methodName, String[] args, boolean includeReturn, int indexForThis)
Utility method to generate Javascript method call in HTML.
static Tag generateOPTION(String value, String content, boolean selected)
Returns an option Tag with the information provided
static void generateOPTION(MarkupOutput mo, int indent, String value, String content, boolean selected, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateOPTION(MarkupOutput mo, int indent, String value, String content, boolean selected, String extraParameters, boolean encodeData)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateSPAN(MarkupOutput mo, int indent, String cssName, String content)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateSPAN(MarkupOutput mo, int indent, String cssName, String content, boolean encodeContent)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static String generateSkipNavigationLinkHeader(AppContext appContext, String anchorName)
This method is deprecated. Transforms don't generate this link anymore. It's generated directly in the JSP.
static String generateSkipNavigationLinkTarget(AppContext appContext, String anchorName)
This method is deprecated. Transforms don't generate this link anymore. It's generated directly in the JSP.
static void generateTABLE(MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String background, String cssName, String id, String summary, String extraStyle)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTABLE(MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName, String id, String summary)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTABLE(MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName, String id, String summary, String extraStyle)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTABLE(MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName, String id)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTABLE(MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTEXTAREA(MarkupOutput mo, int indent, String name, String value, int columns, int rows, String style)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTEXTBOX(MarkupOutput mo, int indent, String name, String value, String size, String maxLength, String style)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static void generateTEXTBOX(MarkupOutput mo, int indent, String name, String value, String size, String maxLength, String style, String extraParameters)
This method is deprecated. Tags should be generated using the Tags infrastructure. See TagsFactory.
static String getFormattedValue(String value, Locale locale)
Converts any value with decimal to the corrected format.
static String getOfficeLink()
This method is deprecated. This method has been deprecated. Use the method HTMLHelper.getOfficeLink(AppContext appContext) instead.
static String getOfficeLink(AppContext appContext)
Retrieves the Office Link URL from the default or Admin Preferences.
static String getQuickSymbolImageSource(int type)
This method is deprecated. replaced by get(int) and getImageSource()
static String getQuickSymbolString(int type)
This method is deprecated. replaced by get(int) and getWingdingsString()
static String getQuickSymbolUnicode(int type)
This method is deprecated. see EnumQuickSymbol
static String getQuickSymbolUnicodeByChar(char character)
This method is deprecated. should not be used - see EnumQuickSymbol
static String getRequestKeysString(BeanContext context)
Returns the string representation of the request keys as an & delimited list of name=value pairs.
static String getResourcePathWithVersion(String originResourcePath, AppContext appContext)
Append web version parameter to resource path if it's not disabled in debug flag E.g.
static String getWebVersionHashCode(AppContext appContext)
Get hash code of web version Used to append as version parameter when loading resource
static boolean isDefaultPreferenceValue(String preferenceName, String preferenceValue)

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

static ImageTag newImageTag(String src, String width, String height, String alt)

Convenience method that creates a IMG tag from the TagsFactory.

static InputTag newInputCheck(String name, String value, boolean checked, NamespaceEncoder nse)

Convenience method that creates a checkbox from the TagsFactory.

static InputTag newInputHidden(String name, String value, NamespaceEncoder nse)

Convenience method that creates a hidden input from the TagsFactory.

static InputTag newInputImage(String name, String src, String width, String height, String title, NamespaceEncoder nse)

Convenience method that creates an image input from the TagsFactory.

static InputTag newInputRadio(String id, String name, String value, boolean checked, NamespaceEncoder nse)

Convenience method that creates a radio button from the TagsFactory.

static InputTag newInputRadio(String name, String value, boolean checked, NamespaceEncoder nse)

Convenience method that creates a radio button from the TagsFactory.

static InputTag newInputSubmit(String name, String value, NamespaceEncoder nse)

Convenience method that creates a submit button from the TagsFactory.

static InputTag newInputText(String name, String value, String size, String maxLength, NamespaceEncoder nse)

Convenience method that creates a text field from the TagsFactory.

static void renderQuickSymbolforText(MarkupOutput out, String text, boolean isIE)
This method is deprecated. should not use this - see EnumQuickSymbol
Protected Methods
static ParameterBuilder newURIBuilder(AppContext appContext)
Creates a new ParameterBuilder from the AppContext.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CSS_ERROR_MESSAGE

Constant Value: "error-message"

public static final String CSS_ERROR_TITLE

Constant Value: "error-title"

public static final String DEFAULT_FORM_METHOD

Constant Value: "GET"

public static final String DEFAULT_FORM_NAME

Constant Value: "mstrForm"

public static final String INPUT_TYPE_BUTTON

Constant Value: "BUTTON"

public static final String INPUT_TYPE_CHECKBOX

Constant Value: "CHECKBOX"

public static final String INPUT_TYPE_HIDDEN

Constant Value: "HIDDEN"

public static final String INPUT_TYPE_RADIO

Constant Value: "RADIO"

public static final String INPUT_TYPE_SUBMIT

Constant Value: "SUBMIT"

public static final String INPUT_TYPE_TEXT

Constant Value: "TEXT"

Public Constructors

public HTMLHelper ()

Creates new HTMLHelper

Public Methods

public static void appendScriptTag (MarkupOutput mo, AppContext appContext, 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

public static void appendStyleLinkTag (MarkupOutput mo, AppContext appContext, 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

public static String computeTextboxSize (String value, int max)

public static String convertColorBGRtoRGB (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

public static String convertColorDecimalToHex (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.

public static String convertColorDecimalToRGB (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.

public static 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.

public static 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.

public static String convertColorHexToDecimal (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.

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.

public static String convertFormattedValue (String value, 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

public static String convertImageUri (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.

public static String convertInchesToPixel (String inches, int dpiConversion, 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.

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.

public static String convertPixelsToInches (String pixels, int dpiConversion, 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.

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

public static double convertPtsToInches (double pts)

Converts points into inches.

Parameters
pts String with the pts values
Returns
  • the conversion of pts to pixels.

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

public static String decode (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.

public static void displayError (MarkupOutput out, String className, String methodName, Exception e, String title, String message, String errorInfo, String contactInfo)

This method is 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

public static void displayError (MarkupOutput out, String className, String methodName, Exception e, String title, String message, String errorInfo, 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

public static void displayError (MarkupOutput transOut, String className, String methodName, Exception e, String title, 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

public static String encode (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.

public static String encode (String oldStr, boolean encodeSpaces)

public static String encodeExcludeSubStr (String excludeStr, 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

public static String euroEncode (String oldStr)

This method is 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

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

This method is 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.

public static boolean fillComboFromXML (MarkupOutput mo, int indent, String selectedValue, String xmlFile, AppContext appContext, String comboKey, 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.

public static boolean fillComboFromXML (MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext, String extraParameters)

This method is 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.

public static boolean fillComboFromXML (MarkupOutput mo, WebComponent baseBean, int indent, String selectedValue, String xmlFile, AppContext appContext, String comboKey, 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.

public static boolean fillComboFromXML (MarkupOutput mo, int indent, String selectedValue, 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.

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

This method is 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.

public static boolean fillComboFromXML (MarkupOutput mo, int indent, String name, String size, String selectedValue, String xmlFile, AppContext appContext)

This method is 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.

public static boolean fillComboPaperList (MarkupOutput mo, int indent, String name, String size, String selectedValue, PaperSizesList paperList, AppContext appContext)

This method is 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.

public static SelectTag fillComboPaperList (String name, String selectedValue, PaperSizesList paperList, AppContext appContext)

This method is 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

public static SelectTag fillComboPaperList (String name, 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

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.

public static String fixPointsForZoom (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.

public static String formatAttributeFormDisplay (String attName, String formName)

This method is deprecated.
Use formatAttributeFormDisplay(String, 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.

public static String formatAttributeFormValue (String attId, String formId, int formDataType, String attName, String formName)

This method is deprecated.
Use formatAttributeFormValue(String, String, int, String, 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.

public static String formatAttributeFormValueForSingleAttr (String formId, int formDataType, String formName)

This method is deprecated.
Use formatAttributeFormValueForSingleAttr(String, int, 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

public static String formatAttributeValue (String attId, String attName)

This method is deprecated.
Use formatObjectInfoValue(String, int, 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.

public static String formatObjectInfoValue (String id, int type, String name)

This method is deprecated.
Use formatObjectInfoValue(String, int, 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.

public static void generateBUTTON (MarkupOutput mo, int indent, String name, String value, String style)

This method is 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

public static void generateBUTTON (MarkupOutput mo, int indent, String name, String value, String style, String type, boolean isDisabled)

This method is 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

public static void generateCheckBox (MarkupOutput mo, int indent, String name, String currentValue, String extraParameters)

This method is 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

public static void generateCheckBox (MarkupOutput mo, int indent, String name, String currentValue)

This method is 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

public static void generateCloseAnchor (StringBuffer sb)

This method is deprecated.
Tags should be generated using the Tags infrastructure. See TagsFactory.

Closes an anchor tag.

Parameters
sb StringBuffer object to use.

public static void generateCloseAnchor (MarkupOutput mo)

This method is deprecated.
Tags should be generated using the Tags infrastructure. See TagsFactory.

Closes an anchor tag.

Parameters
mo MarkupOutput object to use.

public static void generateComboBox (MarkupOutput mo, int indent, String name, HashList options, String currentValue, String extraParameters)

This method is 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.

public static void generateComboBox (MarkupOutput mo, int indent, String name, String[][] options, String currentValue)

This method is 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

public static void generateComboBox (MarkupOutput mo, int indent, String name, String[][] options, String currentValue, String extraParameters)

This method is 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.

public static void generateComboBox (MarkupOutput mo, int indent, String name, HashList options, String currentValue)

This method is 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

public static Tag[] generateComboOptions (WebComponent bean, AppContext appContext, ShortcutList list, 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

public static Tag[] generateComboOptions (WebComponent bean, AppContext appContext, ShortcutList list, 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

public static void generateDynamicScript (MarkupOutput mo, AppContext appContext, String fileName, 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.

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

public static void generateFONT (MarkupOutput mo, int indent, String fontFace, int fontSize)

This method is 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

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

This method is 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.

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.

See Also

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

This method is 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.

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.

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.

See Also

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

This method is 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.

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

public static void 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
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(String, String, NamespaceEncoder))

public static void generateHiddenInputsForEventList (MarkupOutput mo, int indent, ArrayList eventList, boolean isDhtml, int state)

This method is 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.

public static void generateHiddenInputsForEventList (MarkupOutput mo, int indent, ArrayList eventList, boolean isDhtml)

This method is 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.

public static void 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
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(String, String, NamespaceEncoder))

public static void generateHiddenInputsForEventList (MarkupOutput mo, int indent, ArrayList eventList)

This method is 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.

public static void 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
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(String, String, NamespaceEncoder))

public static void generateIMG (MarkupOutput mo, int indent, String src, int width, int height, String alt, int border, String align)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, String width, String height, String alt, int border, String extraParameters)

This method is 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

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

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, int width, int height, String alt, int border)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, int width, int height)

This method is 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

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

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, String alt, int border, String align)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String imgFolder, String src, int width, int height, String alt, int border, String align)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, String alt)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, String alt, int border, String align, String extraParameters)

This method is 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

public static void generateIMG (StringBuffer mo, int indent, String src, int width, int height, String alt, int border, String align, String extraParameters)

This method is 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

public static void generateIMG (MarkupOutput mo, int indent, String src, int width, int height, String alt, int border, String align, String extraParameters)

This method is 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

public static void generateIMGForSubmit (MarkupOutput mo, int indent, String name, String src, int width, int height, String alt, int border, String align)

This method is 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

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

This method is 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

public static void generateIMGForSubmit (MarkupOutput mo, int indent, String name, String src, String alt, int border, String align, String extraParameters)

This method is 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

public static void generateIMGForSubmit (StringBuffer mo, int indent, String name, String src, int width, int height, String alt, int border, String align)

This method is 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

public static void generateIMGForSubmit (StringBuffer mo, int indent, String name, String src, String alt, int border, String align, String extraParameters)

This method is 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

public static void generateINPUT (StringBuffer mo, int indent, String type, String name, String value, boolean checked, String extraParameters)

This method is 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

public static void generateINPUT (MarkupOutput mo, int indent, String type, String name, String value, boolean checked, String duplicateHiddenInputValue, String extraParameters)

This method is 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.
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.
extraParameters any other attributes or events to add to the tag

public static void generateINPUT (MarkupOutput mo, int indent, String type, String name, String value, boolean checked, String extraParameters)

This method is 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

public static void generateINPUT (MarkupOutput mo, int indent, String type, String name, String value, boolean checked)

This method is 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.

public static void generateIndent (MarkupOutput mo, int indent)

This method is 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

public static void generateIndent (StringBuffer mo, int indent)

This method is 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

public static String generateJavaScriptMethodCall (String methodName, 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

public static Tag generateOPTION (String value, 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

public static void generateOPTION (MarkupOutput mo, int indent, String value, String content, boolean selected, String extraParameters)

This method is 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.

public static void generateOPTION (MarkupOutput mo, int indent, String value, String content, boolean selected, String extraParameters, boolean encodeData)

This method is 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.

public static void generateSPAN (MarkupOutput mo, int indent, String cssName, String content)

This method is 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

public static void generateSPAN (MarkupOutput mo, int indent, String cssName, String content, boolean encodeContent)

This method is 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

public static String generateSkipNavigationLinkHeader (AppContext appContext, String anchorName)

This method is 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.

public static String generateSkipNavigationLinkTarget (AppContext appContext, String anchorName)

This method is 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.

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

This method is 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
background the value of the BACKGROUND 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

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

This method is 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

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

This method is 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

public static void generateTABLE (MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName, String id)

This method is 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

public static void generateTABLE (MarkupOutput mo, int indent, String width, String border, String cellSpacing, String cellPadding, String bgColor, String cssName)

This method is 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

public static void generateTEXTAREA (MarkupOutput mo, int indent, String name, String value, int columns, int rows, String style)

This method is 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

public static void generateTEXTBOX (MarkupOutput mo, int indent, String name, String value, String size, String maxLength, String style)

This method is 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

public static void generateTEXTBOX (MarkupOutput mo, int indent, String name, String value, String size, String maxLength, String style, String extraParameters)

This method is 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

public static String getFormattedValue (String value, 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

public static String getOfficeLink ()

This method is 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.

public static String getOfficeLink (AppContext appContext)

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

public static String getQuickSymbolImageSource (int type)

This method is deprecated.
replaced by get(int) and getImageSource()

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

Parameters
type int EnumDSSXMLSymbol
Returns
  • String image source

public static String getQuickSymbolString (int type)

This method is deprecated.
replaced by get(int) and 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

public static String getQuickSymbolUnicode (int type)

This method is 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

public static String getQuickSymbolUnicodeByChar (char character)

This method is 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

public static 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.

public static String getResourcePathWithVersion (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
Returns
  • Resource path with version if needed

public static 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

public static boolean isDefaultPreferenceValue (String preferenceName, 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.

public static ImageTag newImageTag (String src, String width, String height, 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.

public static InputTag newInputCheck (String name, 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 ATT_ID and ATT_NAME attributes
value Used for the Input's value.
checked If true sets the ATT_CHECKED attribute to "1".
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputHidden (String name, 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 ATT_ID and ATT_NAME attributes
value Used for the Input's value.
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputImage (String name, String src, String width, String height, 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 ATT_ID and ATT_NAME attributes
src Used for the ATT_SRC attribute.
width Used for the ATT_WIDTH attribute.
height Used for the ATT_HEIGHT attribute.
title Used for the ATT_TITLE attribute.
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputRadio (String id, String name, 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 ATT_ID attribute
name Used for the ATT_NAME attribute
value Used for the Input's value.
checked If true sets the ATT_CHECKED attribute to "1".
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputRadio (String name, 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 ATT_ID and ATT_NAME attributes
value Used for the Input's value.
checked If true sets the ATT_CHECKED attribute to "1".
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputSubmit (String name, 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 ATT_ID and ATT_NAME attributes
value Used for the Input's value.
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static InputTag newInputText (String name, String value, String size, 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 ATT_ID and ATT_NAME attributes
value Used for the Input's value.
size Used for the ATT_SIZE attribute.
maxLength Used for the ATT_MAXLENGTH attribute.
nse If provided, is used to encode the ATT_NAME attribute.
Returns
  • An InputTag populated with the given values.

public static void renderQuickSymbolforText (MarkupOutput out, String text, boolean isIE)

This method is deprecated.
should not use this - see EnumQuickSymbol

Generates the HTML the text as a "quick symbol"

Parameters
out the output object

Protected Methods

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.