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

Interface Orderable<R extends Orderable<R>>

All Superinterfaces:
ActionGrid<R>, Comparable<R>, Component<R>, Copyable<R>, CustomCssComponent<R>, Grid<R>, Selectable<R>, Serializable
All Known Subinterfaces:
ExportHistoryGridExternal<E>, FieldArrayGridField<F>, GridExternal<E>, ResidentGridField<F>
All Known Implementing Classes:
DefaultExportHistoryGridExternal, DefaultFieldArrayGridField, DefaultGridExternal, DefaultResidentGridField
public interface Orderable<R extends Orderable<R>> extends ActionGrid<R>, Selectable<R>, Component<R>
Represents the metadata for a collection component that supports re-ordering it's members.

An orderable collection is one whose members support a fixed sort ordering. This sort order is able to be managed by configuring the collection as orderable.

If configured as orderable(), it is required that the orderable action and endpoint are configured as well. If not, this collection will fail validation and not properly support the orderable behaviors.

Author:
Nick Crum (ncrum)

  • Method Details

    • isOrderable

      default boolean isOrderable()
      Returns whether or not this component is marked as orderable.
      Returns:
      true if orderable, false if not

    • orderable

      default R orderable(boolean isOrderable)

    • orderable

      default R orderable()

    • notOrderable

      default R notOrderable()

    • orderable

      default R orderable(UnaryOperator<Orderable<?>> fn)

    • addOrderableAction

      default R addOrderableAction(OrderableModalFormAction<?> action)

    • orderableAction

      default R orderableAction(UnaryOperator<OrderableModalFormAction<?>> fn)

    • getOrderableAction

      default OrderableModalFormAction<?> getOrderableAction()

    • findOrderableAction

      default Optional<OrderableModalFormAction<?>> findOrderableAction()

    • orderableEndpoint

      default R orderableEndpoint(Endpoint<?> endpoint)

    • orderableEndpoint

      default R orderableEndpoint(UnaryOperator<Endpoint<?>> fn)

    • orderableUrl

      default R orderableUrl(String url)

    • orderableScope

      default R orderableScope(String scope)

    • orderableUrl

      default R orderableUrl(String url, String scope)

    • getOrderableEndpoint

      default Endpoint<?> getOrderableEndpoint()

    • findOrderableEndpoint

      default Optional<Endpoint<?>> findOrderableEndpoint()

    • disableDragIfAllUnsorted

      default R disableDragIfAllUnsorted(boolean isDisableDragIfAllUnsorted)
      Sets whether or not drag-and-drop reordering is disabled if all records are unsorted. If set to true, this will disable drag-and-drop until at least one record is sorted.
      Parameters:
      isDisableDragIfAllUnsorted - whether or not to disable
      Returns:
      the orderable

    • disableDragIfAllUnsorted

      default R disableDragIfAllUnsorted()

    • enableDragIfAllUnsorted

      default R enableDragIfAllUnsorted()