Platform Explorer / Nuxeo Platform LTS 2015 7.10

Contribution org.nuxeo.ecm.platform.actions.actionwidgettypes--widgets

This contribution is part of XML component org.nuxeo.ecm.platform.actions.actionwidgettypes inside nuxeo-platform-actions-jsf-7.10-HF04.jar /OSGI-INF/action-widgettypes-contrib.xml

Extension point

Extension point widgets of component LayoutStore.

Contributed items

  • <widget name="label" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Label</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action label.
            </label>
          </helpLabels>
          <fields>
            <field>label</field>
          </fields>
        </widget>
  • <widget name="icon" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">icon</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action icon path. Example:
              "/icons/contextual_menu/share.png".
            </label>
          </helpLabels>
          <fields>
            <field>icon</field>
          </fields>
        </widget>
  • <widget name="help" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">help</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action help, displayed in a tooltip.
            </label>
          </helpLabels>
          <fields>
            <field>help</field>
          </fields>
        </widget>
  • <widget name="accessKey" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">accessKey</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action access key.
            </label>
          </helpLabels>
          <fields>
            <field>accessKey</field>
          </fields>
        </widget>
  • <widget name="immediate" type="checkbox">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Immediate</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Boolean stating if the action is immediate (called
              during JSF "apply request value" phase instead of the "process
              validations" phase), useful for "cancel" buttons that should not issue
              a validation error for required fields.
            </label>
          </helpLabels>
          <fields>
            <field>immediate</field>
          </fields>
        </widget>
  • <widget name="ajaxReRender" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Ajax reRender</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Ajax rerender ids, separated by commas, used in
              combination with the "ajaxSupport" property.
            </label>
          </helpLabels>
          <fields>
            <field>ajaxReRender</field>
          </fields>
        </widget>
  • <widget name="ajaxSupport" type="checkbox">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Ajax support</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Boolean stating if the action supports ajax. Mandatory
              for this action to be ajaxified when caller asks for an ajax form to
              be used. Default value depends on the action type policy.
            </label>
          </helpLabels>
          <fields>
            <field>ajaxSupport</field>
          </fields>
        </widget>
  • <widget name="styleClass" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Style class</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action style class.
            </label>
          </helpLabels>
          <fields>
            <field>styleClass</field>
          </fields>
        </widget>
  • <widget name="target" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Target</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The action target, for instance "_blank".
            </label>
          </helpLabels>
          <fields>
            <field>target</field>
          </fields>
        </widget>
  • <widget name="onclick" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Onclick</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Javascript code to call when clicking on the action.
            </label>
          </helpLabels>
          <fields>
            <field>onclick</field>
          </fields>
        </widget>
  • <widget name="confirm" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Confirm</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Javascript confirmation code, called when clicking on
              the action.
            </label>
          </helpLabels>
          <fields>
            <field>confirm</field>
          </fields>
        </widget>
  • <widget name="confirmMessage" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Confirm message</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Alternative to the "confirm" property, only stating
              the confirmation message, that can be a message to translate.
            </label>
          </helpLabels>
          <fields>
            <field>confirmMessage</field>
          </fields>
        </widget>
  • <widget name="confirmMessageArgs" type="list">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Confirm message arguments</label>
          </labels>
          <fields>
            <field>confirmMessageArgs</field>
          </fields>
          <helpLabels>
            <label mode="any">
              Confirm message arguments, referenced by the confirm
              message translation in messages.properties files.
            </label>
          </helpLabels>
          <properties widgetMode="any">
            <property name="hideSubLabels">true</property>
          </properties>
          <subWidgets>
            <widget name="messageArg" type="text">
              <fields>
                <field/>
              </fields>
              <labels>
                <label mode="any"/>
              </labels>
            </widget>
          </subWidgets>
        </widget>
  • <widget name="fancybox_include" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Include</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The template path to show as the fancybox content
              (ignored if property "iframe" is filled). If this template holds a
              form, it should be using the variable "fancyboxFormId" as its form id
              for the fancybox to be reopened on validation error. Example:
              "/incl/bulk_edit_box.xhtml"
            </label>
          </helpLabels>
          <fields>
            <field>include</field>
          </fields>
        </widget>
  • <widget name="fancybox_iframe" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Iframe</label>
          </labels>
          <helpLabels>
            <label mode="any">
              URL to display as the fancybox content. Example:
              "#{'#{'}previewActions.getCurrentDocumentPreviewPopupURL()}"
            </label>
          </helpLabels>
          <fields>
            <field>iframe</field>
          </fields>
        </widget>
  • <widget name="fancybox_width" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Width</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The fancybox width, defaults to "90%".
            </label>
          </helpLabels>
          <fields>
            <field>width</field>
          </fields>
        </widget>
  • <widget name="fancybox_height" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Height</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The fancybox height, defaults to "90%".
            </label>
          </helpLabels>
          <fields>
            <field>height</field>
          </fields>
        </widget>
  • <widget name="fancybox_scrolling" type="selectOneListbox">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Scrolling</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The fancybox scrolling behaviour, used to create or
              hide scrollbars. Defaults to "auto", also accepts 'yes' or 'no'.
            </label>
          </helpLabels>
          <fields>
            <field>scrolling</field>
          </fields>
          <selectOptions>
            <option itemLabel="Auto (default)" itemValue=""/>
            <option itemLabel="Yes" itemValue="yes"/>
            <option itemLabel="No" itemValue="no"/>
          </selectOptions>
        </widget>
  • <widget name="fancybox_autoScale" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Auto scale</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The boolean value stating if the fancybox is scaled to
              fit in viewport. Defaults to "true".
            </label>
          </helpLabels>
          <fields>
            <field>autoScale</field>
          </fields>
        </widget>
  • <widget name="fancybox_autoDimensions" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Auto dimensions</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The boolean value stating if the fancybox is resized
              when the view is changed by ajax actions for instance. Defaults to
              "true". The fancybox should have dimensions for this to work properly.
            </label>
          </helpLabels>
          <fields>
            <field>autoDimensions</field>
          </fields>
        </widget>
  • <widget name="fancybox_modal" type="checkbox">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Modal</label>
          </labels>
          <fields>
            <field>modal</field>
          </fields>
          <helpLabels>
            <label mode="any">
              The boolean value stating if the fancybox is modal and
              cannot be closed when using the escape button, for instance.
              Defaults
              to "false".
            </label>
          </helpLabels>
        </widget>
  • <widget name="fancybox_centerOnScroll" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">centerOnScroll</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The boolean value stating if the fancybox is centered
              while scrolling the page. Defaults to "true".
            </label>
          </helpLabels>
          <fields>
            <field>centerOnScroll</field>
          </fields>
        </widget>
  • <widget name="fancybox_enableEscapeButton" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">enableEscapeButton</label>
          </labels>
          <helpLabels>
            <label mode="any">
              The boolean value stating if the fancybox is closed
              when pressing the escape key. Defaults to "true".
            </label>
          </helpLabels>
          <fields>
            <field>enableEscapeButton</field>
          </fields>
        </widget>
  • <widget name="fancybox_onClosed" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">onClosed</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Javascript code to call when the fancybox is closed.
              Available since 6.0.
            </label>
          </helpLabels>
          <fields>
            <field>onClosed</field>
          </fields>
        </widget>
  • <widget name="rest_document_link_view" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">View</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Specific view to use for the rest document link.
              Available since 6.0.
            </label>
          </helpLabels>
          <fields>
            <field>view</field>
          </fields>
        </widget>
  • <widget name="rest_document_link_pattern" type="text">
          <categories>
            <category>actionWidgetTypeConf</category>
          </categories>
          <labels>
            <label mode="any">Pattern</label>
          </labels>
          <helpLabels>
            <label mode="any">
              Specific pattern to use for the rest document link.
              Available since 6.0.
            </label>
          </helpLabels>
          <fields>
            <field>pattern</field>
          </fields>
        </widget>

XML source

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

    <widget name="label" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Label</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action label.
        </label>
      </helpLabels>
      <fields>
        <field>label</field>
      </fields>
    </widget>

    <widget name="icon" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">icon</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action icon path. Example:
          "/icons/contextual_menu/share.png".
        </label>
      </helpLabels>
      <fields>
        <field>icon</field>
      </fields>
    </widget>

    <!-- not used as of 5.7.3 -->
    <widget name="help" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">help</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action help, displayed in a tooltip.
        </label>
      </helpLabels>
      <fields>
        <field>help</field>
      </fields>
    </widget>

    <!-- not used as of 5.7.3 -->
    <widget name="accessKey" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">accessKey</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action access key.
        </label>
      </helpLabels>
      <fields>
        <field>accessKey</field>
      </fields>
    </widget>

    <widget name="immediate" type="checkbox">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Immediate</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Boolean stating if the action is immediate (called
          during JSF "apply request value" phase instead of the "process
          validations" phase), useful for "cancel" buttons that should not issue
          a validation error for required fields.
        </label>
      </helpLabels>
      <fields>
        <field>immediate</field>
      </fields>
    </widget>

    <widget name="ajaxReRender" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Ajax reRender</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Ajax rerender ids, separated by commas, used in
          combination with the "ajaxSupport" property.
        </label>
      </helpLabels>
      <fields>
        <field>ajaxReRender</field>
      </fields>
    </widget>

    <widget name="ajaxSupport" type="checkbox">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Ajax support</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Boolean stating if the action supports ajax. Mandatory
          for this action to be ajaxified when caller asks for an ajax form to
          be used. Default value depends on the action type policy.
        </label>
      </helpLabels>
      <fields>
        <field>ajaxSupport</field>
      </fields>
    </widget>

    <widget name="styleClass" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Style class</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action style class.
        </label>
      </helpLabels>
      <fields>
        <field>styleClass</field>
      </fields>
    </widget>

    <widget name="target" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Target</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The action target, for instance "_blank".
        </label>
      </helpLabels>
      <fields>
        <field>target</field>
      </fields>
    </widget>

    <widget name="onclick" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Onclick</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Javascript code to call when clicking on the action.
        </label>
      </helpLabels>
      <fields>
        <field>onclick</field>
      </fields>
    </widget>

    <widget name="confirm" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Confirm</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Javascript confirmation code, called when clicking on
          the action.
        </label>
      </helpLabels>
      <fields>
        <field>confirm</field>
      </fields>
    </widget>

    <widget name="confirmMessage" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Confirm message</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Alternative to the "confirm" property, only stating
          the confirmation message, that can be a message to translate.
        </label>
      </helpLabels>
      <fields>
        <field>confirmMessage</field>
      </fields>
    </widget>

    <widget name="confirmMessageArgs" type="list">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Confirm message arguments</label>
      </labels>
      <fields>
        <field>confirmMessageArgs</field>
      </fields>
      <helpLabels>
        <label mode="any">
          Confirm message arguments, referenced by the confirm
          message translation in messages.properties files.
        </label>
      </helpLabels>
      <properties widgetMode="any">
        <property name="hideSubLabels">true</property>
      </properties>
      <subWidgets>
        <widget name="messageArg" type="text">
          <fields>
            <field/>
          </fields>
          <labels>
            <label mode="any"/>
          </labels>
        </widget>
      </subWidgets>
    </widget>

    <widget name="fancybox_include" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Include</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The template path to show as the fancybox content
          (ignored if property "iframe" is filled). If this template holds a
          form, it should be using the variable "fancyboxFormId" as its form id
          for the fancybox to be reopened on validation error. Example:
          "/incl/bulk_edit_box.xhtml"
        </label>
      </helpLabels>
      <fields>
        <field>include</field>
      </fields>
    </widget>

    <widget name="fancybox_iframe" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Iframe</label>
      </labels>
      <helpLabels>
        <label mode="any">
          URL to display as the fancybox content. Example:
          "#{'#{'}previewActions.getCurrentDocumentPreviewPopupURL()}"
        </label>
      </helpLabels>
      <fields>
        <field>iframe</field>
      </fields>
    </widget>

    <widget name="fancybox_width" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Width</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The fancybox width, defaults to "90%".
        </label>
      </helpLabels>
      <fields>
        <field>width</field>
      </fields>
    </widget>

    <widget name="fancybox_height" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Height</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The fancybox height, defaults to "90%".
        </label>
      </helpLabels>
      <fields>
        <field>height</field>
      </fields>
    </widget>

    <widget name="fancybox_scrolling" type="selectOneListbox">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Scrolling</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The fancybox scrolling behaviour, used to create or
          hide scrollbars. Defaults to "auto", also accepts 'yes' or 'no'.
        </label>
      </helpLabels>
      <fields>
        <field>scrolling</field>
      </fields>
      <selectOptions>
        <option itemLabel="Auto (default)" itemValue=""/>
        <option itemLabel="Yes" itemValue="yes"/>
        <option itemLabel="No" itemValue="no"/>
      </selectOptions>
    </widget>

    <widget name="fancybox_autoScale" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Auto scale</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The boolean value stating if the fancybox is scaled to
          fit in viewport. Defaults to "true".
        </label>
      </helpLabels>
      <fields>
        <field>autoScale</field>
      </fields>
    </widget>

    <widget name="fancybox_autoDimensions" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Auto dimensions</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The boolean value stating if the fancybox is resized
          when the view is changed by ajax actions for instance. Defaults to
          "true". The fancybox should have dimensions for this to work properly.
        </label>
      </helpLabels>
      <fields>
        <field>autoDimensions</field>
      </fields>
    </widget>

    <widget name="fancybox_modal" type="checkbox">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Modal</label>
      </labels>
      <fields>
        <field>modal</field>
      </fields>
      <helpLabels>
        <label mode="any">
          The boolean value stating if the fancybox is modal and
          cannot be closed when using the escape button, for instance.
          Defaults
          to "false".
        </label>
      </helpLabels>
    </widget>

    <widget name="fancybox_centerOnScroll" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">centerOnScroll</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The boolean value stating if the fancybox is centered
          while scrolling the page. Defaults to "true".
        </label>
      </helpLabels>
      <fields>
        <field>centerOnScroll</field>
      </fields>
    </widget>

    <widget name="fancybox_enableEscapeButton" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">enableEscapeButton</label>
      </labels>
      <helpLabels>
        <label mode="any">
          The boolean value stating if the fancybox is closed
          when pressing the escape key. Defaults to "true".
        </label>
      </helpLabels>
      <fields>
        <field>enableEscapeButton</field>
      </fields>
    </widget>

    <widget name="fancybox_onClosed" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">onClosed</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Javascript code to call when the fancybox is closed.
          Available since 6.0.
        </label>
      </helpLabels>
      <fields>
        <field>onClosed</field>
      </fields>
    </widget>

    <widget name="rest_document_link_view" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">View</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Specific view to use for the rest document link.
          Available since 6.0.
        </label>
      </helpLabels>
      <fields>
        <field>view</field>
      </fields>
    </widget>

    <widget name="rest_document_link_pattern" type="text">
      <categories>
        <category>actionWidgetTypeConf</category>
      </categories>
      <labels>
        <label mode="any">Pattern</label>
      </labels>
      <helpLabels>
        <label mode="any">
          Specific pattern to use for the rest document link.
          Available since 6.0.
        </label>
      </helpLabels>
      <fields>
        <field>pattern</field>
      </fields>
    </widget>


  </extension>