Tag Library Documentation Generator - Generated Documentation

Tag Libraries
nxthemesNo Description
nxd

The NXWebPlatform taglib specific to NXCore document model features.

Exposes specific tags as well as utility functions like:

  • typeInfo(DocumentModel): retrieve the document type information as described in the TypeService extension point.
  • typeLabel(DocumentModel): retrieve the document type label.
  • iconPath(DocumentModel): retrieve the document icon path from "common" schema", defaults to its document type icon if not set.
  • iconExpandedPath(DocumentModel): retrieve the document icon-expanded path from "common" schema, defaults to its document type icon if not set.
  • titleOrId(DocumentModel): retrieve the document title from "dublincore" schema, defaults to its identifier.
  • hasPermission(DocumentModel, String): check if the current user has the specified permission on the document model.
  • canModify(DocumentModel): check if the current user has the specified permission on the document model, and document model is not archived.
  • defaultValue(String, String): get the default value for given schema name and field name: this is useful to set the "template" attribute of a nxu:inputList tag managing a document complex property.
  • propertyDefaultValue(String): get the default value for given property name: this is useful to set the "template" attribute of a nxu:inputList tag managing a document complex property.
  • fileUrl(String, DocumentModel, String, String): get the rest url for a blob.
  • bigFileUrl(DocumentModel, String, String): get the rest url for a blob using nxbigfile servlet.
  • fileDescription(DocumentModel doc, String blobPropertyPath, String filenamePropertyPath, String filename): get the pretty-print description of a blob.
  • documentUrl(DocumentModel): get the rest url for a document.
  • complexDocumentUrl(String, DocumentModel, String, Map, boolean): get the rest url for a document with parameters: the url pattern, the document, the view id, url parameters, and a boolean stating if a new conversation should be created. Available since 5.4.2.
  • liveEditDefaultUrl(DocumentModel): get the nxedit:// URL to edit a document file attachement (default File-like types)
  • liveEditUrl(DocumentModel, String, String, String): get the nxedit:// URL to edit a document proviging schema, blob field and filename field names
  • liveCreateDefaultUrl(String): get the nxedit:// url to create a new document of type File providing the mimetype as argument
  • liveCreateUrl(String, String, String, String, String): get the nxedit:// url to create a new document with parameters: mimetype, doctype, schema, blob and filename field names
  • liveCreateFromTemplateDefaultUrl(DocumentModel): get the nxedit:// URL to create a new document of type File reusing the content of the blob of the provided template DocumentModel (assumed to have the "file" schema).
  • liveCreateFromTemplateUrl(DocumentModel, String, String, String, String, String, String, String): get the nxedit:// URL to create a new document from template. Parameters are: template DocumentModel, template schema, template blob field, target document type, target schema, target, blob field name, target filename field.
  • propertyPath(String, int, String): builds the property path given the property list name, the index and the sub property name.
  • availableLifeCycleTransitions(String, String): get all the available transition to follow with the parameters: lifeCycleName and currentLifeCycleState
  • isDirty(DocumentModel): returns true if document model is dirty or dirty properties hold empty values. This is useful to check if the 'clear filter' button should be displayed on content views for instance.
  • isDocumentModel(Object): returns true if given object is an instance of the Nuxeo Core DocumentModel interface
nxu
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". Seethe wikipedia article on Bytefor more information on those format.printFormattedDuration(Object durationInSeconds, Map  messages): pretty print raw duration measured in seconds as "1 hr 23 min" or "31 min 29 sec" or "3 sec" for instanceprintFormattedDuration(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.
nxa4j

The NXWebPlatform taglib that encapsulates the usual ajax4jsf tags.

The point is to allow adding new features to existing tags without having to change too many templates. Only tags presenting a specific behaviour are described here.

New features:
  • The value attribute accepts not only values bindings, but also method bindings. This will invoke the method when trying to get the value. Setting the value is not possible. The parentheses are always required, to distinguish the value from a standard value binding (even if the method takes no parameters).
nxdir

NXDirectory tag library.

Exposes specific tags as well as utility functions like:

  • directoryEntry(String, String): gets the document model representing an entry for given directory name and entry id.
  • directoryListEntries(String, Collection): gets the list of document models representing entries for given directory name and entry ids.
  • directoryEntries(String, String[]): gets the list of document models representing entries for given directory name and entry ids.
  • getLabelFromId(String, String): gets the Label of a vocabulary entry for the given id and vocabulary. Deprecated, use directoryEntry(String, String) which is more generic.
nxh

The NXWebPlatform taglib that encapsulates the usual jsf tags.

The point is to allow adding new features to existing tags without having to change too many templates. Only tags presenting a specific behaviour are described here.

New features:
  • The value attribute accepts not only values bindings, but also method bindings. This will invoke the method when trying to get the value. Setting the value is not possible. The parentheses are always required, to distinguish the value from a standard value binding (even if the method takes no parameters).
nxl

Tags for layout system usage.

Defines helpers tags to display layouts and widgets.

Note that some attributes are used to determine what components will be part of the jsf component tree, so they have to be resolved early: they cannot use variables like iteration variables, coming for instance from a ui:repeat or a h:dataTable tag. This is true for layout names, modes and widget instances.

Library functions:

  • widgetTypeDefinition(String): returns the widget type definition for given widget type id. Available since 5.4.0.
  • fieldDefinitionsAsString(FieldDefinition[]): returns the list of property names for each of the field definitions, separated by a space.
  • selectedRows(Layout, List <String>, boolean) and alias selectedColumns(Layout, List <tring>, boolean): returns the list of LayoutRow instances that are selected given the Layout instance, the list of row names selected, and a boolean that, if set to true, will include rows that are marked as always selected.
  • notSelectedRows(Layout, List< String>) and alias notSelectedColumns(Layout, List <String>): returns the list of LayoutRow instances that are not selected given the Layout instance and the list of row names selected.
  • defaultSelectedRowNames(Layout, boolean) and alias defaultSelectedColumnNames(Layout, boolean): returns the list of row names that are marked as selected by default given the Layout instance and a boolean that, if set to true, will include rows that are marked as always selected.
  • isBoundToEditMode(String): returns true if given layout mode should be mapped to the 'edit' mode for widgets in the layout. Available since 5.4.0.
  • isLikePlainMode(String): returns true if given widget mode should be considered as 'plain', for instance when rendering values for CSV export. Available since 5.4.2.
  • isLikeViewMode(String): returns true if given widget mode should be considered as 'view' (old default mode), e.g. non-null mode, and none of edit, pdf, plain modes. Available since 5.4.2.
  • joinReRender(String, String): joins two strings to generate a valid reRender attribute for ajax components. Available since 5.7.



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