io.jmix.ui.component

Interface ResponsiveGridLayout.Row

All Superinterfaces:

ResponsiveGridLayout.GridElement

All Known Implementing Classes:

ResponsiveGridLayoutImpl.RowImpl

Enclosing interface:

ResponsiveGridLayout

public static interface ResponsiveGridLayout.Row
extends ResponsiveGridLayout.GridElement

Interface defining a grid row. It's a wrapper over grid ResponsiveGridLayout.Columns with the ability to provide content alignment.

Corresponds to the <div class="row"> element.

Method Summary

Modifier and Type	Method and Description
void	addAlignItems(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.AlignItems alignItems) Adds information regarding how columns are laid out along the cross axis on the current row at the given breakpoint.
ResponsiveGridLayout.Column	addColumn() Creates a new ResponsiveGridLayout.Column and adds it to this row.
ResponsiveGridLayout.Column	addColumn(int index) Creates a new ResponsiveGridLayout.Column and adds it to the given position in this row.
void	addJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.JustifyContent justifyContent) Adds information regarding how columns are laid out along the main axis on the current row at the given breakpoint.
void	addRowColumns(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.RowColumnsValue columnsValue) Adds information regarding what number of columns in the row will be at the given breakpoint.
java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems>	getAlignItems() Returns the map that contains information regarding how columns are laid out along the cross axis on the current row at a specific breakpoint.
java.util.List<ResponsiveGridLayout.Column>	getColumns()
float	getHeight() Returns the height of this row.
SizeUnit	getHeightSizeUnit() Returns the height property units.
java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent>	getJustifyContent() Returns the map that contains information regarding how columns are laid out along the main axis on the current row at a specific breakpoint.
java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue>	getRowColumns() Returns the map that contains information regarding what number of columns in the row will be at a specific breakpoint.
boolean	isGuttersEnabled()
void	removeAlignItems(ResponsiveGridLayout.Breakpoint breakpoint) Removes the mapping of how columns are laid out along the cross axis on the current row for the given breakpoint if it is present.
void	removeAllColumns() Removes all columns from this row.
void	removeColumn(ResponsiveGridLayout.Column column) Removes the given column from this row.
void	removeJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint) Removes the mapping of how columns are laid out along the main axis on the current row for the given breakpoint if it is present.
void	removeRowColumns(ResponsiveGridLayout.Breakpoint breakpoint) Removes the mapping of the number of columns in the row for the given breakpoint if it is present.
void	setAlignItems(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems> alignItems) Sets a new mapping of how columns are laid out along the cross axis on the current row with corresponding breakpoints.
default void	setAlignItems(ResponsiveGridLayout.AlignItems alignItems) Sets a new mapping of how columns are laid out along the cross axis on the current row at all breakpoints, i.e.
default void	setAlignItems(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.AlignItems alignItems) Sets a new mapping of how columns are laid out along the cross axis on the current row with the specified breakpoint.
void	setGuttersEnabled(boolean guttersEnabled) Sets whether gutters are enabled.
void	setHeight(java.lang.String height) Sets the height of the component using String presentation.
default void	setHeightAuto() Sets row height to Component.AUTO_SIZE.
default void	setHeightFull() Sets row height to Component.FULL_SIZE.
void	setJustifyContent(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent> justifyContent) Sets a new mapping of how columns are laid out along the main axis on the current row with corresponding breakpoints.
default void	setJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.JustifyContent justifyContent) Sets a new mapping of how columns are laid out along the main axis on the current row with the specified breakpoint.
default void	setJustifyContent(ResponsiveGridLayout.JustifyContent justifyContent) Sets a new mapping of how columns are laid out along the main axis on the current row at all breakpoints, i.e.
void	setRowColumns(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> columns) Sets a new mapping of the number of columns in the row with corresponding breakpoints.
default void	setRowColumns(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.RowColumnsValue columnsValue) Sets a new mapping of the number of columns in the row with the specified breakpoint.
default void	setRowColumns(ResponsiveGridLayout.RowColumnsValue columnsValue) Sets a new mapping of the number of columns in the row that will be applied for all breakpoints, i.e.

Methods inherited from interface io.jmix.ui.component.ResponsiveGridLayout.GridElement

addStyleName, getId, getStyleName, removeStyleName, setId, setStyleName

Method Detail

addColumn

ResponsiveGridLayout.Column addColumn()

Creates a new ResponsiveGridLayout.Column and adds it to this row.

Returns:

the created column

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

addColumn

ResponsiveGridLayout.Column addColumn(int index)

Creates a new ResponsiveGridLayout.Column and adds it to the given position in this row.

Parameters:

index - the position of the new column. The columns that are currently in and after the position are shifted forwards

Returns:

the created column

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

removeColumn

void removeColumn(ResponsiveGridLayout.Column column)

Removes the given column from this row.

Parameters:

column - the column to be removed

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

removeAllColumns

void removeAllColumns()

Removes all columns from this row.

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

getColumns

java.util.List<ResponsiveGridLayout.Column> getColumns()

Returns:

a list of contained columns

isGuttersEnabled

boolean isGuttersEnabled()

Returns:

whether gutters are enabled

setGuttersEnabled

@StudioProperty(defaultValue="true")
void setGuttersEnabled(boolean guttersEnabled)

Sets whether gutters are enabled. Gutters are enabled by default.

If set to false, the .no-gutters style will be added to this row. It removes the negative margins from the row and the horizontal padding from all immediate children columns.

Parameters:

guttersEnabled - a boolean value specifying if the row should have gutters or not

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

getHeight

float getHeight()

Returns the height of this row. A negative number implies unspecified size.

Returns:

height of the row in units specified by {getHeightSizeUnit()} property.

getHeightSizeUnit

SizeUnit getHeightSizeUnit()

Returns the height property units.

Returns:

units used in height property.

setHeight

@StudioProperty(name="height",
                type=SIZE,
                defaultValue="-1px")
void setHeight(java.lang.String height)

Sets the height of the component using String presentation.

String presentation is similar to what is used in Cascading Style Sheets. Size can be length or percentage of available size.

The empty string ("") or null will unset the height and set the units to pixels.

Parameters:

height - the height to be set

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

setHeightAuto

default void setHeightAuto()

Sets row height to Component.AUTO_SIZE.

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

setHeightFull

default void setHeightFull()

Sets row height to Component.FULL_SIZE.

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

getRowColumns

java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> getRowColumns()

Returns the map that contains information regarding what number of columns in the row will be at a specific breakpoint.

Corresponds to the .row-cols-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding what number of columns in the row will be at a specific breakpoint

setRowColumns

@StudioProperty(name="cols",
                type=INTEGER)
default void setRowColumns(ResponsiveGridLayout.RowColumnsValue columnsValue)

Sets a new mapping of the number of columns in the row that will be applied for all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

columnsValue - the instance of ResponsiveGridLayout.RowColumnsValue to set for all breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setRowColumns(Map)

setRowColumns

default void setRowColumns(ResponsiveGridLayout.Breakpoint breakpoint,
                           ResponsiveGridLayout.RowColumnsValue columnsValue)

Sets a new mapping of the number of columns in the row with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

columnsValue - the instance of ResponsiveGridLayout.RowColumnsValue to set

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setRowColumns(Map)

setRowColumns

void setRowColumns(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> columns)

Sets a new mapping of the number of columns in the row with corresponding breakpoints. Overrides previous values.

Corresponds to the .row-cols-{breakpoint}-* responsive styles.

Parameters:

columns - the map that contains information regarding what number of columns in the row will be at a specific breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

addRowColumns

void addRowColumns(ResponsiveGridLayout.Breakpoint breakpoint,
                   ResponsiveGridLayout.RowColumnsValue columnsValue)

Adds information regarding what number of columns in the row will be at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.RowColumnsValue instance.

Parameters:

breakpoint - the breakpoint with which the specified ResponsiveGridLayout.RowColumnsValue instance is to be associated

columnsValue - the ResponsiveGridLayout.RowColumnsValue instance to be associated with the specified breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setRowColumns(Map)

removeRowColumns

void removeRowColumns(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of the number of columns in the row for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

getAlignItems

java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems> getAlignItems()

Returns the map that contains information regarding how columns are laid out along the cross axis on the current row at a specific breakpoint.

Corresponds to the .align-items-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding how columns are laid out along the cross axis on the current row at a specific breakpoint

setAlignItems

@StudioProperty(type=ENUMERATION,
                options={"START","CENTER","END","BASELINE","STRETCH"})
default void setAlignItems(ResponsiveGridLayout.AlignItems alignItems)

Sets a new mapping of how columns are laid out along the cross axis on the current row at all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

alignItems - the ResponsiveGridLayout.AlignItems value to set for all breakpoints

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setAlignItems(Map)

setAlignItems

default void setAlignItems(ResponsiveGridLayout.Breakpoint breakpoint,
                           ResponsiveGridLayout.AlignItems alignItems)

Sets a new mapping of how columns are laid out along the cross axis on the current row with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

alignItems - the ResponsiveGridLayout.AlignItems value to set

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setAlignItems(Map)

setAlignItems

void setAlignItems(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems> alignItems)

Sets a new mapping of how columns are laid out along the cross axis on the current row with corresponding breakpoints. Overrides previous values.

Corresponds to the .align-items-{breakpoint}-* responsive styles.

Parameters:

alignItems - the map that contains information regarding how columns are laid out along the cross axis on the current row at a specific breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

addAlignItems

void addAlignItems(ResponsiveGridLayout.Breakpoint breakpoint,
                   ResponsiveGridLayout.AlignItems alignItems)

Adds information regarding how columns are laid out along the cross axis on the current row at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.AlignItems value.

Parameters:

breakpoint - the breakpoint with which the specified ResponsiveGridLayout.AlignItems value is to be associated

alignItems - the ResponsiveGridLayout.AlignItems value to be associated with the specified breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setAlignItems(Map)

removeAlignItems

void removeAlignItems(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of how columns are laid out along the cross axis on the current row for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

getJustifyContent

java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent> getJustifyContent()

Returns the map that contains information regarding how columns are laid out along the main axis on the current row at a specific breakpoint.

Corresponds to the .justify-content-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding how columns are laid out along the main axis on the current row at a specific breakpoint

setJustifyContent

@StudioProperty(type=ENUMERATION,
                options={"AROUND","BETWEEN","CENTER","END","START"})
default void setJustifyContent(ResponsiveGridLayout.JustifyContent justifyContent)

Sets a new mapping of how columns are laid out along the main axis on the current row at all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

justifyContent - the ResponsiveGridLayout.JustifyContent value to set for all breakpoints

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setJustifyContent(Map)

setJustifyContent

default void setJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint,
                               ResponsiveGridLayout.JustifyContent justifyContent)

Sets a new mapping of how columns are laid out along the main axis on the current row with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

justifyContent - the ResponsiveGridLayout.JustifyContent value to set

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setJustifyContent(Map)

setJustifyContent

void setJustifyContent(java.util.Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent> justifyContent)

Sets a new mapping of how columns are laid out along the main axis on the current row with corresponding breakpoints. Overrides previous values.

Corresponds to the .justify-content-{breakpoint}-* responsive styles.

Parameters:

justifyContent - the map that contains information regarding how columns are laid out along the main axis on the current row at a specific breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

addJustifyContent

void addJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint,
                       ResponsiveGridLayout.JustifyContent justifyContent)

Adds information regarding how columns are laid out along the main axis on the current row at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.JustifyContent value.

Parameters:

breakpoint - the breakpoint with which the specified ResponsiveGridLayout.AlignItems value is to be associated

justifyContent - the ResponsiveGridLayout.JustifyContent value to be associated with the specified breakpoint

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen

See Also:

setJustifyContent(Map)

removeJustifyContent

void removeJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of how columns are laid out along the main axis on the current row for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

java.lang.IllegalStateException - if parent responsive grid layout has been shown on a screen