Platform Explorer / Nuxeo Platform LTS 2015 7.10

Component org.nuxeo.ecm.platform.actions.widgettypes

Services

Extension points

Contributions

XML source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.platform.actions.widgettypes">

  <extension target="org.nuxeo.ecm.platform.forms.layout.LayoutStore"
    point="widgets">

    <widget name="actions_headerStyleClass" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Header style class</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Style class for the header, displaying this
          widget
          label.
        </label>
      </helpLabels>
      <fields>
        <field>headerStyleClass</field>
      </fields>
    </widget>

    <widget name="actions_styleClass" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Style class</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Style class for the global container div.
        </label>
      </helpLabels>
      <fields>
        <field>styleClass</field>
      </fields>
    </widget>

    <widget name="actions_actionStyleClass" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Action style class</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Style class for each action link.
        </label>
      </helpLabels>
      <fields>
        <field>actionStyleClass</field>
      </fields>
    </widget>

    <widget name="actions_addForm" type="checkbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Add form</label>
      </labels>
      <helpLabels>
        <label mode="any">
          If set to true, actions will be surrounded
          by a form,
          so there should be no other surrounding form.
          This property is useful
          when fancybox actions need to open a
          popup in another form. Available
          since 5.7, defaults to false.
        </label>
      </helpLabels>
      <fields>
        <field>addForm</field>
      </fields>
    </widget>

    <widget name="actions_useAjaxForm" type="checkbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Use ajax actions</label>
      </labels>
      <helpLabels>
        <label mode="any">
          If set to true, actions will be performed
          using ajax.
          Note that sometimes, selection actions will
          require you to reload the
          whole page for other elements than
          the content view to be re-rendered,
          so using ajax will not
          be user friendly in these cases. Available from
          5.7, defaults to false.
        </label>
      </helpLabels>
      <fields>
        <field>useAjaxForm</field>
      </fields>
    </widget>

    <widget name="actions_disableFiltered" type="checkbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Disable filtered actions</label>
      </labels>
      <helpLabels>
        <label mode="any">
          If set to true, actions will appear as disabled if
          they are supposed to be filtered (instead of not being displayed at
          all). Available from 5.7, defaults to false.
        </label>
      </helpLabels>
      <fields>
        <field>disableFiltered</field>
      </fields>
    </widget>

    <widget name="actions_category" type="selectOneResource">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Category</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The category of actions to use.
        </label>
      </helpLabels>
      <fields>
        <field>category</field>
      </fields>
      <widgetModes>
        <mode value="edit_demo_preview">hidden</mode>
      </widgetModes>
      <properties widgetMode="edit">
        <property name="required">true</property>
      </properties>
      <properties mode="any">
        <property name="resourceName">actionCategories</property>
      </properties>
    </widget>

    <widget name="tabs_category" type="selectOneResource">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Category</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The category of tabs to use.
        </label>
      </helpLabels>
      <fields>
        <field>category</field>
      </fields>
      <widgetModes>
        <mode value="edit_demo_preview">hidden</mode>
      </widgetModes>
      <properties widgetMode="edit">
        <property name="required">true</property>
      </properties>
      <properties mode="any">
        <property name="resourceName">tabCategories</property>
      </properties>
    </widget>

    <widget name="actions_actionId" type="selectOneResource">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Action</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action to display.
        </label>
      </helpLabels>
      <fields>
        <field>actionId</field>
      </fields>
      <widgetModes>
        <mode value="edit_demo_preview">hidden</mode>
      </widgetModes>
      <properties widgetMode="edit">
        <property name="required">true</property>
      </properties>
      <properties mode="any">
        <property name="resourceName">actions</property>
      </properties>
    </widget>

    <widget name="actions_overallDisplay" type="selectOneListbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Overall display</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Overall display of actions.
        </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" />
        <option itemLabel="Rollover menu" itemValue="rollover_menu" />
      </selectOptions>
    </widget>

    <widget name="tabs_overallDisplay" type="selectOneListbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Overall display</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Overall display of tabs.
        </label>
      </helpLabels>
      <fields>
        <field>overallDisplay</field>
      </fields>
      <selectOptions>
        <option itemLabel="Horizontal block (default)" itemValue="" />
        <option itemLabel="Vertical block" itemValue="vertical_block" />
      </selectOptions>
    </widget>

    <widget name="tabs_link_pattern" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Link Pattern</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The document pattern to use for tabs links (optional). Available since 8.1.
        </label>
      </helpLabels>
      <fields>
        <field>pattern</field>
      </fields>
    </widget>

    <widget name="tabs_link_view" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Link View</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The document pattern to use for tabs links (optional). Available since 8.1.
        </label>
      </helpLabels>
      <fields>
        <field>view</field>
      </fields>
    </widget>

    <widget name="tabs_hideSingleTab" type="checkbox">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Hide single tab</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Boolean stating if the tabs bar should be hidden in case there is only one tab.
          Defaults to false, available since 6.0.
        </label>
      </helpLabels>
      <fields>
        <field>hideSingleTab</field>
      </fields>
    </widget>

    <widget name="actions_maxActionsNumber" type="int">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <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.
        </label>
      </helpLabels>
      <fields>
        <field>maxActionsNumber</field>
      </fields>
    </widget>

    <widget name="actions_moreMenuLabel" type="text">
      <categories>
        <category>widgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Label for the "more" menu</label>
      </labels>
      <fields>
        <field>moreMenuLabel</field>
      </fields>
    </widget>

  </extension>

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

    <widgetType name="actions">
      <configuration>
        <sinceVersion>5.6</sinceVersion>
        <title>Actions</title>
        <description>
          <p>This widget displays actions.</p>
          <p>
            It needs the list of actions as property "actions".
            <br />
            Its bound value is used for actions with type "widget".
          </p>
        </description>
        <categories>
          <category>hidden</category>
        </categories>
        <fields>
          <defaultConfiguration>
            <field></field>
          </defaultConfiguration>
        </fields>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <properties>
          <layouts mode="any">
            <layout name="actions_widget_type_properties_any">
              <rows>
                <row>
                  <widget>actions</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actionsDisplay</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_overallDisplay</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_maxActionsNumber</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_styleClass</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_moreMenuLabel</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_addForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_useAjaxForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">ajaxReRender</widget>
                </row>
              </rows>
              <widget name="actions" type="actions">
                <labels>
                  <label mode="any">Actions</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The list of actions to display.
                  </label>
                </helpLabels>
                <fields>
                  <field>actions</field>
                </fields>
                <widgetModes>
                  <mode value="edit_demo_preview">hidden</mode>
                </widgetModes>
              </widget>
            </layout>
          </layouts>
        </properties>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/actions/actions_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="action">
      <configuration>
        <sinceVersion>5.7</sinceVersion>
        <title>Action</title>
        <description>
          <p>This widget displays an action.</p>
          <p>
            It needs the action as property "action".
            <br />
            Its bound value is used for actions with type "widget".
            <br />
            It can add a form around its button to handle actions with type
            "fancybox" that would need a form in their opened fancybox content.
          </p>
        </description>
        <categories>
          <category>hidden</category>
        </categories>
        <fields>
          <defaultConfiguration>
            <field></field>
          </defaultConfiguration>
        </fields>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <properties>
          <layouts mode="any">
            <layout name="action_widget_type_properties_any">
              <rows>
                <row>
                  <widget>action</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actionsDisplay</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_styleClass</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_addForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_useAjaxForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">ajaxReRender</widget>
                </row>
              </rows>
              <widget name="action" type="action">
                <labels>
                  <label mode="any">Action</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The action to display.
                  </label>
                </helpLabels>
                <fields>
                  <field>action</field>
                </fields>
                <widgetModes>
                  <mode value="edit_demo_preview">hidden</mode>
                </widgetModes>
              </widget>
            </layout>
          </layouts>
        </properties>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/actions/action_widget_template.xhtml
      </property>
    </widgetType>

    <widgetType name="tabs">
      <configuration>
        <sinceVersion>5.7</sinceVersion>
        <title>Tabs</title>
        <description>
          <p>This widget displays tabs.</p>
          <p>
            It needs the list of actions as property "actions".
            <br />
            Its bound value is used for actions with type "widget".
          </p>
        </description>
        <categories>
          <category>hidden</category>
        </categories>
        <fields>
          <defaultConfiguration>
            <field></field>
          </defaultConfiguration>
        </fields>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <properties>
          <layouts mode="any">
            <layout name="tabs_widget_type_properties_any">
              <rows>
                <row>
                  <widget>actions</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_addForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_useAjaxForm</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">ajaxReRender</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actionsDisplay</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">actions_styleClass</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">tabs_overallDisplay</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">tabs_link_view</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">tabs_link_pattern</widget>
                </row>
                <row>
                  <widget category="widgetTypeConf">tabs_hideSingleTab</widget>
                </row>
              </rows>
              <widget name="actions" type="actions">
                <labels>
                  <label mode="any">Actions</label>
                </labels>
                <helpLabels>
                  <label mode="any">
                    The list of actions to display.
                  </label>
                </helpLabels>
                <fields>
                  <field>actions</field>
                </fields>
                <widgetModes>
                  <mode value="edit_demo_preview">hidden</mode>
                </widgetModes>
              </widget>
            </layout>
          </layouts>
        </properties>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.forms.layout.facelets.plugins.TemplateWidgetTypeHandler
      </handler-class>
      <property name="template">
        /widgets/actions/tabs_widget_template.xhtml
      </property>
    </widgetType>

  </extension>

</component>

Documentation