Package io.jmix.dashboardsui.component

Interface CanvasLayout

All Superinterfaces:

Component, ComponentContainer, HasComponents, HasWeight, LayoutClickNotifier

All Known Implementing Classes:

AbstractCanvasLayout, CanvasCssLayout, CanvasGridLayout, CanvasHorizontalLayout, CanvasResponsiveLayout, CanvasRootLayout, CanvasVerticalLayout, CanvasWidgetLayout

public interface CanvasLayout
extends Component, ComponentContainer, LayoutClickNotifier, HasWeight

UI representation of DashboardLayout model on the Dashboard component.

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

LayoutClickNotifier.LayoutClickEvent

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
void	addComponent(Component component)	Add specified component to the layout.
HBoxLayout	createButtonsPanel()	Creates an empty panel for dashboard layout actions.
HBoxLayout	getButtonsPanel()
Component	getDelegate()
Collection<Component>	getLayoutComponents()
DashboardLayout	getModel()
UUID	getUuid()
void	setButtonsPanel(HBoxLayout buttonsPanel)	Sets a buttons panel.
void	setUuid(UUID uuid)	Sets a canvas layout id.

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

add, add, remove, remove, removeAll

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

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

Methods inherited from interface io.jmix.dashboardsui.component.HasWeight

getWeight, setWeight

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

addLayoutClickListener

Method Details

getDelegate

Component getDelegate()

Returns:

UI component that contains child components. It can be ComponentContainer or ResponsiveGridLayout.

addComponent

void addComponent(Component component)

Add specified component to the layout.

Parameters:

component - component

getLayoutComponents

Collection<Component> getLayoutComponents()

Returns:

layout components

createButtonsPanel

HBoxLayout createButtonsPanel()

Creates an empty panel for dashboard layout actions.

Returns:

empty buttons panel

See Also:

• ActionsProvider.getLayoutActions(DashboardLayout)

getButtonsPanel

HBoxLayout getButtonsPanel()

Returns:

buttons panel

setButtonsPanel

void setButtonsPanel(HBoxLayout buttonsPanel)

Sets a buttons panel.

Parameters:

buttonsPanel - new buttons panel

getUuid

UUID getUuid()

Returns:

canvas layout id

setUuid

void setUuid(UUID uuid)

Sets a canvas layout id.

Parameters:

uuid - id

getModel

DashboardLayout getModel()

Returns:

dashboard layout model