Platform Explorer / Nuxeo Platform 5.6

Contribution org.nuxeo.ecm.platform.faceted.search.widgets--widgettypes

This contribution is part of XML component org.nuxeo.ecm.platform.faceted.search.widgets inside nuxeo-platform-faceted-search-jsf-5.6.jar

Extension point

Extension point widgettypes of component WebLayoutManager.

Contributed items

  • <widgetType name="date_range">
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <documentation>Widget used to search on a date range.</documentation>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/date_range_widget_template.xhtml
          </property>
        </widgetType>

    Widget used to search on a date range.

  • <widgetType name="faceted_search_users_suggestion">
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <documentation>
            Widget allowing to search and select one or more users with a suggestion
            box.
          </documentation>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/user_suggestion_widget_template.xhtml
          </property>
        </widgetType>

    Widget allowing to search and select one or more users with a suggestion box.

  • <widgetType name="faceted_search_wrapper">
          <documentation>
            Template widget dedicated to wrap other sub widgets. It displays the
            widget label, and list the sub widgets below according to the
            wrapperMode. The sub widgets can use 3 wrapperMode (to be defined in the
            sub widget properties): - row: the sub widget label is displayed on one
            row, and the sub widget content on another row. - column: the sub widget
            label and content are displayed on the same row - noLabel: the sub
            widget label is not displayed at all.
          </documentation>
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/faceted_search_wrapper_widget_template.xhtml
          </property>
        </widgetType>

    Template widget dedicated to wrap other sub widgets. It displays the widget label, and list the sub widgets below according to the wrapperMode. The sub widgets can use 3 wrapperMode (to be defined in the sub widget properties): - row: the sub widget label is displayed on one row, and the sub widget content on another row. - column: the sub widget label and content are displayed on the same row - noLabel: the sub widget label is not displayed at all.

  • <widgetType name="faceted_searches_selector">
          <documentation>
            Widget displaying all the registered faceted searches. Hidden in case
            only one faceted search is registered.
          </documentation>
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/faceted_searches_selector_widget_template.xhtml
          </property>
        </widgetType>

    Widget displaying all the registered faceted searches. Hidden in case only one faceted search is registered.

  • <widgetType name="saved_faceted_searches_selector">
          <documentation>
            Widget displaying all the saved faceted searches. It displays 2
            categories: - Your searches: your saved faceted searches - All searches:
            all the other users shared saved faceted searches.
    
            The "outcome" property needs to be defined: on which JSF view should we
            redirect after selecting a saved search.
          </documentation>
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/saved_faceted_searches_selector_widget_template.xhtml
          </property>
        </widgetType>

    Widget displaying all the saved faceted searches. It displays 2 categories: - Your searches: your saved faceted searches - All searches: all the other users shared saved faceted searches.

    The "outcome" property needs to be defined: on which JSF view should we redirect after selecting a saved search.

  • <widgetType name="faceted_search_directory_tree">
          <documentation>
            Widget allowing to select one or more values from a Tree constructed
            from the directory tree specified in the directoryTreeName property.
            <code>
              <widget name="dc_coverage" type="faceted_search_directory_tree">
                <labels>
                  <label mode="any">label.faceted.search.coverage</label>
                </labels>
                <translated>true</translated>
                <fields>
                  <field>fsd:dc_coverage</field>
                </fields>
                <properties widgetMode="any">
                  <property name="directoryTreeName">byCoverageNavigation</property>
                  <property name="wrapperMode">noLabel</property>
                </properties>
              </widget>
            </code>
          </documentation>
          <configuration>
            <categories>
              <category>configuration_not_ready</category>
            </categories>
          </configuration>
          <handler-class>
            org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
          </handler-class>
          <property name="template">
            /widgets/faceted_search_directory_tree_widget_template.xhtml
          </property>
        </widgetType>

    Widget allowing to select one or more values from a Tree constructed from the directory tree specified in the directoryTreeName property.

              <widget name="dc_coverage" type="faceted_search_directory_tree">
                <labels>
                  <label mode="any">label.faceted.search.coverage</label>
                </labels>
                <translated>true</translated>
                <fields>
                  <field>fsd:dc_coverage</field>
                </fields>
                <properties widgetMode="any">
                  <property name="directoryTreeName">byCoverageNavigation</property>
                  <property name="wrapperMode">noLabel</property>
                </properties>
              </widget>
    

XML source

<extension point="widgettypes" target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager">

    <widgetType name="date_range">
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <documentation>Widget used to search on a date range.</documentation>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/date_range_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="faceted_search_users_suggestion">
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <documentation>
        Widget allowing to search and select one or more users with a suggestion
        box.
      </documentation>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/user_suggestion_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="faceted_search_wrapper">
      <documentation>
        Template widget dedicated to wrap other sub widgets. It displays the
        widget label, and list the sub widgets below according to the
        wrapperMode. The sub widgets can use 3 wrapperMode (to be defined in the
        sub widget properties): - row: the sub widget label is displayed on one
        row, and the sub widget content on another row. - column: the sub widget
        label and content are displayed on the same row - noLabel: the sub
        widget label is not displayed at all.
      </documentation>
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/faceted_search_wrapper_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="faceted_searches_selector">
      <documentation>
        Widget displaying all the registered faceted searches. Hidden in case
        only one faceted search is registered.
      </documentation>
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/faceted_searches_selector_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="saved_faceted_searches_selector">
      <documentation>
        Widget displaying all the saved faceted searches. It displays 2
        categories: - Your searches: your saved faceted searches - All searches:
        all the other users shared saved faceted searches.

        The "outcome" property needs to be defined: on which JSF view should we
        redirect after selecting a saved search.
      </documentation>
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/saved_faceted_searches_selector_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="faceted_search_directory_tree">
      <documentation>
        Widget allowing to select one or more values from a Tree constructed
        from the directory tree specified in the directoryTreeName property.
        <code>
          <widget name="dc_coverage" type="faceted_search_directory_tree">
            <labels>
              <label mode="any">label.faceted.search.coverage</label>
            </labels>
            <translated>true</translated>
            <fields>
              <field>fsd:dc_coverage</field>
            </fields>
            <properties widgetMode="any">
              <property name="directoryTreeName">byCoverageNavigation</property>
              <property name="wrapperMode">noLabel</property>
            </properties>
          </widget>
        </code>
      </documentation>
      <configuration>
        <categories>
          <category>configuration_not_ready</category>
        </categories>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/faceted_search_directory_tree_widget_template.xhtml
      </property>
    </widgetType>
  </extension>