Package org.nuxeo.ecm.platform.forms.layout.api

Interface WidgetDefinition

All Superinterfaces:
Serializable
All Known Implementing Classes:
WidgetDefinitionImpl
public interface WidgetDefinition extends Serializable
Widget definition interface.

A widget knows how to render itself in a given mode.

Author:
Anahide Tchertchian

  • Field Details

  • Method Details

    • getName

      String getName()
      Returns the widget name used to identify it within a layout.

    • setName

      void setName(String name)
      Since:
      5.5

    • getType

      String getType()
      Returns the widget type used to render it.

    • setType

      void setType(String type)
      Since:
      5.5

    • getTypeCategory

      String getTypeCategory()
      Returns the type category to use when retrieving the corresponding widget type.
      Since:
      5.7.3

    • setTypeCategory

      void setTypeCategory(String typeCat)
      Sets the type category to use when retrieving the corresponding widget type.
      Since:
      5.7.3

    • getFieldDefinitions

      FieldDefinition[] getFieldDefinitions()
      Returns the list of fields managed by this widget.

    • setFieldDefinitions

      void setFieldDefinitions(FieldDefinition[] fieldDefinitions)
      Since:
      5.5

    • getMode

      String getMode(String layoutMode)
      Returns the optional mode used to override the layout mode.

      Can be a string or an EL ValueExpression.

      Parameters:
      layoutMode - the layout (or parent widget) mode
      Returns:
      the overriding widget mode or null if none is defined.

    • getModes

      Map<String,String> getModes()

    • setModes

      void setModes(Map<String,String> modes)
      Since:
      5.5

    • getRequired

      String getRequired(String layoutMode, String mode)
      Returns an EL expression evaluating to true if the widget is required in given mode.

      This value is computed from the property "required" in given mode. and can be a string or an EL ValueExpression. Defaults to "false".

    • getLabel

      String getLabel(String mode)
      Returns the label to use in a given mode.

    • getLabels

      Map<String,String> getLabels()
      Returns labels by mode.

    • setLabels

      void setLabels(Map<String,String> labels)
      Since:
      5.5

    • getHelpLabel

      String getHelpLabel(String mode)
      Returns the help label to use in a given mode.

    • getHelpLabels

      Map<String,String> getHelpLabels()
      Returns help labels by mode.

    • setHelpLabels

      void setHelpLabels(Map<String,String> helpLabels)
      Since:
      5.5

    • isTranslated

      boolean isTranslated()
      Returns true if all labels are messages that need to be translated.

      Defaults to true.

    • setTranslated

      void setTranslated(boolean translated)
      Since:
      5.5
      See Also:

    • getProperties

      Map<String,Serializable> getProperties(String layoutMode, String mode)
      Returns a map of properties to use in a given mode.

      A property value can be a string or an EL ValueExpression.

      The way that properties will be mapped to rendered components is managed by the widget type.

    • getProperties

      Map<String,Map<String,Serializable>> getProperties()
      Returns properties by mode.

    • setProperties

      void setProperties(Map<String,Map<String,Serializable>> properties)
      Since:
      5.5

    • getWidgetModeProperties

      Map<String,Map<String,Serializable>> getWidgetModeProperties()
      Returns properties by widget mode.

    • setWidgetModeProperties

      void setWidgetModeProperties(Map<String,Map<String,Serializable>> properties)
      Since:
      5.5

    • getControls

      Map<String,Serializable> getControls(String layoutMode, String mode)
      Returns controls for given mode.
      Since:
      5.7
      See Also:

    • getControls

      Map<String,Map<String,Serializable>> getControls()
      Returns controls by mode.

      Controls are property-like markers on widget instances, expect these are not forwarded to the underlying rendering object (like the JSF component attributes).

      This makes it possible to keep "flags" on widgets that can be checked by parent widget or layout, for instance "addForm" or "handlingLabels" markers.

      Since:
      5.7

    • setControls

      void setControls(Map<String,Map<String,Serializable>> controls)
      Sets controls by mode on widget definition.
      Since:
      5.7

    • getSubWidgetDefinitions

      WidgetDefinition[] getSubWidgetDefinitions()
      Returns sub widget definitions.

    • setSubWidgetDefinitions

      void setSubWidgetDefinitions(WidgetDefinition[] subWidgets)
      Since:
      5.5

    • getSubWidgetReferences

      WidgetReference[] getSubWidgetReferences()
      Returns sub widget definitions references.
      Since:
      5.6

    • setSubWidgetReferences

      void setSubWidgetReferences(WidgetReference[] subWidgets)
      Since:
      5.6

    • getSelectOptions

      WidgetSelectOption[] getSelectOptions()
      Returns the select options for this widget.
      Since:
      5.4.2

    • setSelectOptions

      void setSelectOptions(WidgetSelectOption[] selectOptions)
      Since:
      5.5

    • getRenderingInfos

      Map<String,List<RenderingInfo>> getRenderingInfos()
      Returns the map of rendering information per mode.

      Useful for preview management where some configuration needs to be changed: what's changed can be set as rendering information here to be displayed.

      Since:
      5.5

    • getRenderingInfos

      List<RenderingInfo> getRenderingInfos(String mode)
      Returns the list of rendering information for given mode.
      Since:
      5.5

    • setRenderingInfos

      void setRenderingInfos(Map<String,List<RenderingInfo>> renderingInfos)
      Since:
      5.5

    • getAliases

      List<String> getAliases()
      Return alias names for this widget definition (useful for compatibility on old widget names).
      Since:
      6.0

    • isGlobal

      boolean isGlobal()
      Returns true if the widget is defined globally (as opposed to being held by a layout definition).
      Since:
      6.0

    • setGlobal

      void setGlobal(boolean global)
      Sets the global status on this definition, depending on how it's been retrievd by the service.
      Since:
      6.0

    • isDynamic

      boolean isDynamic()
      Returns true if this widget was generated from configuration on a service, and not generated on-the-fly using dynamic behaviors.
      Since:
      6.0

    • clone

      WidgetDefinition clone()
      Returns a clone instance of this widget definition.

      Useful for conversion of widget definition during export.

      Since:
      5.5