Package io.jmix.ui.component.impl

Class ResponsiveGridLayoutImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixResponsiveGridLayout>

io.jmix.ui.component.impl.ResponsiveGridLayoutImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, LayoutClickNotifier, ResponsiveGridLayout

public class ResponsiveGridLayoutImpl
extends AbstractComponent<JmixResponsiveGridLayout>
implements ResponsiveGridLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ResponsiveGridLayoutImpl.AbstractGridElementImpl<T extends JmixResponsiveGridLayout.AbstractGridElement>
protected static class	ResponsiveGridLayoutImpl.ColumnImpl
protected static class	ResponsiveGridLayoutImpl.RowImpl

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.LayoutClickNotifier

LayoutClickNotifier.LayoutClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.ResponsiveGridLayout

ResponsiveGridLayout.AlignItems, ResponsiveGridLayout.AlignSelf, ResponsiveGridLayout.Breakpoint, ResponsiveGridLayout.Column, ResponsiveGridLayout.ColumnsValue, ResponsiveGridLayout.ContainerType, ResponsiveGridLayout.GridElement, ResponsiveGridLayout.JustifyContent, ResponsiveGridLayout.OffsetValue, ResponsiveGridLayout.OrderValue, ResponsiveGridLayout.Row, ResponsiveGridLayout.RowColumnsValue

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.shared.Registration	layoutClickRegistration
protected List<Component>	ownComponents
protected List<ResponsiveGridLayout.Row>	rowOrder

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields inherited from interface io.jmix.ui.component.ResponsiveGridLayout

NAME

Constructor Summary

Constructors

Constructor	Description
ResponsiveGridLayoutImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)	Adds a listener that is fired when user clicks inside the layout at any place.
protected void	addOwnComponent(Component component)
ResponsiveGridLayout.Row	addRow()	Creates a new ResponsiveGridLayout.Row and adds it to this responsive grid layout.
ResponsiveGridLayout.Row	addRow(int index)	Creates a new ResponsiveGridLayout.Row and adds it to the given position in responsive grid layout.
void	attached()	Notifies all listeners that component has been attached.
protected void	checkInitializedState()
protected JmixResponsiveGridLayout	createComponent()
void	detached()	Notifies all listeners that component has been detached.
protected Component	findChildComponent(com.vaadin.ui.Component clickedComponent)
Component	getComponent(String id)	Gets a component belonging to the whole components tree below this container.
Collection<Component>	getComponents()	Gets all components belonging to the whole components tree below this container.
ResponsiveGridLayout.ContainerType	getContainerType()
Component	getOwnComponent(String id)	Gets component directly owned by this container.
Collection<Component>	getOwnComponents()	Gets all components directly owned by this container.
Stream<Component>	getOwnComponentsStream()	Gets stream of all components directly owned by this container.
List<ResponsiveGridLayout.Row>	getRows()
float	getWidth()	Get component width in Component.getWidthSizeUnit()
SizeUnit	getWidthSizeUnit()	Gets the width property units.
protected void	internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
boolean	isResponsive()	Is the component responsive?
void	removeAllRows()	Removes all rows from this responsive grid layout.
protected void	removeOwnComponent(Component component)
void	removeRow(ResponsiveGridLayout.Row row)	Removes the given row from this responsive grid layout.
void	setContainerType(ResponsiveGridLayout.ContainerType containerType)	Sets the container type.
void	setResponsive(boolean responsive)	Sets component to be responsive by width and height.
void	setWidth(String width)	Set component width in Component.getWidthSizeUnit()}

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setStyleName, setValidationError, setVisible, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, isEnabled, isEnabledRecursive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponentNN

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

rowOrder

protected List<ResponsiveGridLayout.Row> rowOrder

ownComponents

protected List<Component> ownComponents

layoutClickRegistration

protected com.vaadin.shared.Registration layoutClickRegistration

Constructor Details

ResponsiveGridLayoutImpl

public ResponsiveGridLayoutImpl()

Method Details

createComponent

protected JmixResponsiveGridLayout createComponent()

addRow

public ResponsiveGridLayout.Row addRow()

Description copied from interface: ResponsiveGridLayout

Creates a new ResponsiveGridLayout.Row and adds it to this responsive grid layout.

Specified by:

addRow in interface ResponsiveGridLayout

Returns:

the created row

addRow

public ResponsiveGridLayout.Row addRow(int index)

Description copied from interface: ResponsiveGridLayout

Creates a new ResponsiveGridLayout.Row and adds it to the given position in responsive grid layout.

Specified by:

addRow in interface ResponsiveGridLayout

Parameters:

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

Returns:

the created row

removeRow

public void removeRow(ResponsiveGridLayout.Row row)

Description copied from interface: ResponsiveGridLayout

Removes the given row from this responsive grid layout.

Specified by:

removeRow in interface ResponsiveGridLayout

Parameters:

row - the row to be removed

removeAllRows

public void removeAllRows()

Description copied from interface: ResponsiveGridLayout

Removes all rows from this responsive grid layout.

Specified by:

removeAllRows in interface ResponsiveGridLayout

getRows

public List<ResponsiveGridLayout.Row> getRows()

Specified by:

getRows in interface ResponsiveGridLayout

Returns:

a list of contained rows

getContainerType

public ResponsiveGridLayout.ContainerType getContainerType()

Specified by:

getContainerType in interface ResponsiveGridLayout

Returns:

the container type, not null

setContainerType

public void setContainerType(ResponsiveGridLayout.ContainerType containerType)

Description copied from interface: ResponsiveGridLayout

Sets the container type.

The built-in container types are:

• ResponsiveGridLayout.ContainerType.FLUID - a full width container, spanning the entire width of the viewport. Used by default.
• ResponsiveGridLayout.ContainerType.FIXED - a fixed-width container, meaning its max-width changes at each breakpoint.

Specified by:

setContainerType in interface ResponsiveGridLayout

Parameters:

containerType - the container type to switch to, not null

getOwnComponent

@Nullable
public Component getOwnComponent(String id)

Description copied from interface: HasComponents

Gets component directly owned by this container.

Specified by:

getOwnComponent in interface HasComponents

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(String id)

Description copied from interface: HasComponents

Gets a component belonging to the whole components tree below this container.

Specified by:

getComponent in interface HasComponents

Returns:

component or null if not found

getOwnComponents

public Collection<Component> getOwnComponents()

Description copied from interface: HasComponents

Gets all components directly owned by this container.

Specified by:

getOwnComponents in interface HasComponents

Returns:

all components directly owned by this container

getOwnComponentsStream

public Stream<Component> getOwnComponentsStream()

Description copied from interface: HasComponents

Gets stream of all components directly owned by this container.

Specified by:

getOwnComponentsStream in interface HasComponents

Returns:

stream of all components directly owned by this container

getComponents

public Collection<Component> getComponents()

Description copied from interface: HasComponents

Gets all components belonging to the whole components tree below this container.

Specified by:

getComponents in interface HasComponents

Returns:

all components belonging to the whole components tree below this container

addOwnComponent

protected void addOwnComponent(Component component)

removeOwnComponent

protected void removeOwnComponent(Component component)

addLayoutClickListener

public Subscription addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)

Description copied from interface: LayoutClickNotifier

Adds a listener that is fired when user clicks inside the layout at any place.

Specified by:

addLayoutClickListener in interface LayoutClickNotifier

Parameters:

listener - a listener to add

findChildComponent

@Nullable
protected Component findChildComponent(com.vaadin.ui.Component clickedComponent)

internalRemoveLayoutClickListener

protected void internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)

attached

public void attached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been attached.

Specified by:

attached in interface AttachNotifier

Overrides:

attached in class AbstractComponent<JmixResponsiveGridLayout>

detached

public void detached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been detached.

Specified by:

detached in interface AttachNotifier

Overrides:

detached in class AbstractComponent<JmixResponsiveGridLayout>

getWidth

public float getWidth()

Description copied from interface: Component

Get component width in Component.getWidthSizeUnit()

Specified by:

getWidth in interface Component

Overrides:

getWidth in class AbstractComponent<JmixResponsiveGridLayout>

getWidthSizeUnit

public SizeUnit getWidthSizeUnit()

Description copied from interface: Component

Gets the width property units.

Specified by:

getWidthSizeUnit in interface Component

Overrides:

getWidthSizeUnit in class AbstractComponent<JmixResponsiveGridLayout>

Returns:

units used in the width property.

setWidth

public void setWidth(@Nullable
 String width)

Description copied from interface: Component

Set component width in Component.getWidthSizeUnit()}

Specified by:

setWidth in interface Component

Overrides:

setWidth in class AbstractComponent<JmixResponsiveGridLayout>

isResponsive

public boolean isResponsive()

Description copied from interface: Component

Is the component responsive?

Specified by:

isResponsive in interface Component

Overrides:

isResponsive in class AbstractComponent<JmixResponsiveGridLayout>

Returns:

true if the component applies conditional CSS rules for width / height sizes.

setResponsive

public void setResponsive(boolean responsive)

Description copied from interface: Component

Sets component to be responsive by width and height.
If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.

Specified by:

setResponsive in interface Component

Overrides:

setResponsive in class AbstractComponent<JmixResponsiveGridLayout>

Parameters:

responsive - responsive flag

checkInitializedState

protected void checkInitializedState()