Interface PageGridPlacement

All Superinterfaces:
Container<Linkable>, HasViewTypeName

public interface PageGridPlacement extends HasViewTypeName, Container<Linkable>
A PageGridPlacement is a part of a whole PageGrid representing for example the sidebar or main column
  • Method Details

    • getContainerMetadata

      @NonNull default List<Object> getContainerMetadata()
      Specified by:
      getContainerMetadata in interface Container<Linkable>
    • getItems

      List<? extends Linkable> getItems()
      Retrieves the items of this PageGridPlacement
      Specified by:
      getItems in interface Container<Linkable>
      Returns:
      a list of items computed for the backing content 'proxy' object
    • getName

      String getName()

      Returns the logical name of this placement.

      "main" is magic for the current content.

    • getPropertyName

      String getPropertyName()
      Return the "virtual" property name of this placement (used for Studio preview integration).
    • getCol

      int getCol()
      Returns the absolute position in the row.

      Count starts with 1.

    • getColspan

      int getColspan()

      Returns the colspan of this placement.

      The colspan concept is motivated by the HTML table model, the Blueprint templates map this value to CSS styles, though.

    • getWidth

      int getWidth()
      Returns the relative (percentage) width of this placement.
    • getNumCols

      int getNumCols()
      Returns the number of the row of this placement.
    • isEditable

      boolean isEditable()
      Returns if the Placement is editable.
    • getAdditionalProperties

      Map<String,Object> getAdditionalProperties()
      Returns additional properties stored in the pagegrid config