Interface AttributeWidget

All Known Subinterfaces:
AttributeEditor, AttributePresenter<T>, AttributeWebWidget

public interface AttributeWidget
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    The widget type determines where it is suitable to place the widget.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a universally unique id for widgets of this kind.
    Returns a displayable name in the current default locale or if a name is not available in that locale, a default displayable name.
    Returns a set of the supported widget types that this widget has.
    boolean
    Returns true if the values of the given data type can be handled by this widget, false otherwise.
  • Method Details

    • isSupported

      boolean isSupported(AttributeDataType type)
      Returns true if the values of the given data type can be handled by this widget, false otherwise.
      Parameters:
      type - The type in question
      Returns:
      True if the values of the given data type can be handled by this widget, false otherwise.
    • getName

      String getName()
      Returns a displayable name in the current default locale or if a name is not available in that locale, a default displayable name.
      Returns:
      a best effort localized name.
    • getID

      String getID()
      Returns a universally unique id for widgets of this kind. (Not a unique id per instance, but per class.)
      Returns:
      A universally unique id.
    • getSupportedWidgetTypes

      Set<AttributeWidget.WidgetType> getSupportedWidgetTypes()
      Returns a set of the supported widget types that this widget has. Returning an empty set results in undefined behaviour.
      Returns:
      a set of supported widget types.