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

Interface TileGrid<G extends TileGrid<G>>

All Superinterfaces:
Comparable<G>, Component<G>, Copyable<G>, CustomCssComponent<G>, FetchGrid<G>, Grid<G>, Serializable
All Known Subinterfaces:
EntityGridView<V>, ExportHistoryEntityGridView<V>
All Known Implementing Classes:
DefaultEntityGridView, DefaultExportHistoryEntityGridView
public interface TileGrid<G extends TileGrid<G>> extends FetchGrid<G>
Interface for a TileGrid, which is a grid that supports tiling of components.
Since:
Metadata Service 2.0.7, Release Train 2.3.0
Author:
Jon Fleschler (jfleschler)

  • Method Details

    • tiled

      default G tiled()
      Marks this grid to show the tile view.
      Returns:
      this

    • tiled

      default G tiled(Collection<TileComponent<?>> components)
      Marks this grid to show the tile view with the specified components.
      Parameters:
      components - the components to be displayed in the tile view
      Returns:
      this

    • notTiled

      default G notTiled()
      Marks this grid to not show the tile view.
      Returns:
      the updated grid with the tiled attribute removed

    • tileComponents

      default G tileComponents(Collection<TileComponent<?>> components)
      Sets the tile components for this grid. This is a convenience method that allows you to set the tile components directly.
      Parameters:
      components - the collection of tile components to set
      Returns:
      this

    • addTileComponent

      default G addTileComponent(String name, TileComponent<?> component)
      A convenience method to add a new tile component to the grid.
      Parameters:
      component - the tile component to add
      Returns:
      the updated grid with the new tile component added

    • addTileComponent

      default G addTileComponent(TileComponent<?> component)
      A convenience method to add a new tile component to the grid.
      Parameters:
      component - the tile component to add
      Returns:
      the updated grid with the new tile component added

    • defaultTiled

      default G defaultTiled()
      Marks this grid to show the tile view by default.
      Returns:
      the updated grid with the default tiled attribute set

    • notDefaultTiled

      default G notDefaultTiled()
      Marks this grid to not show the tile view by default.
      Returns:
      the updated grid with the default tiled attribute removed

    • configureTileComponents

      default G configureTileComponents(UnaryOperator<List<TileComponent<?>>> fn)
      Configure the list of tile components this grid will display. This provides a List of TileComponent which can be modified to configure the list of components. The list returned will be sorted according to the order of the members.
      Parameters:
      fn - the function to configure the list
      Returns:
      this