Package com.broadleafcommerce.metadata.dsl.core.extension

Interface Selectable<S extends Selectable<S>>

All Superinterfaces:
Comparable<S>, Component<S>, Copyable<S>, Serializable
All Known Subinterfaces:
EntityGridView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGridExternal<E>, FieldArrayGridField<F>, GridExternal<E>, GridView<V>, Orderable<R>, ResidentGridField<F>, SelectTargetEntityGridView<V>, TreeGridView<V>
All Known Implementing Classes:
DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultFieldArrayGridField, DefaultGridExternal, DefaultResidentGridField, DefaultSelectTargetEntityGridView, DefaultTreeGridView
public interface Selectable<S extends Selectable<S>> extends Component<S>
An interface implemented by components that intend to support selectable behavior.
Author:
Nick Crum (ncrum)

  • Method Details

    • selectable

      default S selectable(Selectable.ConfigureSelectable fn)
      Configure selection behavior for the component. This is generally used with a lambda function, for example: 
       grid.selectable(selectable -> selectable.multipleSelection());
      Parameters:
      fn - the function to configure the selectable component
      Returns:
      the selectable

    • selectable

      default S selectable(boolean isSelectable)
      Sets whether or not the component supports selectable behavior.
      Parameters:
      isSelectable - is selectable or not
      Returns:
      the selectable

    • selectable

      default S selectable()
      Configure the component with the default selectable behavior, i.e. single-select.
      Returns:
      the selectable

    • notSelectable

      default S notSelectable()
      Disabled selectable behavior for the component.
      Returns:
      the selectable

    • selectableType

      default S selectableType(String selectableType)
      Sets the selectable type to indicate the type of selectable behavior supported.
      Parameters:
      selectableType - the type, usually one of Selectable.SelectableTypes
      Returns:
      the configurer

    • singleSelectable

      default S singleSelectable()
      Configure the component with single selection behavior.
      Returns:
      the selectable

    • multipleSelectable

      default S multipleSelectable()
      Configure the component with multiple selection behavior.
      Returns:
      the selectable

    • multiPageSelectable

      default S multiPageSelectable()
      Configure the component with multi-page selection behavior.
      Returns:
      the selectable

    • multiPageSelectableWithExclusions

      default S multiPageSelectableWithExclusions()
      Configure the component with multi-page selection with exclusions behavior.
      Returns:
      the selectable

    • selectableWhenMutableOnly

      default S selectableWhenMutableOnly(boolean whenMutableOnly)
      Configure the component so that the line items are only selectable when the entity they represent is mutable. In other words, this will only disable selection of immutable items and mutable items in the same grid will still be selectable.
      Parameters:
      whenMutableOnly - true to make the component selectable only when mutable, false otherwise
      Returns:
      the selectable
      Since:
      Metadata Service 2.0.8, Release Train 2.3.0

    • selectableWhenMutableOnly

      default S selectableWhenMutableOnly()
      Enable selectable-when-mutable-only behavior.
      Returns:
      the selectable
      Since:
      Metadata Service 2.0.8, Release Train 2.3.0

    • notSelectableWhenMutableOnly

      default S notSelectableWhenMutableOnly()
      Disable selectable-when-mutable-only behavior.
      Returns:
      the selectable
      Since:
      Metadata Service 2.0.8, Release Train 2.3.0