Package io.jmix.flowui.facet.settings

Interface Settings

All Known Implementing Classes:
DataGridSettings, GenericFilterSettings, JmixDetailsSettings, KanbanSettings, PivotTableSettings, SimplePaginationSettings, TreeDataGridSettings
public interface Settings
Base interface for POJO classes that describe component settings.

See DataGridSettings as an example.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T extends Settings>
    T
    as()
    The convenient method for casting current object to specific settings class.
    String
    getId()
     
    void
    setId(String id)
    Sets an id of settings.

  • Method Details

    • getId

      @Nullable String getId()
      Returns:
      id of settings or null if not set

    • setId

      void setId(@Nullable String id)
      Sets an id of settings.
      Parameters:
      id - id to set

    • as

      default <T extends Settings> T as()
      The convenient method for casting current object to specific settings class.
      Type Parameters:
      T - type of settings
      Returns:
      this object that is cast to specific settings class