Contribution org.nuxeo.ecm.platform.forms.layouts.webapp.summary--widgettypes
In component org.nuxeo.ecm.platform.forms.layouts.webapp.summary
org.nuxeo.ecm.platform.forms.layouts.webapp.summary
inside nuxeo-platform-webapp-core-9.10.jar /OSGI-INF/layouts-summary-contrib.xml
This contribution is part of XML component Documentation
The widget types from this contribution are intended to be used in the summary view. All these widgets are bound to the currentDocument in the Seam context.
Extension Point
Extension point widgettypes of component WebLayoutManager.Contributed Items
XML Source
<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">
<documentation>
The widget types from this contribution are intended to be
used in the summary view. All these widgets are bound to the
currentDocument in the Seam context.
</documentation>
<widgetType name="summary_current_document_actions">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<deprecatedVersion>5.6</deprecatedVersion>
<title>Actions (lock, restore version)</title>
<description>
<p>
This widget displays the actions on the current document
(lock/unlock and undelete by default).
</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
</ul>
</p>
</description>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/actions_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_custom_actions">
<configuration>
<sinceVersion>5.4.2</sinceVersion>
<deprecatedVersion>5.7</deprecatedVersion>
<title>Custom actions</title>
<description>
<p>This widget displays custom actions on the current document.</p>
<p>
It will display actions in the category given in the 'category'
property (defaults to 'DOCUMENT_SUMMARY_CUSTOM_ACTIONS' when not
set). The widget label and help label will be displayed above the
actions.
</p>
</description>
<categories>
<category>summary</category>
<category>tab_designer</category>
</categories>
<handlingLabels>true</handlingLabels>
<supportedModes>
<mode>view</mode>
</supportedModes>
<properties>
<layouts mode="any">
<layout name="summary_current_document_custom_actions_widget_type_properties_any">
<rows>
<row>
<widget>category</widget>
</row>
<row>
<widget>actionsDisplay</widget>
</row>
<row>
<widget>overallDisplay</widget>
</row>
<row>
<widget>maxActionsNumber</widget>
</row>
<row>
<widget>headerStyleClass</widget>
</row>
<row>
<widget>styleClass</widget>
</row>
<row>
<widget>subStyleClass</widget>
</row>
<row>
<widget>moreMenuLabel</widget>
</row>
</rows>
<widget name="category" type="selectOneResource">
<labels>
<label mode="any">Category</label>
</labels>
<helpLabels>
<label mode="any">
The category of actions to use (defaults to
DOCUMENT_SUMMARY_CUSTOM_ACTIONS when not set)
</label>
</helpLabels>
<fields>
<field>category</field>
</fields>
<widgetModes>
<mode value="edit_demo_preview">hidden</mode>
</widgetModes>
<properties mode="any">
<property name="resourceName">actionCategories</property>
</properties>
</widget>
<widget name="headerStyleClass" type="text">
<labels>
<label mode="any">Header style class</label>
</labels>
<helpLabels>
<label mode="any">
Style class for the header, displaying this
widget label. Available since 5.6.
</label>
</helpLabels>
<fields>
<field>headerStyleClass</field>
</fields>
</widget>
<widget name="actionsDisplay" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Actions display</label>
</labels>
<helpLabels>
<label mode="any">
If set to 'buttons', actions will be
displayed as command buttons. If set to 'links', actions
will be displayed as command links. If set to 'icons',
actions will be displayed as icons.
Else (default behaviour),
actions will be displayed as command links and display their
icons when defined.
</label>
</helpLabels>
<fields>
<!-- still named display here, kept for BBB -->
<field>display</field>
</fields>
<selectOptions>
<option itemLabel="Icons and links (default)" itemValue="icons_links"/>
<option itemLabel="Icons" itemValue="icons"/>
<option itemLabel="Buttons" itemValue="buttons"/>
<option itemLabel="Links" itemValue="links"/>
</selectOptions>
</widget>
<widget name="overallDisplay" type="selectOneListbox">
<categories>
<category>widgetTypeConf</category>
</categories>
<labels>
<label mode="any">Overall display</label>
</labels>
<helpLabels>
<label mode="any">
Overall display of actions, available since
5.6.
</label>
</helpLabels>
<fields>
<field>overallDisplay</field>
</fields>
<selectOptions>
<option itemLabel="Vertical block (default)" itemValue=""/>
<option itemLabel="Horizontal block" itemValue="horizontal_block"/>
<option itemLabel="Menu" itemValue="menu"/>
</selectOptions>
</widget>
<widget name="styleClass" type="text">
<labels>
<label mode="any">Style class</label>
</labels>
<helpLabels>
<label mode="any">
Style class for the global container div.
Available since 5.6.
</label>
</helpLabels>
<fields>
<field>styleClass</field>
</fields>
</widget>
<widget name="subStyleClass" type="text">
<labels>
<label mode="any">Sub style class</label>
</labels>
<helpLabels>
<label mode="any">
Style class for div containing actions.
Available since 5.6.
</label>
</helpLabels>
<fields>
<field>subStyleClass</field>
</fields>
</widget>
<widget name="actionStyleClass" type="text">
<labels>
<label mode="any">Action style class</label>
</labels>
<helpLabels>
<label mode="any">
Style class for each action link. Available
since 5.6.
</label>
</helpLabels>
<fields>
<field>subStyleClass</field>
</fields>
</widget>
<widget name="maxActionsNumber" type="int">
<labels>
<label mode="any">Maximum number of actions</label>
</labels>
<helpLabels>
<label mode="any">
Integer indicating the maximum number of
actions to display. When this limit is reached, other
actions are displayed in a menu. Available since 5.6.
</label>
</helpLabels>
<fields>
<field>maxActionsNumber</field>
</fields>
</widget>
<widget name="moreMenuLabel" type="text">
<labels>
<label mode="any">Label for the "more" menu</label>
</labels>
<fields>
<field>moreMenuLabel</field>
</fields>
</widget>
</layout>
</layouts>
</properties>
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/custom_actions_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_description">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Description</title>
<description>
<p>This widget displays the description of the currentDocument.</p>
<p>
Since 5.6, it also displays the creation date, author and version
beneath the description.
</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
<li>currentDocumentVersionInfo: the current document version
information</li>
</ul>
</p>
</description>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/description_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_files">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Files</title>
<description>
<p>This widget displays the files held by the currentDocument</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
<li>
currentDocumentAsBlobHolder: the BlobHolder on the
currentDocument
</li>
<li>
conversionActions: the Seam Bean wrapping the
conversionService
</li>
<li>liveEditHelper: the Seam Bean encapsulating LiveEdit</li>
</ul>
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/content_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_view">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>View layout</title>
<description>
<p>This widget displays the view layouts of the currentDocument</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
<li>currentDocumentType: the type of the current document</li>
</ul>
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/metadata_custom_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_dublincore">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Dublincore</title>
<description>
<p>
This widget displays the dublincore layout of the currentDocument.
</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
</ul>
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/metadata_dc_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_tagging">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Tagging</title>
<description>
This widget displays the tags for the currentDocument and
allows to add new ones. It requires the tag service to be deployed.
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<properties>
<defaultValues mode="any">
<property name="width">100%</property>
</defaultValues>
</properties>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/tagging_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_relations">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Relations</title>
<description>
This widget displays the in/out relations for the
currentDocument. It requires the Relation service to be deployed.
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/relations_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_comments">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Comments</title>
<description>
This widget displays the comments for the currentDocument.
It requires the Comment service to be deployed.
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/comments_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_publications">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Publications</title>
<description>
This widget displays the publications of the
currentDocument. It requires the Publisher service to be deployed.
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/publication_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_lc_and_version">
<configuration>
<sinceVersion>5.3.1</sinceVersion>
<title>Life cycle state and version</title>
<description>
<p>
This widget displays the life-cycle state and version of the
currentDocument.
</p>
<p>
Since 5.6, this widget is not used by default, it's replaced by the
widget named "summary_current_document_states".
</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>currentDocument: the current document</li>
<li>
currentDocumentVersionInfo: the current document versionning
information
</li>
</ul>
</p>
</description>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/lc_and_version_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_single_tasks">
<configuration>
<sinceVersion>5.3.2</sinceVersion>
<title>Tasks</title>
<description>
<p>
This widget displays the single tasks (out of a process instance)
attached to current document model.
</p>
<p>
It requires the following variables to be present in the EL context:
<ul>
<li>
currentSingleTasks: the single tasks attached to current
document
</li>
</ul>
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<containingForm>true</containingForm>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/single_tasks_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_states">
<configuration>
<sinceVersion>5.6</sinceVersion>
<title>States</title>
<description>
<p>
This widget displays current document state (life cycle state and
lock status)
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/states_widget_template.xhtml
</property>
</widgetType>
<widgetType name="summary_current_document_contributors">
<configuration>
<sinceVersion>5.6</sinceVersion>
<title>Contributors</title>
<description>
<p>
This widget displays the document contributors.
</p>
</description>
<handlingLabels>true</handlingLabels>
<categories>
<category>summary</category>
</categories>
<supportedModes>
<mode>view</mode>
</supportedModes>
<!-- no configurable properties -->
</configuration>
<handler-class>
org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
</handler-class>
<property name="template">
/widgets/summary/contributors_widget_template.xhtml
</property>
</widgetType>
</extension>