Package io.jmix.ui.component

Interface ResponsiveGridLayout.GridElement

All Known Subinterfaces:
ResponsiveGridLayout.Column, ResponsiveGridLayout.Row
All Known Implementing Classes:
ResponsiveGridLayoutImpl.AbstractGridElementImpl, ResponsiveGridLayoutImpl.ColumnImpl, ResponsiveGridLayoutImpl.RowImpl
Enclosing interface:
ResponsiveGridLayout
public static interface ResponsiveGridLayout.GridElement
Interface to provide default functionality for grid elements.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addStyleName(String styleName)
    Adds one or more style names to this grid element.
    String
    getId()
     
    String
    getStyleName()
    Gets all user-defined CSS style names of the grid element.
    void
    removeStyleName(String styleName)
    Removes one or more style names to this grid element.
    void
    setId(String id)
    Sets an nonunique id for grid element that is used as a debug identifier.
    void
    setStyleName(String styleName)
    Sets one or more user-defined style names of the grid element, replacing any previous user-defined styles.

  • Method Details

    • getId

      String getId()
      Returns:
      current id, null if not set

    • setId

      @StudioProperty(name="id", type=COMPONENT_ID) void setId(String id)
      Sets an nonunique id for grid element that is used as a debug identifier.
      Parameters:
      id - an alphanumeric id
      Throws:
      IllegalStateException - if parent responsive grid layout has been shown on a screen

    • getStyleName

      String getStyleName()
      Gets all user-defined CSS style names of the grid element. If the grid element has multiple style names defined, the returned string is a space-separated list of style names.
      Returns:
      the style name or a space-separated list of user-defined style names

    • setStyleName

      @StudioProperty(name="stylename", type=CSS_CLASSNAME_LIST) void setStyleName(String styleName)
      Sets one or more user-defined style names of the grid element, replacing any previous user-defined styles. Multiple styles can be specified as a space-separated list of style names.
      Parameters:
      styleName - one or more style names separated by space
      Throws:
      IllegalStateException - if parent responsive grid layout has been shown on a screen

    • addStyleName

      void addStyleName(String styleName)
      Adds one or more style names to this grid element. Multiple styles can be specified as a space-separated list of style names.
      Parameters:
      styleName - the style name or style names to be added
      Throws:
      IllegalStateException - if parent responsive grid layout has been shown on a screen

    • removeStyleName

      void removeStyleName(String styleName)
      Removes one or more style names to this grid element. Multiple styles can be specified as a space-separated list of style names.
      Parameters:
      styleName - the style name or style names to be removed
      Throws:
      IllegalStateException - if parent responsive grid layout has been shown on a screen