nxd (Nuxeo VDL Generated Documentation)

XML Declaration Syntax:

<anyxmlelement xmlns:nxd="http://nuxeo.org/nxweb/document"/>

Description:

Nuxeo Document Taglib

Defines tags and functions to handle Nuxeo Core documents.

Tag Library Information
Info	Value
ID (tag prefix)	`nxd`
URI	`http://nuxeo.org/nxweb/document`

Tag Summary
Tag	Description
documentLink	Link to a document within the application using standard command link component and renderer. All usual command link attribute are accepted except value and action. Value is replaced by the title attribute value, and action is dynamically processed to retrun to the document view.
restDocumentLink	Link to a document within the application using standard output link component and renderer. The main purpose of this tag is to provide restful (bookmarkable) navigation inside documents. All usual output link attributes are accepted except value. Sub tags "f:param" are taken into account to build the corresponding DocumentView and URL. Value is replaced a method binding that generates the correct rest URL.

Function Summary
Type	Function	Description
`org.nuxeo.ecm.platform.types.adapter.TypeInfo`	`typeInfo(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document type information as defined in the TypeService extension point.
`java.lang.String`	`typeLabel(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document type label as defined in the TypeService extension point.
`java.lang.String`	`typeView(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String)`	Returns the document type view as defined in the TypeService extension point.
`java.lang.String`	`iconPath(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document "icon" path from the "common" schema. If not set, defaults to the corresponding document type icon, as defined in the TypeService extension point.
`java.lang.String`	`iconExpandedPath(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document "icon-expanded" path from the "common" schema. If not set, defaults to the corresponding document type icon, as defined in the TypeService extension point.
`java.lang.String`	`bigIconPath(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document type nig icon path as defined in the TypeService extension point.
`java.lang.String`	`fileIconPath(org.nuxeo.ecm.core.api.Blob)`	Returns an icon path matching the mimetype of given blob.
`java.lang.String`	`propertyPath(java.lang.String, int, java.lang.String)`	Returns the property xpath given the property list name, the index and the sub property name.
`java.lang.String`	`titleOrId(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the document title extracted from the "dublincore" schema, or the document id if this property value is empty.
`java.lang.String`	`titleFromId(java.lang.String)`	Returns the document title (or id if not filled) given a document id. Resolves the document in current repository session context.
`boolean`	`isDirty(org.nuxeo.ecm.core.api.DocumentModel)`	Returns true if document model is dirty, or if dirty properties hold empty values. This is useful to check if the 'clear filter' button should be displayed on content views for instance.
`boolean`	`isDocumentModel(java.lang.Object)`	Returns true if given object is an instance of the Nuxeo Core org.nuxeo.ecm.core.api.DocumentModel interface.
`boolean`	`hasPermission(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String)`	Returns true if the current user has the specified permission on the given document model.
`boolean`	`canModify(org.nuxeo.ecm.core.api.DocumentModel)`	Returns true if the current user has the Write permission on the document model, and if document is not archived.
`java.lang.Object`	`defaultValue(java.lang.String, java.lang.String)`	Returns the default value for given schema and field names: this is useful to set the "template" attribute of a nxu:inputList tag managing a document complex property.
`java.lang.Object`	`propertyDefaultValue(java.lang.String)`	Returns the default value for given property path: this is useful to set the "template" attribute of a nxu:inputList tag managing a document complex property.
`java.lang.String`	`fileUrl(java.lang.String, org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.lang.String)`	Returns the restful URL for a blob, given a pattern name, a document, the blob property path and the filename value.
`java.lang.String`	`bigFileUrl(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.lang.String)`	Returns the restful URL for a blob, using the nxbigfile servlet, given a document, the blob property path and the filename value.
`java.lang.String`	`fileDescription( org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.lang.String, java.lang.String)`	Returns the pretty-print description of a blob, including filename and size.
`java.lang.String`	`complexFileUrl(java.lang.String, org.nuxeo.ecm.core.api.DocumentModel, int, java.lang.String)`	Returns the restful URL for a blob stored inside the "files" multi-valued property, given a pattern, the document, its index inside the multi-valued property, and the filename value.
`java.lang.String`	`complexFileUrl(java.lang.String, org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, int, java.lang.String, java.lang.String)`	Returns the restful URL for a blob stored inside a multi-valued property, given a pattern, the document, the multi-valued property path, the blob index inside the multi-valued property, the blob property name, and the filename value.
`java.lang.String`	`documentUrl(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the default rest URL for a document.
`java.lang.String`	`complexDocumentUrl(java.lang.String, org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.util.Map, boolean)`	Returns the rest URL for a document, given a pattern, the document, the view, a map of properties, and a boolean stating if link should be started in a new Seam conversation.
`java.lang.String`	`liveEditDefaultUrl(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the nxedit:// URL to edit a document file attachement.
`java.lang.String`	`liveEditUrl(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.lang.String, java.lang.String)`	Returns the nxedit:// URL to edit a document providing schema, blob field and filename field names.
`java.lang.String`	`liveCreateDefaultUrl(java.lang.String)`	Returns the nxedit:// URL to create a new document of type File given a mimetype.
`java.lang.String`	`liveCreateUrl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)`	Returns the nxedit:// URL to create a new document with parameters: mimetype, doctype, schema, blob and filename field names.
`java.lang.String`	`liveCreateFromTemplateDefaultUrl(org.nuxeo.ecm.core.api.DocumentModel)`	Returns the nxedit:// URL to creat a new document of type File reusing the content of the blob of the provided template DocumentModel (assumed to hold the "file" schema).
`java.lang.String`	`liveCreateFromTemplateUrl(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)`	Returns 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.
`java.lang.String`	`complexLiveEditUrl(org.nuxeo.ecm.core.api.DocumentModel, java.lang.String, int, java.lang.String, java.lang.String)`	Returns the nxedit:// URL to edit and existing document, given a document, a multi-valued property name, the index of the blob to edit inside this property, the blob property name, and the filename property name.
`java.util.List`	`availableLifeCycleTransitions(java.lang.String, java.lang.String)`	Returns all the available transitions to follow given a lifecycle name and current lifecycle state.