com.redhat.rhn.frontend.taglibs

Class RhnTagFunctions

java.lang.Object

com.redhat.rhn.frontend.taglibs.RhnTagFunctions

public class RhnTagFunctions
extends java.lang.Object

RhnTagFunctions - class to encapsulate the set of static methods that a JSP can interact with. See rhn-taglib.tld for list of <function> definitions

Method Summary

Modifier and Type	Method and Description
static java.lang.Boolean	arrayContains(java.lang.String[] array, java.lang.String string) Checks to see if an array of Strings contains any element that .equals() the given String
static java.lang.String	arrayToString(java.lang.String[] array) Joins an array of Strings into a comma-separated String
static java.lang.String	escapeJS(java.lang.String param) Escape the characters in a String using JavaScript String rules.
static java.lang.String	getConfig(java.lang.String confIn) Fetch a value from our Configuration system.
static java.lang.String	localizedValue(java.lang.String messageId) Provides the i18n'ed string for the given messageId.
static java.lang.String	localizedValue(java.lang.String messageId, java.lang.String params) This method is a variation of the the localizedValue(key) method This is exclusively used by the el expressions in various jsp pages.
static java.lang.String	localizedValueAnd2ndParam(java.lang.String messageId, java.lang.String param1, java.lang.String param2) This method translates the message together with the 2nd parameter
static java.lang.String	localizedValueAndParams(java.lang.String messageId, java.lang.String params) This method is translates the message together with all the parameters
static java.lang.String	urlEncode(java.lang.String param) Encode a urlEncode a param

Methods inherited from class java.lang.Object

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

Method Detail

arrayToString

public static java.lang.String arrayToString(java.lang.String[] array)

Joins an array of Strings into a comma-separated String

Parameters:

array - The array of Strings to join

Returns:

String containing a comma-separated list

arrayContains

public static java.lang.Boolean arrayContains(java.lang.String[] array,
                                              java.lang.String string)

Checks to see if an array of Strings contains any element that .equals() the given String

Parameters:

array - The array of Strings to check

string - The string to look for in the array

Returns:

Boolean telling you if the String was found or not

getConfig

public static java.lang.String getConfig(java.lang.String confIn)

Fetch a value from our Configuration system. Makes a call into com.redhat.rhn.common.config.Config.get()

Parameters:

confIn - configuration value you are searching for

Returns:

String containing the config value. If not found returns NULL

localizedValue

public static java.lang.String localizedValue(java.lang.String messageId)

Provides the i18n'ed string for the given messageId. This is exclusively used by the el expressions in various jsp pages. For this to work you'd have to add

<%@ taglib uri="http://rhn.redhat.com/rhn" prefix="rhn" %> to the top of your jsp page

The you can say

${rhn:localize("rhn.foo.bar")} to get the localized value

Parameters:

messageId - the message id to localize on

Returns:

the i18ned string...

localizedValue

public static java.lang.String localizedValue(java.lang.String messageId,
                                              java.lang.String params)

This method is a variation of the the localizedValue(key) method This is exclusively used by the el expressions in various jsp pages. For this to work you'd have to add

<%@ taglib uri="http://rhn.redhat.com/rhn" prefix="rhn" %> to the top of your jsp page

The you can say

${rhn:localizeWithParams("rhn.foo.bar","param0|param1")} to get the localized value The method parameter 'param' takes a list of key parameters seperated by a '|'. It is rather unfortunate for it to take a '|' instead of taking a String[] as params.. This is because we donot know a way of creating arrays as el expressions...

Parameters:

messageId - the message id to localize on

params - a list of values separated by '|', or null...

Returns:

the i18ned string...

localizedValueAndParams

public static java.lang.String localizedValueAndParams(java.lang.String messageId,
                                                       java.lang.String params)

This method is translates the message together with all the parameters

Parameters:

messageId - the message id to localize on

params - a list of values separated by '|', or null...

Returns:

the i18ned string

localizedValueAnd2ndParam

public static java.lang.String localizedValueAnd2ndParam(java.lang.String messageId,
                                                         java.lang.String param1,
                                                         java.lang.String param2)

This method translates the message together with the 2nd parameter

Parameters:

messageId - massage id

param1 - regular param

param2 - param to localize

Returns:

the i18ned string

urlEncode

public static java.lang.String urlEncode(java.lang.String param)

Encode a urlEncode a param

Parameters:

param - to be url encoded

Returns:

url encoded param

escapeJS

public static java.lang.String escapeJS(java.lang.String param)

Escape the characters in a String using JavaScript String rules.

Parameters:

param - to be escaped

Returns:

escaped string