Platform Explorer / CMF 1.8

Contribution org.nuxeo.ecm.platform.forms.layouts.webapp.summary--widgettypes

This contribution is part of XML component org.nuxeo.ecm.platform.forms.layouts.webapp.summary inside nuxeo-platform-webapp-core-5.4.2-HF05.jar

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

  • <widgetType name="summary_current_document_actions">
          <configuration>
            <sinceVersion>5.3.1</sinceVersion>
            <title>Actions (lock, restore version)</title>
            <description>
              <p>
                This widgets 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>
            <title>Custom actions</title>
            <description>
              <p>This widgets 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>
            </categories>
            <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>display</widget>
                    </row>
                  </rows>
                  <widget name="category" type="text">
                    <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>
                  </widget>
                  <widget name="display" type="selectOneListbox">
                    <labels>
                      <label mode="any">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>
                      <field>display</field>
                    </fields>
                    <selectOptions>
                      <option itemLabel="Icons and links" itemValue=""/>
                      <option itemLabel="Icons" itemValue="icons"/>
                      <option itemLabel="Buttons" itemValue="buttons"/>
                      <option itemLabel="Links" itemValue="links"/>
                    </selectOptions>
                  </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 widgets displays the description 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>
            <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 widgets 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>
            <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 widgets 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>
            <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 widgets 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>
            <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 widgets displays the tags for the currentDocument and allow to
              add new ones. This widgets requires the tag service to be deployed.
            </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/tagging_widget_template.xhtml
          </property>
        </widgetType>

    This widgets displays the tags for the currentDocument and allow to add new ones. This widgets requires the tag service to be deployed.

  • <widgetType name="summary_current_document_relations">
          <configuration>
            <sinceVersion>5.3.1</sinceVersion>
            <title>Relations</title>
            <description>
              This widgets displays the in/out relations for the currentDocument.
              This widgets requires the Relation service to be deployed.
            </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/relations_widget_template.xhtml
          </property>
        </widgetType>

    This widgets displays the in/out relations for the currentDocument. This widgets requires the Relation service to be deployed.

  • <widgetType name="summary_current_document_comments">
          <configuration>
            <sinceVersion>5.3.1</sinceVersion>
            <title>Comments</title>
            <description>
              This widgets displays the comments for the currentDocument. This
              widgets requires the Comment service to be deployed.
            </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/comments_widget_template.xhtml
          </property>
        </widgetType>

    This widgets displays the comments for the currentDocument. This widgets requires the Comment service to be deployed.

  • <widgetType name="summary_current_document_publications">
          <configuration>
            <sinceVersion>5.3.1</sinceVersion>
            <title>Publications</title>
            <description>
              This widgets displays the publications of the currentDocument. This
              widgets requires the Publisher service to be deployed.
            </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/publication_widget_template.xhtml
          </property>
        </widgetType>

    This widgets displays the publications of the currentDocument. This widgets requires the Publisher service to be deployed.

  • <widgetType name="summary_current_document_lc_and_version">
          <configuration>
            <sinceVersion>5.3.1</sinceVersion>
            <title>Life cycle state and version</title>
            <description>
              <p>
                This widgets displays the life-cycle state and version 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>
                    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 widgets 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>
            <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/single_tasks_widget_template.xhtml
          </property>
        </widgetType>

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>
        <title>Actions (lock, restore version)</title>
        <description>
          <p>
            This widgets 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>
        <title>Custom actions</title>
        <description>
          <p>This widgets 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>
        </categories>
        <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>display</widget>
                </row>
              </rows>
              <widget name="category" type="text">
                <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>
              </widget>
              <widget name="display" type="selectOneListbox">
                <labels>
                  <label mode="any">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>
                  <field>display</field>
                </fields>
                <selectOptions>
                  <option itemLabel="Icons and links" itemValue=""/>
                  <option itemLabel="Icons" itemValue="icons"/>
                  <option itemLabel="Buttons" itemValue="buttons"/>
                  <option itemLabel="Links" itemValue="links"/>
                </selectOptions>
              </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 widgets displays the description 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>
        <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 widgets 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>
        <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 widgets 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>
        <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 widgets 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>
        <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 widgets displays the tags for the currentDocument and allow to
          add new ones. This widgets requires the tag service to be deployed.
        </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/tagging_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="summary_current_document_relations">
      <configuration>
        <sinceVersion>5.3.1</sinceVersion>
        <title>Relations</title>
        <description>
          This widgets displays the in/out relations for the currentDocument.
          This widgets requires the Relation service to be deployed.
        </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/relations_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="summary_current_document_comments">
      <configuration>
        <sinceVersion>5.3.1</sinceVersion>
        <title>Comments</title>
        <description>
          This widgets displays the comments for the currentDocument. This
          widgets requires the Comment service to be deployed.
        </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/comments_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="summary_current_document_publications">
      <configuration>
        <sinceVersion>5.3.1</sinceVersion>
        <title>Publications</title>
        <description>
          This widgets displays the publications of the currentDocument. This
          widgets requires the Publisher service to be deployed.
        </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/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 widgets displays the life-cycle state and version 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>
                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 widgets 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>
        <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/single_tasks_widget_template.xhtml
      </property>
    </widgetType>

  </extension>