nxu (Tag Library Documentation Generator - Generated Documentation)

Overview

Library

Tag

Help

FRAMES NO FRAMES

nxu

Standard Syntax:


                    
                
                    <%@ taglib prefix="nxu" uri="http://nuxeo.org/nxweb/util" %>

XML Syntax:


                    
                
                    <anyxmlelement xmlns:nxu="http://nuxeo.org/nxweb/util" />

The NXWebPlatform (re)definition of basic tags.

Basic tags can be seen as useful tags which are still not really specific to the Nuxeo 5 framework.

Also exposes utility functions like:

test(Boolean, Object, Object): performs the java "if-then-else" operation.
indentString(Integer, String): returns a String with given String appended as many times as given integer.
join(String[], String): performs a join on given array using given separator.
joinArrayWithFinalDelimiter(Object[], String, String): performs a join on given array using given separator and given final delimiter for last item.
joinCollection(Collection, String): performs a join on given collection using given separator.
joinCollectionWithFinalDelimiter(Collection, String, String): performs a join on given collection using given separator and given final delimiter for last item.
userIsMemberOf(String): tests if the user belongs to the named group.
userFullName(String): returns the full name of a user given its id.
userDisplayName(String, String, String): returns the full name of a user given its id, first name and last name.
userDisplayNameAndEmail(String, String, String,String): returns the full name of a user and its email given its id, first name, last name and email. Available since 5.5.
groupDisplayName(String, String): returns the label of a group given its id, label. Available since 5.5.
groupFullName(String): returns the label of a group from its id. Available since 5.5.
userUrl(String patternName, String username, String viewId, boolean newConversation): returns the user profile rest url given the pattern name (usually 'user'), the user name, the view id (can be null) and if a new conversation need to be created or not. Available since 5.5.
htmlEscape(String): returns html escaped string (can be use to do safe h:outputText in scripts).
javaScriptEscape(String): returns escaped string for use in JavaScript code (escapes single quote characters for instance).
printFileSize(String size): same as printFormatedFileSize( size, "SI", true)
printFormatedFileSize(String size, String format, boolean isShort) pretty print the size of a file using the format given in its short or long form. The format available are "SI", "IEC" or "JEDEC". See the wikipedia article on Byte for more information on those format.
printFormattedDuration(Object durationInSeconds, Map <String , String> messages): pretty print raw duration measured in seconds as "1 hr 23 min" or "31 min 29 sec" or "3 sec" for instance
printFormattedDuration(Object durationInSeconds): same as printFormattedDuration(Object durationInSeconds, null)
translate(String messageKey, Object... params): returns translated message with given parameters to be used when formatting the message value.
hasMessages(String): returns true if faces context has messages for client ids starting with given string (if not null). If given String is null, returns true if there are any kind of messages.
dateFormater(String): returns a date format pattern using format given in parameter. Accepted values: short, shortWithCentury (since 5.6), medium, long, full.
basicDateFormater(String): returns a date format pattern using the default format "shortWithCentury".
dateAndTimeFormater(String): returns a date and time format pattern using format given in parameter. Accepted values: short, shortWithCentury, medium, long, full.
basicDateAndTimeFormater(String): returns a date and time format pattern using the default format "shortWithCentury".
combineLists(List...): returns an aggregate list with the elements all the lists passed as arguments, preserving the global ordering.
jsfTagIdEscape(String): returns a valid string to be used as a JSF tag id from the given name. Throws an error if given name is empty. Available since 5.7.
joinRender(String, String): joins two strings to generate a valid render attribute for ajax components on JSF2. Available since 5.9.5.

Tag Library Information
Display Name	None
Version	1.0
Short Name	nxu
URI	http://nuxeo.org/nxweb/util

Tag Summary
methodResult	Facelet tag handler that exposes the result of a method binding as a variable. Note that this tag is deprecated since Seam 2.0 handles method resolution natively. The tag nxu:set can be used instead. This is helpful to avoid having to define a getter on a class to get some rendering info. This is comparable to f:param or ui:param tags, but using method bindings instead of value bindings. WARNING : the variable is only exposed inside the tag: this is a different behaviour than the c:set tag that can be closed immediately.
set	Facelet tag handler that exposes an expression as a variable, and makes it possible to cache it. This is very close to the c:set tag, but allows caching, and the variable is only exposed inside the tag. Note that this tag will not work as expected when used with iteration variables inside a standard table, for instance.
repeat	Facelet tag handler that performs an iteration. This handler is very close to the facelets c:forEach tag handler. It holds additional configuration to handle ajax re-rendering of lists, avoiding potential JSF duplicate id issues when the iteration list changes.
actionListenerMethod	Facelet tag handler that add an action listener to the parent component. Available since 5.3.1. Parent needs to be an action source for the action listener to be declared on it. This is useful when declaring several action listeners on the same parent component, and when the order of calls needs to be respected: the action listener method declared on a component is the first one called. So this method makes it possible to add other action listeners before it, without having to declare a class (when using the f:actionListener tag). Since 5.6, this tag can resolve expressions twice, making it possible to use it with Nuxeo actions configured to reference an EL expression in their definition: first to call action#getLink and then to call the actual action defined by another EL expression.
selectItem	Tag adapted from the EasySI package ( http://jsf-comp.sourceforge.net/components/easysi/index.html). This tag allows to iterate on any kind of data and have control on the resulting selection value and label.
selectItems	Tag adapted from the EasySI package ( http://jsf-comp.sourceforge.net/components/easysi/index.html). This tag allows to iterate on any kind of data and have control on the resulting selections values and labels. It has been adapted to work with datamodel lists wrapped by Seam (when using the Datamodel annotation).
inputFile	Util tag to perform a complex file upload dealing with edition and deletion. It only deals with NXCoreAPI blobs. This tag uses a component that will handle its rendering using other existing components. It will present a radio menu with existing choices: upload a file, keep it (eventually change its filename), delete it, or do nothing. Choices will be presented automatically given values and tag attributes (is there a blob set, is there a filename, is the blob required, etc...). It uses the nxu:outputFile related component rendering for the "keep" option and the tomahwak t:inputFileUpload tag for the "upload" option. It is possible to use a facet named "download" to override the default "keep" option rendering (e.g the document download presentation).
validateFileSize	Register an InputFileSizeValidator instance on the UIComponent associated with the closest parent UIComponent custom action.
validateFileMimetype	Register an InputFileMimetypeValidator instance on the UIComponent associated with the closest parent UIComponent custom action.
outputFile	Util tag to perform a file rendering. It only deals with NXCoreAPI blobs. Display is an immediate link to the blob, with filename as link value if provided, together with the blob mimetype icon.
inputDateTime	Calendar with date and time chosing.
editor	HTML editor
inputList	Tag to perform complex editions over a list of items. It only deals with lists or arrays of serializable objects. This tags puts a model in the request which can be accessed to get information about each list item value.
valueHolder	Tag to hold a value and expose it to the request context. It can control a value to sublit as any input component, or not. Available since 5.5.
dataList	Standard tomahawk tag
dataTable	Standard tomahawk tag
columns	Standard tomahawk tag
column	Standard tomahawk tag
inputDate	DISABLED TAG for nuxeo > 5.2m2, otherwise deprecated standard tomahawk tag.
inputCalendar	DISABLED TAG for nuxeo > 5.2m2, otherwise deprecated standard tomahawk tag.
schedule	DISABLED TAG for nuxeo > 5.2m2, otherwise deprecated standard tomahawk tag.
graphicImage	Customized graphicImage tag from 5.6, using renderer that does not display the tag at all when src is empty, and does not write empty attributes for width and height when empty as it's a problem for IE.
inputFileUpload	DISABLED TAG for nuxeo > 5.2m2, otherwise deprecated standard trinidad inputFile tag. Use s:fileUpload instead (available only for versions > 5.2m2).
selectOneRadio	Standard tomahawk tag
radio	Standard tomahawk tag

Overview

Library

Tag

Help

FRAMES NO FRAMES

Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.