Package io.jmix.ui.component.impl

Class ResponsiveGridLayoutImpl.RowImpl

java.lang.Object

io.jmix.ui.component.impl.ResponsiveGridLayoutImpl.AbstractGridElementImpl<JmixResponsiveGridLayout.Row>

io.jmix.ui.component.impl.ResponsiveGridLayoutImpl.RowImpl

All Implemented Interfaces:

ResponsiveGridLayout.GridElement, ResponsiveGridLayout.Row

Enclosing class:

ResponsiveGridLayoutImpl

protected static class ResponsiveGridLayoutImpl.RowImpl
extends ResponsiveGridLayoutImpl.AbstractGridElementImpl<JmixResponsiveGridLayout.Row>
implements ResponsiveGridLayout.Row

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems>	alignItems
protected List<ResponsiveGridLayout.Column>	columnOrder
protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent>	justifyContent
protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue>	rowColumns

Fields inherited from class io.jmix.ui.component.impl.ResponsiveGridLayoutImpl.AbstractGridElementImpl

gridElement, id, owner

Constructor Summary

Constructors

Constructor	Description
RowImpl(JmixResponsiveGridLayout.Row row, ResponsiveGridLayoutImpl owner)

Method Summary

Modifier and Type	Method	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.
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.
List<ResponsiveGridLayout.Column>	getColumns()
float	getHeight()	Returns the height of this row.
SizeUnit	getHeightSizeUnit()	Returns the height property units.
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.
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(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.
void	setGuttersEnabled(boolean guttersEnabled)	Sets whether gutters are enabled.
void	setHeight(String height)	Sets the height of the component using String presentation.
void	setJustifyContent(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.
void	setRowColumns(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> columnsValue)	Sets a new mapping of the number of columns in the row with corresponding breakpoints.
protected void	updateAlignItems()
protected void	updateJustifyContent()
protected void	updateRowColumnsValue()

Methods inherited from class io.jmix.ui.component.impl.ResponsiveGridLayoutImpl.AbstractGridElementImpl

addStyleName, checkInitializedState, getId, getOwner, getStyleName, getVaadinGridElement, removeStyleName, setId, setStyleName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addStyleName, getId, getStyleName, removeStyleName, setId, setStyleName

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

setAlignItems, setAlignItems, setHeightAuto, setHeightFull, setJustifyContent, setJustifyContent, setRowColumns, setRowColumns

Field Details

columnOrder

protected List<ResponsiveGridLayout.Column> columnOrder

rowColumns

protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> rowColumns

alignItems

protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems> alignItems

justifyContent

protected Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent> justifyContent

Constructor Details

RowImpl

public RowImpl(JmixResponsiveGridLayout.Row row,
 ResponsiveGridLayoutImpl owner)

Method Details

addColumn

public ResponsiveGridLayout.Column addColumn()

Description copied from interface: ResponsiveGridLayout.Row

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

Specified by:

addColumn in interface ResponsiveGridLayout.Row

Returns:

the created column

addColumn

public ResponsiveGridLayout.Column addColumn(int index)

Description copied from interface: ResponsiveGridLayout.Row

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

Specified by:

addColumn in interface ResponsiveGridLayout.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

removeColumn

public void removeColumn(ResponsiveGridLayout.Column column)

Description copied from interface: ResponsiveGridLayout.Row

Removes the given column from this row.

Specified by:

removeColumn in interface ResponsiveGridLayout.Row

Parameters:

column - the column to be removed

removeAllColumns

public void removeAllColumns()

Description copied from interface: ResponsiveGridLayout.Row

Removes all columns from this row.

Specified by:

removeAllColumns in interface ResponsiveGridLayout.Row

getColumns

public List<ResponsiveGridLayout.Column> getColumns()

Specified by:

getColumns in interface ResponsiveGridLayout.Row

Returns:

a list of contained columns

isGuttersEnabled

public boolean isGuttersEnabled()

Specified by:

isGuttersEnabled in interface ResponsiveGridLayout.Row

Returns:

whether gutters are enabled

setGuttersEnabled

public void setGuttersEnabled(boolean guttersEnabled)

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

setGuttersEnabled in interface ResponsiveGridLayout.Row

Parameters:

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

getHeight

public float getHeight()

Description copied from interface: ResponsiveGridLayout.Row

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

Specified by:

getHeight in interface ResponsiveGridLayout.Row

Returns:

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

getHeightSizeUnit

public SizeUnit getHeightSizeUnit()

Description copied from interface: ResponsiveGridLayout.Row

Returns the height property units.

Specified by:

getHeightSizeUnit in interface ResponsiveGridLayout.Row

Returns:

units used in height property.

setHeight

public void setHeight(String height)

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

setHeight in interface ResponsiveGridLayout.Row

Parameters:

height - the height to be set

getRowColumns

public Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> getRowColumns()

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

getRowColumns in interface ResponsiveGridLayout.Row

Returns:

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

setRowColumns

public void setRowColumns(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.RowColumnsValue> columnsValue)

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

setRowColumns in interface ResponsiveGridLayout.Row

Parameters:

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

addRowColumns

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

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

addRowColumns in interface ResponsiveGridLayout.Row

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

See Also:

• ResponsiveGridLayout.Row.setRowColumns(Map)

removeRowColumns

public void removeRowColumns(ResponsiveGridLayout.Breakpoint breakpoint)

Description copied from interface: ResponsiveGridLayout.Row

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

Specified by:

removeRowColumns in interface ResponsiveGridLayout.Row

Parameters:

breakpoint - the breakpoint for which to remove mapping

updateRowColumnsValue

protected void updateRowColumnsValue()

getAlignItems

public Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignItems> getAlignItems()

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

getAlignItems in interface ResponsiveGridLayout.Row

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

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

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

setAlignItems in interface ResponsiveGridLayout.Row

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

addAlignItems

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

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

addAlignItems in interface ResponsiveGridLayout.Row

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

See Also:

• ResponsiveGridLayout.Row.setAlignItems(Map)

removeAlignItems

public void removeAlignItems(ResponsiveGridLayout.Breakpoint breakpoint)

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

removeAlignItems in interface ResponsiveGridLayout.Row

Parameters:

breakpoint - the breakpoint for which to remove mapping

updateAlignItems

protected void updateAlignItems()

getJustifyContent

public Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.JustifyContent> getJustifyContent()

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

getJustifyContent in interface ResponsiveGridLayout.Row

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

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

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

setJustifyContent in interface ResponsiveGridLayout.Row

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

addJustifyContent

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

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

addJustifyContent in interface ResponsiveGridLayout.Row

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

See Also:

• ResponsiveGridLayout.Row.setJustifyContent(Map)

removeJustifyContent

public void removeJustifyContent(ResponsiveGridLayout.Breakpoint breakpoint)

Description copied from interface: ResponsiveGridLayout.Row

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.

Specified by:

removeJustifyContent in interface ResponsiveGridLayout.Row

Parameters:

breakpoint - the breakpoint for which to remove mapping

updateJustifyContent

protected void updateJustifyContent()