Package io.jmix.ui.component.impl

Class GridLayoutImpl

java.lang.Object

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

io.jmix.ui.component.impl.GridLayoutImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, GridLayout, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasMargin, HasRequiredIndicator, HasSpacing, LayoutClickNotifier, ShortcutNotifier

public class GridLayoutImpl
extends AbstractComponent<JmixGridLayout>
implements GridLayout

Nested Class Summary

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

GridLayout.Area

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

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.shared.Registration	layoutClickRegistration
protected List<Component>	ownComponents
protected Map<ShortcutAction,com.vaadin.event.ShortcutListener>	shortcuts

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

NAME

Constructor Summary

Constructors

Constructor	Description
GridLayoutImpl()

Method Summary

Modifier and Type	Method	Description
void	add(Component childComponent)	Adds a component to this container.
void	add(Component component, int col, int row)
void	add(Component childComponent, int col, int row, int col2, int row2)
Subscription	addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)	Adds a listener that is fired when user clicks inside the layout at any place.
void	addShortcutAction(ShortcutAction action)
void	attached()	Notifies all listeners that component has been attached.
protected JmixGridLayout	createComponent()
void	detached()	Notifies all listeners that component has been detached.
protected Component	findChildComponent(com.vaadin.ui.Component vComponent)
float	getColumnExpandRatio(int col)
int	getColumns()
Component	getComponent(int columnIndex, int rowIndex)	Gets the Component at given row and column.
Component	getComponent(String id)	Gets a component belonging to the whole components tree below this container.
GridLayout.Area	getComponentArea(Component childComponent)	Returns information about the area where given component is laid in the GridLayout.
Collection<Component>	getComponents()	Gets all components belonging to the whole components tree below this container.
MarginInfo	getMargin()
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.
float	getRowExpandRatio(int row)
int	getRows()
boolean	getSpacing()
protected void	internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
boolean	isRequiredIndicatorVisible()	Returns whether a required indicator should be shown.
void	remove(Component childComponent)	Removes a component from this container.
void	removeAll()	Removes all components from this container.
void	removeShortcutAction(ShortcutAction action)
void	setColumnExpandRatio(int col, float ratio)
void	setColumns(int columns)
void	setFrame(Frame frame)
void	setMargin(MarginInfo marginInfo)
void	setRequiredIndicatorVisible(boolean visible)	Sets whether a required indicator should be shown.
void	setRowExpandRatio(int row, float ratio)
void	setRows(int rows)
void	setSpacing(boolean enabled)

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, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, 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, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

getFrame

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

getCaption, setCaption

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

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

add, remove

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

getComponentNN

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

focusFirstComponent, getComponentNN

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

setMargin, setMargin

Field Details

ownComponents

protected List<Component> ownComponents

layoutClickRegistration

protected com.vaadin.shared.Registration layoutClickRegistration

shortcuts

protected Map<ShortcutAction,com.vaadin.event.ShortcutListener> shortcuts

Constructor Details

GridLayoutImpl

public GridLayoutImpl()

Method Details

createComponent

protected JmixGridLayout createComponent()

add

public void add(Component childComponent)

Description copied from interface: ComponentContainer

Adds a component to this container.

Specified by:

add in interface ComponentContainer

Parameters:

childComponent - a component to add

getColumnExpandRatio

public float getColumnExpandRatio(int col)

Specified by:

getColumnExpandRatio in interface GridLayout

setColumnExpandRatio

public void setColumnExpandRatio(int col,
 float ratio)

Specified by:

setColumnExpandRatio in interface GridLayout

getRowExpandRatio

public float getRowExpandRatio(int row)

Specified by:

getRowExpandRatio in interface GridLayout

setRowExpandRatio

public void setRowExpandRatio(int row,
 float ratio)

Specified by:

setRowExpandRatio in interface GridLayout

add

public void add(Component component,
 int col,
 int row)

Specified by:

add in interface GridLayout

add

public void add(Component childComponent,
 int col,
 int row,
 int col2,
 int row2)

Specified by:

add in interface GridLayout

getRows

public int getRows()

Specified by:

getRows in interface GridLayout

setRows

public void setRows(int rows)

Specified by:

setRows in interface GridLayout

getColumns

public int getColumns()

Specified by:

getColumns in interface GridLayout

setColumns

public void setColumns(int columns)

Specified by:

setColumns in interface GridLayout

getComponent

@Nullable
public Component getComponent(int columnIndex,
 int rowIndex)

Description copied from interface: GridLayout

Gets the Component at given row and column.

Specified by:

getComponent in interface GridLayout

Parameters:

columnIndex - the column index, starting from 0 for the leftmost column.

rowIndex - the row index, starting from 0 for the topmost row.

Returns:

Component in given cell or null if empty

getComponentArea

@Nullable
public GridLayout.Area getComponentArea(Component childComponent)

Description copied from interface: GridLayout

Returns information about the area where given component is laid in the GridLayout.

Specified by:

getComponentArea in interface GridLayout

Parameters:

childComponent - the component whose area information is requested.

Returns:

an Area object that contains information how component is laid in the grid

remove

public void remove(Component childComponent)

Description copied from interface: ComponentContainer

Removes a component from this container.

Specified by:

remove in interface ComponentContainer

Parameters:

childComponent - a component to remove

removeAll

public void removeAll()

Description copied from interface: ComponentContainer

Removes all components from this container.

Specified by:

removeAll in interface ComponentContainer

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<JmixGridLayout>

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

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface HasMargin

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface HasMargin

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface HasSpacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface HasSpacing

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 vComponent)

internalRemoveLayoutClickListener

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

addShortcutAction

public void addShortcutAction(ShortcutAction action)

Specified by:

addShortcutAction in interface ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(ShortcutAction action)

Specified by:

removeShortcutAction in interface ShortcutNotifier

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

Description copied from interface: HasRequiredIndicator

Returns whether a required indicator should be shown.

Specified by:

isRequiredIndicatorVisible in interface HasRequiredIndicator

Returns:

true if a required indicator should be shown, false otherwise

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean visible)

Description copied from interface: HasRequiredIndicator

Sets whether a required indicator should be shown.

Specified by:

setRequiredIndicatorVisible in interface HasRequiredIndicator

Parameters:

visible - true if a required indicator should be shown, false otherwise

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<JmixGridLayout>

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<JmixGridLayout>