Package io.jmix.dashboardsui.component.impl

Class AbstractCanvasLayout

java.lang.Object

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

io.jmix.ui.component.impl.AbstractOrderedLayout<com.vaadin.ui.CssLayout>

io.jmix.ui.component.impl.CssLayoutImpl

io.jmix.dashboardsui.component.impl.AbstractCanvasLayout

All Implemented Interfaces:

CanvasLayout, HasWeight, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, CssLayout, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasRequiredIndicator, LayoutClickNotifier, OrderedContainer, ShortcutNotifier

Direct Known Subclasses:

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

public abstract class AbstractCanvasLayout
extends CssLayoutImpl
implements CanvasLayout

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.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 HBoxLayout	buttonsPanel
protected UiComponents	components
protected ComponentContainer	delegate
protected DashboardLayout	model
protected UUID	uuid

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

layoutClickRegistration, ownComponents, 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.CssLayout

NAME

Constructor Summary

Constructors

Constructor	Description
AbstractCanvasLayout()

Method Summary

Modifier and Type	Method	Description
void	addComponent(Component component)	Add specified component to the layout.
Subscription	addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)	Adds a listener that is fired when user clicks inside the layout at any place.
HBoxLayout	createButtonsPanel()	Creates an empty panel for dashboard layout actions.
HBoxLayout	getButtonsPanel()
Component	getDelegate()
Collection<Component>	getLayoutComponents()
DashboardLayout	getModel()
UUID	getUuid()
int	getWeight()
AbstractCanvasLayout	init(DashboardLayout model, ComponentContainer delegate)
<T extends ComponentContainer> AbstractCanvasLayout	init(DashboardLayout model, Class<T> componentClass)
void	setButtonsPanel(HBoxLayout buttonsPanel)	Sets a buttons panel.
void	setUuid(UUID uuid)	Sets a canvas layout id.
void	setWeight(int weight)

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

createComponent, isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

add, add, addShortcutAction, attached, detached, findChildComponent, getComponent, getComponent, getComponents, getDescription, getOwnComponent, getOwnComponents, getOwnComponentsStream, indexOf, internalRemoveLayoutClickListener, remove, removeAll, removeShortcutAction, setDescription, setFrame

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

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, 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, 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, setFrame

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, 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.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.OrderedContainer

add, getComponent, getComponentNN, indexOf

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

addShortcutAction, removeShortcutAction

Field Details

delegate

protected ComponentContainer delegate

buttonsPanel

protected HBoxLayout buttonsPanel

uuid

protected UUID uuid

model

protected DashboardLayout model

components

@Autowired
protected UiComponents components

Constructor Details

AbstractCanvasLayout

public AbstractCanvasLayout()

Method Details

init

public AbstractCanvasLayout init(DashboardLayout model,
 ComponentContainer delegate)

init

public <T extends ComponentContainer>
AbstractCanvasLayout init(DashboardLayout model,
 Class<T> componentClass)

getDelegate

public Component getDelegate()

Specified by:

getDelegate in interface CanvasLayout

Returns:

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

addComponent

public void addComponent(Component component)

Description copied from interface: CanvasLayout

Add specified component to the layout.

Specified by:

addComponent in interface CanvasLayout

Parameters:

component - component

getLayoutComponents

public Collection<Component> getLayoutComponents()

Specified by:

getLayoutComponents in interface CanvasLayout

Returns:

layout components

createButtonsPanel

public HBoxLayout createButtonsPanel()

Description copied from interface: CanvasLayout

Creates an empty panel for dashboard layout actions.

Specified by:

createButtonsPanel in interface CanvasLayout

Returns:

empty buttons panel

See Also:

• ActionsProvider.getLayoutActions(DashboardLayout)

getButtonsPanel

public HBoxLayout getButtonsPanel()

Specified by:

getButtonsPanel in interface CanvasLayout

Returns:

buttons panel

setButtonsPanel

public void setButtonsPanel(HBoxLayout buttonsPanel)

Description copied from interface: CanvasLayout

Sets a buttons panel.

Specified by:

setButtonsPanel in interface CanvasLayout

Parameters:

buttonsPanel - new buttons panel

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

Overrides:

addLayoutClickListener in class AbstractOrderedLayout<com.vaadin.ui.CssLayout>

Parameters:

listener - a listener to add

setWeight

public void setWeight(int weight)

Specified by:

setWeight in interface HasWeight

getWeight

public int getWeight()

Specified by:

getWeight in interface HasWeight

getUuid

public UUID getUuid()

Specified by:

getUuid in interface CanvasLayout

Returns:

canvas layout id

setUuid

public void setUuid(UUID uuid)

Description copied from interface: CanvasLayout

Sets a canvas layout id.

Specified by:

setUuid in interface CanvasLayout

Parameters:

uuid - id

getModel

public DashboardLayout getModel()

Specified by:

getModel in interface CanvasLayout

Returns:

dashboard layout model