org.nuxeo.ecm.platform.ui.web.tag.fn

Class Functions

java.lang.Object

org.nuxeo.ecm.platform.ui.web.tag.fn.Functions

public final class Functions
extends Object

Util functions.

Author:

Anahide Tchertchian, Thierry Martins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Functions.BytePrefix

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIG_FILE_SIZE_LIMIT_PROPERTY
static long	DEFAULT_BIG_FILE_SIZE_LIMIT
static String	I18N_DURATION_PREFIX
static Pattern	YEAR_PATTERN

Method Summary

Methods

Modifier and Type	Method and Description
static String	basicDateAndTimeFormater() Deprecated. since 5.9.1, use basicDateAndTimeFormatter() instead.
static String	basicDateAndTimeFormatter() Return the date format to handle date and time taking the user's locale into account.
static String	basicDateFormater() Deprecated. since 5.9.1, use basicDateFormatter() instead.
static String	basicDateFormatter() Return the date format to handle date taking the user's locale into account.
static List<Object>	combineLists(List<? extends Object>... lists)
static String	componentAbsoluteId(javax.faces.component.UIComponent anchor, String targetId) Returns the target component absolute id given an anchor in the tree and a local id.
static String	concat(String s1, String s2)
static String	dateAndTimeFormater(String formatLength) Deprecated. since 5.9.1, use dateAndTimeFormatter(String) instead.
static String	dateAndTimeFormatter(String formatLength) Return the date format to handle date and time taking the user's locale into account.
static String	dateFormater(String formatLength) Deprecated. since 5.9.1, use #dateFormatter() instead.
static String	dateFormatter(String formatLength) Return the date format to handle date taking the user's locale into account.
static String	fileBaseName(String filename) Returns the base name from the given filename.
static String	fileExtension(String filename) Returns the extension from the given filename.
static String	formatDate(Date date, String format)
static String	formatDateUsingBasicFormatter(Date date)
static long	getBigFileSizeLimit()
static long	getFileSize(String value)
static long	getValueFromMultiplier(String m) Transform the parameter in entry according to these unit systems: SI prefixes: k/M/G for kilo, mega, giga IEC prefixes: Ki/Mi/Gi for kibi, mebi, gibi
static String	groupDisplayName(String name, String label) Choose between label or name the best string to display a group
static String	groupFullName(String groupId) Returns the full name of a group from his id
static boolean	hasMessages(String clientId) Returns true if the faces context holds messages for given JSF component id, usually the form id.
static String	htmlEscape(String data)
static String	indentString(Integer level, String text)
static Integer	integerDivision(Integer x, Integer y)
static String	javaScriptEscape(String data) Escapes a given string to be used in a JavaScript function (escaping single quote characters for instance).
static String	join(String[] list, String separator)
static String	joinArrayWithFinalDelimiter(Object[] collection, String separator, String finalSeparator)
static String	joinCollection(Collection<Object> collection, String separator)
static String	joinCollectionWithFinalDelimiter(Collection<Object> collection, String separator, String finalSeparator) Can be used in order to produce something like that "Julien, Alain , Thierry et Marc-Aurele" where ' , ' and ' et ' is the final one.
static String	joinRender(String render1, String render2) Joins two strings to get a valid render attribute for ajax components.
static String	jsfTagIdEscape(String base) Helper that escapes a string used as a JSF tag id: this is useful to replace characters that are not handled correctly in JSF context.
static String	principalFullName(NuxeoPrincipal principal)
static String	printFileSize(String size)
static String	printFormatedFileSize(String sizeS, String format, Boolean isShort)
static String	printFormattedDuration(Object durationObj)
static String	printFormattedDuration(Object durationObj, Map<String,String> i18nLabels) Format the duration of a media in a string of two consecutive units to best express the duration of a media, e.g.: 1 hr 42 min 2 min 25 sec 10 sec 0 sec
static Object	test(Boolean test, Object onSuccess, Object onFailure)
static String	translate(String messageId, Object... params)
static String	userDisplayName(String id, String first, String last)
static String	userDisplayNameAndEmail(String id, String first, String last, String email) Return, from the id, the id its-self if neither last name nor name are found or the full name plus the email if this one exists
static String	userFullName(String username) Returns the full name of a user, or its username if user if not found.
static boolean	userIsMemberOf(String groupName)
static String	userUrl(String patternName, String username, String viewId, boolean newConversation)
static String	userUrl(String patternName, String username, String viewId, boolean newConversation, javax.servlet.http.HttpServletRequest req)

Methods inherited from class java.lang.Object

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

Field Detail

I18N_DURATION_PREFIX

public static final String I18N_DURATION_PREFIX

See Also:

Constant Field Values

BIG_FILE_SIZE_LIMIT_PROPERTY

public static final String BIG_FILE_SIZE_LIMIT_PROPERTY

See Also:

Constant Field Values

DEFAULT_BIG_FILE_SIZE_LIMIT

public static final long DEFAULT_BIG_FILE_SIZE_LIMIT

See Also:

Constant Field Values

YEAR_PATTERN

public static final Pattern YEAR_PATTERN

Method Detail

test

public static Object test(Boolean test,
          Object onSuccess,
          Object onFailure)

join

public static String join(String[] list,
          String separator)

joinCollection

public static String joinCollection(Collection<Object> collection,
                    String separator)

htmlEscape

public static String htmlEscape(String data)

javaScriptEscape

public static String javaScriptEscape(String data)

Escapes a given string to be used in a JavaScript function (escaping single quote characters for instance).

Since:

5.4.2

joinCollectionWithFinalDelimiter

public static String joinCollectionWithFinalDelimiter(Collection<Object> collection,
                                      String separator,
                                      String finalSeparator)

Can be used in order to produce something like that "Julien, Alain , Thierry et Marc-Aurele" where ' , ' and ' et ' is the final one.

joinArrayWithFinalDelimiter

public static String joinArrayWithFinalDelimiter(Object[] collection,
                                 String separator,
                                 String finalSeparator)

formatDateUsingBasicFormatter

public static String formatDateUsingBasicFormatter(Date date)

formatDate

public static String formatDate(Date date,
                String format)

concat

public static String concat(String s1,
            String s2)

indentString

public static String indentString(Integer level,
                  String text)

userIsMemberOf

public static boolean userIsMemberOf(String groupName)

userFullName

public static String userFullName(String username)

Returns the full name of a user, or its username if user if not found.

Since 5.5, returns null if given username is null (instead of returning the current user full name).

groupFullName

public static String groupFullName(String groupId)

Returns the full name of a group from his id

Parameters:

groupId - the group id

Returns:

the group full name

Since:

5.5

See Also:

groupDisplayName(String, String)

principalFullName

public static String principalFullName(NuxeoPrincipal principal)

userDisplayName

public static String userDisplayName(String id,
                     String first,
                     String last)

userDisplayNameAndEmail

public static String userDisplayNameAndEmail(String id,
                             String first,
                             String last,
                             String email)

Return, from the id, the id its-self if neither last name nor name are found or the full name plus the email if this one exists

Parameters:

id - id of the user

first - first name of the user

last - last name of the user

email - email of the user

Returns:

id or full name with email if exists

Since:

5.5

groupDisplayName

public static String groupDisplayName(String name,
                      String label)

Choose between label or name the best string to display a group

Parameters:

name - the group name

label - the group name

Returns:

label if not empty or null, otherwise group name

Since:

5.5

dateFormater

@Deprecated
public static String dateFormater(String formatLength)

Deprecated. since 5.9.1, use #dateFormatter() instead.

dateFormatter

public static String dateFormatter(String formatLength)

Return the date format to handle date taking the user's locale into account.

Since:

5.9.1

basicDateFormater

@Deprecated
public static String basicDateFormater()

Deprecated. since 5.9.1, use basicDateFormatter() instead.

basicDateFormatter

public static String basicDateFormatter()

Return the date format to handle date taking the user's locale into account. Uses the pseudo "shortWithCentury" format.

Since:

5.9.1

dateAndTimeFormater

@Deprecated
public static String dateAndTimeFormater(String formatLength)

Deprecated. since 5.9.1, use dateAndTimeFormatter(String) instead.

dateAndTimeFormatter

public static String dateAndTimeFormatter(String formatLength)

Return the date format to handle date and time taking the user's locale into account.

Since:

5.9.1

basicDateAndTimeFormater

@Deprecated
public static String basicDateAndTimeFormater()

Deprecated. since 5.9.1, use basicDateAndTimeFormatter() instead.

basicDateAndTimeFormatter

public static String basicDateAndTimeFormatter()

Return the date format to handle date and time taking the user's locale into account. Uses the pseudo "shortWithCentury" format.

Since:

5.9.1

printFileSize

public static String printFileSize(String size)

printFormatedFileSize

public static String printFormatedFileSize(String sizeS,
                           String format,
                           Boolean isShort)

integerDivision

public static Integer integerDivision(Integer x,
                      Integer y)

printFormattedDuration

public static String printFormattedDuration(Object durationObj,
                            Map<String,String> i18nLabels)

Format the duration of a media in a string of two consecutive units to best express the duration of a media, e.g.:

• 1 hr 42 min
• 2 min 25 sec
• 10 sec
• 0 sec

Parameters:

durationObj - a Float, Double, Integer, Long or String instance representing a duration in seconds

i18nLabels - a map to translate the days, hours, minutes and seconds labels

Returns:

the formatted string

printFormattedDuration

public static String printFormattedDuration(Object durationObj)

translate

public static final String translate(String messageId,
               Object... params)

getBigFileSizeLimit

public static long getBigFileSizeLimit()

Returns:

the big file size limit defined with the property org.nuxeo.big.file.size.limit

getFileSize

public static long getFileSize(String value)

getValueFromMultiplier

public static long getValueFromMultiplier(String m)

Transform the parameter in entry according to these unit systems:

• SI prefixes: k/M/G for kilo, mega, giga
• IEC prefixes: Ki/Mi/Gi for kibi, mebi, gibi

Parameters:

m - : binary prefix multiplier

Returns:

the value of the multiplier as a long

hasMessages

public static boolean hasMessages(String clientId)

Returns true if the faces context holds messages for given JSF component id, usually the form id.

Id given id is null, returns true if there is at least one client id with messages.

Since the form id might be prefixed with a container id in some cases, the method returns true if one of client ids with messages stats with given id, or if given id is contained in it.

Since:

5.4.2

userUrl

public static String userUrl(String patternName,
             String username,
             String viewId,
             boolean newConversation)

userUrl

public static String userUrl(String patternName,
             String username,
             String viewId,
             boolean newConversation,
             javax.servlet.http.HttpServletRequest req)

combineLists

public static List<Object> combineLists(List<? extends Object>... lists)

jsfTagIdEscape

public static String jsfTagIdEscape(String base)

Helper that escapes a string used as a JSF tag id: this is useful to replace characters that are not handled correctly in JSF context.

This method currently removes ASCII characters from the given string, and replaces "-" characters by "_" because the dash is an issue for forms rendered in ajax (see NXP-10793).

Also starting digits are replaced by the "_" character because a tag id cannot start with a digit.

Returns:

the escaped string

Since:

5.7

fileExtension

public static String fileExtension(String filename)

Returns the extension from the given filename.

See FilenameUtils.getExtension(String).

Since:

5.7

fileBaseName

public static String fileBaseName(String filename)

Returns the base name from the given filename.

See FilenameUtils.getBaseName(String).

Since:

5.7

joinRender

public static String joinRender(String render1,
                String render2)

Joins two strings to get a valid render attribute for ajax components.

Since:

6.0

componentAbsoluteId

public static String componentAbsoluteId(javax.faces.component.UIComponent anchor,
                         String targetId)

Returns the target component absolute id given an anchor in the tree and a local id.

If given targetId parameter contains spaces, consider several ids should be resolved and split them.

Parameters:

anchor - the component anchor, used a localization for the target component in the tree.

targetId - the component to look for locally so as to return its absolute client id.

Since:

6.0