Package io.jmix.ui.component

Interface ResponsiveGridLayout.Column

All Superinterfaces:

ResponsiveGridLayout.GridElement

All Known Implementing Classes:

ResponsiveGridLayoutImpl.ColumnImpl

Enclosing interface:

ResponsiveGridLayout

public static interface ResponsiveGridLayout.Column
extends ResponsiveGridLayout.GridElement

Interface defining a grid column. It's a wrapper over grid's content.

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

Method Summary

Modifier and Type	Method	Description
void	addAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.AlignSelf alignSelf)	Adds information regarding how this column is laid out along the cross axis at the given breakpoint.
void	addColumns(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.ColumnsValue columnsValue)	Adds information regarding the logical columns number that this column occupies at the given breakpoint.
void	addOffset(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.OffsetValue offsetValue)	Adds information regarding offset of this column at the given breakpoint.
void	addOrder(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.OrderValue orderValue)	Adds information regarding the visual order of this column at the given breakpoint.
Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignSelf>	getAlignSelf()	Returns the map that contains information regarding how this column is laid out along the cross axis at a specific breakpoint.
Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.ColumnsValue>	getColumns()	Returns the map that contains information regarding the logical columns number that this column occupies at a specific breakpoint.
Component	getComponent()
Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OffsetValue>	getOffset()	Returns the map that contains information regarding offset of this column at a specific breakpoint.
Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OrderValue>	getOrder()	Returns the map that contains information regarding the visual order of this column at a specific breakpoint.
void	removeAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint)	Removes the mapping of how this column is laid out along the cross axis for the given breakpoint if it is present.
void	removeColumns(ResponsiveGridLayout.Breakpoint breakpoint)	Removes the mapping of the logical columns number that this column occupies for the given breakpoint if it is present.
void	removeOffset(ResponsiveGridLayout.Breakpoint breakpoint)	Removes the mapping of offset of this column for the given breakpoint if it is present.
void	removeOrder(ResponsiveGridLayout.Breakpoint breakpoint)	Removes the mapping of the visual order of this column for the given breakpoint if it is present.
default void	setAlignSelf(ResponsiveGridLayout.AlignSelf alignSelf)	Sets a new mapping of how this column is laid out along the cross axis at all breakpoints, i.e.
default void	setAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.AlignSelf alignSelf)	Sets a new mapping of how this column is laid out along the cross axis with the specified breakpoint.
void	setAlignSelf(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignSelf> aligns)	Sets a new mapping of how this column is laid out along the cross axis with corresponding breakpoints.
default void	setColumns(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.ColumnsValue columnsValue)	Sets a new mapping of the logical columns number that this column occupies with the specified breakpoint.
default void	setColumns(ResponsiveGridLayout.ColumnsValue columnsValue)	Sets a new mapping of the logical columns number that this column occupies at all breakpoints, i.e.
void	setColumns(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.ColumnsValue> columns)	Sets a new mapping of the logical columns number that this column occupies with corresponding breakpoints.
void	setComponent(Component component)	Sets a component to be rendered within this column.
default void	setOffset(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.OffsetValue offsetValue)	Sets a new mapping of offset of this column with the specified breakpoint.
default void	setOffset(ResponsiveGridLayout.OffsetValue offsetValue)	Sets a new mapping of offset of this column at all breakpoints, i.e.
void	setOffset(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OffsetValue> offsets)	Sets a new mapping of offset of this column with corresponding breakpoints.
default void	setOrder(ResponsiveGridLayout.Breakpoint breakpoint, ResponsiveGridLayout.OrderValue orderValue)	Sets a new mapping of the visual order of this column with the specified breakpoint.
default void	setOrder(ResponsiveGridLayout.OrderValue orderValue)	Sets a new mapping of the visual order of this column at all breakpoints, i.e.
void	setOrder(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OrderValue> orders)	Sets a new mapping of the visual order of this column with corresponding breakpoints.

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

addStyleName, getId, getStyleName, removeStyleName, setId, setStyleName

Method Details

getComponent

Component getComponent()

Returns:

a component to be rendered within this column

setComponent

void setComponent(Component component)

Sets a component to be rendered within this column.

Parameters:

component - a components to set

getColumns

Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.ColumnsValue> getColumns()

Returns the map that contains information regarding the logical columns number that this column occupies at a specific breakpoint.

Corresponds to the .col-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding the logical columns number that this column occupies at a specific breakpoint

setColumns

default void setColumns(ResponsiveGridLayout.ColumnsValue columnsValue)

Sets a new mapping of the logical columns number that this column occupies at all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

columnsValue - the ResponsiveGridLayout.ColumnsValue instance to set for all breakpoints

Throws:

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

See Also:

• setColumns(Map)

setColumns

default void setColumns(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.ColumnsValue columnsValue)

Sets a new mapping of the logical columns number that this column occupies with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

columnsValue - the ResponsiveGridLayout.ColumnsValue instance to set

Throws:

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

See Also:

• setColumns(Map)

setColumns

void setColumns(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.ColumnsValue> columns)

Sets a new mapping of the logical columns number that this column occupies with corresponding breakpoints. Overrides previous values.

Corresponds to the .col-{breakpoint}-* responsive styles.

Parameters:

columns - the map that contains information regarding the logical columns number that this column occupies at a specific breakpoint

Throws:

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

addColumns

void addColumns(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.ColumnsValue columnsValue)

Adds information regarding the logical columns number that this column occupies at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.ColumnsValue instance.

Parameters:

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

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

Throws:

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

See Also:

• setColumns(Map)

removeColumns

void removeColumns(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of the logical columns number that this column occupies for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

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

getAlignSelf

Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignSelf> getAlignSelf()

Returns the map that contains information regarding how this column is laid out along the cross axis at a specific breakpoint.

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

Returns:

the map that contains information regarding how this column is laid out along the cross axis at a specific breakpoint

setAlignSelf

@StudioProperty(type=ENUMERATION,
                options={"AUTO","BASELINE","CENTER","END","START","STRETCH"})
default void setAlignSelf(ResponsiveGridLayout.AlignSelf alignSelf)

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

Parameters:

alignSelf - the ResponsiveGridLayout.AlignSelf value to set for all breakpoints

Throws:

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

See Also:

• setAlignSelf(Map)

setAlignSelf

default void setAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.AlignSelf alignSelf)

Sets a new mapping of how this column is laid out along the cross axis with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

alignSelf - the ResponsiveGridLayout.AlignSelf value to set

Throws:

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

See Also:

• setAlignSelf(Map)

setAlignSelf

void setAlignSelf(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.AlignSelf> aligns)

Sets a new mapping of how this column is laid out along the cross axis with corresponding breakpoints. Overrides previous values.

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

Parameters:

aligns - the map that contains information regarding how this column is laid out along the cross axis at a specific breakpoint

Throws:

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

addAlignSelf

void addAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.AlignSelf alignSelf)

Adds information regarding how this column is laid out along the cross axis at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.AlignSelf value.

Parameters:

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

alignSelf - the ResponsiveGridLayout.AlignSelf value to be associated with the specified breakpoint

Throws:

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

See Also:

• setAlignSelf(Map)

removeAlignSelf

void removeAlignSelf(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of how this column is laid out along the cross axis for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

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

getOrder

Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OrderValue> getOrder()

Returns the map that contains information regarding the visual order of this column at a specific breakpoint.

Corresponds to the .order-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding the visual order of this column at a specific breakpoint

setOrder

@StudioProperty(name="order",
                type=STRING,
                options={"FIRST","LAST"})
default void setOrder(ResponsiveGridLayout.OrderValue orderValue)

Sets a new mapping of the visual order of this column at all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

orderValue - the ResponsiveGridLayout.OrderValue instance to set for all breakpoints

Throws:

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

See Also:

• setOrder(Map)

setOrder

default void setOrder(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.OrderValue orderValue)

Sets a new mapping of the visual order of this column with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

orderValue - the ResponsiveGridLayout.OrderValue instance to set

Throws:

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

See Also:

• setOrder(Map)

setOrder

void setOrder(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OrderValue> orders)

Sets a new mapping of the visual order of this column with corresponding breakpoints. Overrides previous values.

Corresponds to the .order-{breakpoint}-* responsive styles.

Parameters:

orders - the map that contains information regarding the visual order of this column at a specific breakpoint

Throws:

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

addOrder

void addOrder(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.OrderValue orderValue)

Adds information regarding the visual order of this column at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.OrderValue instance.

Parameters:

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

orderValue - the ResponsiveGridLayout.OrderValue instance to be associated with the specified breakpoint

Throws:

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

See Also:

• setOrder(Map)

removeOrder

void removeOrder(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of the visual order of this column for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

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

getOffset

Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OffsetValue> getOffset()

Returns the map that contains information regarding offset of this column at a specific breakpoint.

Corresponds to the .offset-{breakpoint}-* responsive styles.

Returns:

the map that contains information regarding offset of this column at a specific breakpoint

setOffset

@StudioProperty(name="offset",
                type=INTEGER)
default void setOffset(ResponsiveGridLayout.OffsetValue offsetValue)

Sets a new mapping of offset of this column at all breakpoints, i.e. starting from ResponsiveGridLayout.Breakpoint.XS. Clears previous values and creates a map with a single value.

Parameters:

offsetValue - the ResponsiveGridLayout.OffsetValue instance to set for all breakpoints

Throws:

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

See Also:

• setOffset(Map)

setOffset

default void setOffset(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.OffsetValue offsetValue)

Sets a new mapping of offset of this column with the specified breakpoint. Clears previous values and creates a map with a single value.

Parameters:

breakpoint - the breakpoint to start from

offsetValue - the ResponsiveGridLayout.OffsetValue instance to set

Throws:

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

See Also:

• setOffset(Map)

setOffset

void setOffset(Map<ResponsiveGridLayout.Breakpoint,ResponsiveGridLayout.OffsetValue> offsets)

Sets a new mapping of offset of this column with corresponding breakpoints. Overrides previous values.

Corresponds to the .offset-{breakpoint}-* responsive styles.

Parameters:

offsets - the map that contains information regarding offset of this column at a specific breakpoint

Throws:

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

addOffset

void addOffset(ResponsiveGridLayout.Breakpoint breakpoint,
 ResponsiveGridLayout.OffsetValue offsetValue)

Adds information regarding offset of this column at the given breakpoint. If a mapping for the breakpoint already exist, the old value is replaced by the specified ResponsiveGridLayout.OffsetValue instance.

Parameters:

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

offsetValue - the ResponsiveGridLayout.OffsetValue instance to be associated with the specified breakpoint

Throws:

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

See Also:

• setOffset(Map)

removeOffset

void removeOffset(ResponsiveGridLayout.Breakpoint breakpoint)

Removes the mapping of offset of this column for the given breakpoint if it is present.

Parameters:

breakpoint - the breakpoint for which to remove mapping

Throws:

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