of (OmniFaces VDL Documentation - Generated Documentation)

XML Declaration Syntax:

<anyxmlelement xmlns:of="http://omnifaces.org/functions"/>

Description:

No Description

Tag Library Information

Info Value

ID (tag prefix) of

URI http://omnifaces.org/functions

Tag Library Information
Info	Value
ID (tag prefix)	`of`
URI	`http://omnifaces.org/functions`

Function Summary
Type	Function	Description
`java.lang.String`	`abbreviate(java.lang.String, int)`	Abbreviate the given text on the given size limit with ellipsis.
`java.lang.String`	`concat(java.lang.Object, java.lang.Object)`	Concatenate the string representation of the given objects. This is useful when you don't know beforehand if one of the both hands is a string or is `null`, otherwise the new EL 2.2 `#{bean.string1.concat(bean.string2)}` can just be used.
`java.lang.String`	`capitalize(java.lang.String)`	Capitalize the given string, i.e. uppercase the first character.
`java.lang.String`	`prettyURL(java.lang.String)`	URL-prettify the given string. It performs the following tasks: Lowercase the string. Remove combining diacritical marks. Replace non-alphanumeric characters by hyphens. This is useful when populating links with dynamic paths obtained from user controlled variables, such as blog titles.
`java.lang.String`	`encodeURL(java.lang.String)`	URL-encode the given string using UTF-8. This is useful for cases where you can't use `<f:param>`.
`java.lang.String`	`escapeJS(java.lang.String)`	Escapes the given string according the JavaScript code rules. This escapes among others the special characters, the whitespace, the quotes and the unicode characters. Useful whenever you want to use a Java string variable as a JavaScript string variable.
`java.lang.String`	`format1(java.lang.String, java.lang.Object)`	Format the given string with 1 parameter. Design notice: There are five formatX() functions, each taking 1 to 5 format parameters because EL functions does not support varargs methods nor overloaded function names.
`java.lang.String`	`format2(java.lang.String, java.lang.Object, java.lang.Object)`	Format the given string with 2 parameters. Design notice: There are five formatX() functions, each taking 1 to 5 format parameters because EL functions does not support varargs methods nor overloaded function names.
`java.lang.String`	`format3(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)`	Format the given string with 3 parameters. Design notice: There are five formatX() functions, each taking 1 to 5 format parameters because EL functions does not support varargs methods nor overloaded function names.
`java.lang.String`	`format4(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	Format the given string with 4 parameters. Design notice: There are five formatX() functions, each taking 1 to 5 format parameters because EL functions does not support varargs methods nor overloaded function names.
`java.lang.String`	`format5(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	Format the given string with 5 parameters. Design notice: There are five formatX() functions, each taking 1 to 5 format parameters because EL functions does not support varargs methods nor overloaded function names.
`java.lang.Object[]`	`createArray(int)`	Creates and returns a dummy object array of the given size. This is useful if you want to iterate n times over an `<ui:repeat>`, which doesn't support EL in `begin` and `end` attributes.
`java.lang.int[]`	`createIntegerArray(int, int)`	Creates and an integer array which starts at the given integer and ends at the given integer, inclusive. This is useful if you want to for example populate a `<f:selectItems>` which shows an integer range to represent days and years.
`boolean`	`contains(java.lang.Object[], java.lang.Object)`	Returns `true` if the string representation of an item of the given array equals to the string representation of the given item. This returns `false` if either the array or the item is null. This is useful if you want to for example check if `#{paramValues.foo}` contains a certain value.
`java.util.List`	`setToList(java.util.Set)`	Converts a `Set<E>` to a `List<E>`. Useful when you want to iterate over a `Set` in for example `<ui:repeat>`.
`java.util.List`	`mapToList(java.util.Map)`	Converts a `Map<K, V>` to a `List<Map.Entry<K, V>>`. Useful when you want to iterate over a `Map` in for example `<ui:repeat>`. Each of the entries has the usual `getKey()` and `getValue()` methods.
`java.lang.String`	`joinArray(java.lang.Object, java.lang.String)`	Joins all elements of the given array to a single string, separated by the given separator.
`java.lang.String`	`joinCollection(java.util.Collection, java.lang.String)`	Joins all elements of the given collection to a single string, separated by the given separator.
`java.lang.String`	`joinMap(java.util.Map, java.lang.String, java.lang.String)`	Joins all elements of the given map to a single string, separated by the given key-value pair separator and entry separator.
`java.lang.String`	`printStackTrace(java.lang.Throwable)`	Print the stack trace of the given exception.
`java.lang.String`	`formatDate(java.util.Date, java.lang.String)`	Format the given date in the given pattern and system default timezone. This is useful when you want to format dates in for example the `title` attribute of an UI component, or the `itemLabel` attribute of select item, or wherever you can't use the `<f:convertDateTime>` tag.
`java.lang.String`	`formatDateWithTimezone(java.util.Date, java.lang.String, java.lang.Object)`	Format the given date in the given pattern with given timezone. This is useful when you want to format dates in for example the `title` attribute of an UI component, or the `itemLabel` attribute of select item, or wherever you can't use the `<f:convertDateTime>` tag.
`java.util.Date`	`addYears(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of years. The years can be negative.
`java.util.Date`	`addMonths(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of months. The months can be negative.
`java.util.Date`	`addWeeks(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of weeks. The weeks can be negative.
`java.util.Date`	`addDays(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of days. The days can be negative.
`java.util.Date`	`addHours(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of hours. The hours can be negative.
`java.util.Date`	`addMinutes(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of minutes. The minutes can be negative.
`java.util.Date`	`addSeconds(java.util.Date, int)`	Returns a new date instance which is a sum of the given date and the given amount of seconds. The seconds can be negative.
`int`	`yearsBetween(java.util.Date, java.util.Date)`	Returns the amount of years between two given dates. This will be negative when the end date is before the start date.
`int`	`monthsBetween(java.util.Date, java.util.Date)`	Returns the amount of months between two given dates. This will be negative when the end date is before the start date.
`int`	`weeksBetween(java.util.Date, java.util.Date)`	Returns the amount of weeks between two given dates. This will be negative when the end date is before the start date.
`int`	`daysBetween(java.util.Date, java.util.Date)`	Returns the amount of days between two given dates. This will be negative when the end date is before the start date.
`int`	`hoursBetween(java.util.Date, java.util.Date)`	Returns the amount of hours between two given dates. This will be negative when the end date is before the start date.
`int`	`minutesBetween(java.util.Date, java.util.Date)`	Returns the amount of minutes between two given dates. This will be negative when the end date is before the start date.
`int`	`secondsBetween(java.util.Date, java.util.Date)`	Returns the amount of seconds between two given dates. This will be negative when the end date is before the start date.
`java.util.Map`	`getMonths()`	Returns a mapping of month names by month numbers for the current locale. For example: "January=1", "February=2", etc. This is useful if you want to for example populate a `<f:selectItems>` which shows all months. The locale is obtained by Faces#getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.
`java.util.Map`	`getShortMonths()`	Returns a mapping of short month names by month numbers for the current locale. For example: "Jan=1", "Feb=2", etc. This is useful if you want to for example populate a `<f:selectItems>` which shows all short months. The locale is obtained by Faces#getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.
`java.util.Map`	`getDaysOfWeek()`	Returns a mapping of day of week names in ISO 8601 order for the current locale. For example: "Monday=1", "Tuesday=2", etc. This is useful if you want to for example populate a `<f:selectItems>` which shows all days of week. The locale is obtained by Faces#getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.
`java.util.Map`	`getShortDaysOfWeek()`	Returns a mapping of short day of week names in ISO 8601 order for the current locale. For example: "Mon=1", "Tue=2", etc. This is useful if you want to for example populate a `<f:selectItems>` which shows all short days of week. The locale is obtained by Faces#getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.
`java.lang.String`	`getMonth(java.lang.Integer)`	Returns the month name from the mapping associated with the given month number for the current locale. For example: "1=January", "2=February", etc. The locale is obtained by Faces#getLocale().
`java.lang.String`	`getShortMonth(java.lang.Integer)`	Returns the short month name from the mapping associated with the given month number for the current locale. For example: "1=Jan", "2=Feb", etc. The locale is obtained by Faces#getLocale().
`java.lang.String`	`getDayOfWeek(java.lang.Integer)`	Returns the day of week name from the mapping associated with the given day of week number in ISO 8601 order (Monday first) for the current locale. For example: "1=Monday", "2=Tuesday", etc. The locale is obtained by Faces#getLocale().
`java.lang.String`	`getShortDayOfWeek(java.lang.Integer)`	Returns the short day of week name from the mapping associated with the given day of week number in ISO 8601 order (Monday first) for the current locale. For example: "1=Mon", "2=Tue", etc. The locale is obtained by Faces#getLocale().
`java.lang.String`	`formatBytes(java.lang.Long)`	Format the given bytes to nearest 10ⁿ with IEC binary unit (KiB, MiB, etc) with rounding precision of 1 fraction. For example: 1023 bytes will appear as 1023 B 1024 bytes will appear as 1.0 KiB 500000 bytes will appear as 488.3 KiB 1048576 bytes will appear as 1.0 GiB
`java.lang.String`	`formatCurrency(java.lang.Number, java.lang.String)`	Format the given number as currency with the given symbol. This is useful when you want to format numbers as currency in for example the `title` attribute of an UI component, or the `itemLabel` attribute of select item, or wherever you can't use the `<f:convertNumber>` tag. The format locale will be set to the one as obtained by `Faces#getLocale()`.
`java.lang.String`	`formatNumber(java.lang.Number, java.lang.String)`	Format the given number in the given pattern. This is useful when you want to format numbers in for example the `title` attribute of an UI component, or the `itemLabel` attribute of select item, or wherever you can't use the `<f:convertNumber>` tag. The format locale will be set to the one as obtained by `Faces#getLocale()`.
`java.lang.String`	`formatNumberDefault(java.lang.Number)`	Format the given number in the locale-default pattern. This is useful when you want to format numbers in for example the `title` attribute of an UI component, or the `itemLabel` attribute of select item, or wherever you can't use the `<f:convertNumber>` tag. The format locale will be set to the one as obtained by `Faces#getLocale()`.
`java.lang.Object`	`coalesce(java.lang.Object, java.lang.Object)`	Return the first non-`null` object from the two objects.