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, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.ComponentContainer, io.jmix.ui.component.CssLayout, io.jmix.ui.component.HasComponents, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasRequiredIndicator, io.jmix.ui.component.LayoutClickNotifier, io.jmix.ui.component.OrderedContainer, io.jmix.ui.component.ShortcutNotifier

Direct Known Subclasses:

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

public abstract class AbstractCanvasLayout
extends io.jmix.ui.component.impl.CssLayoutImpl
implements CanvasLayout

Nested Class Summary

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

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

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

io.jmix.ui.component.LayoutClickNotifier.LayoutClickEvent

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

io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.ui.component.HBoxLayout	buttonsPanel
protected io.jmix.ui.UiComponents	components
protected io.jmix.ui.component.ComponentContainer	delegate
protected DashboardLayout	model
protected java.util.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 and Description
AbstractCanvasLayout()

Method Summary

Modifier and Type	Method and Description
void	addComponent(io.jmix.ui.component.Component component) Add specified component to the layout.
io.jmix.core.common.event.Subscription	addLayoutClickListener(java.util.function.Consumer<io.jmix.ui.component.LayoutClickNotifier.LayoutClickEvent> listener)
io.jmix.ui.component.HBoxLayout	createButtonsPanel() Creates an empty panel for dashboard layout actions.
io.jmix.ui.component.HBoxLayout	getButtonsPanel()
io.jmix.ui.component.Component	getDelegate()
java.util.Collection<io.jmix.ui.component.Component>	getLayoutComponents()
DashboardLayout	getModel()
java.util.UUID	getUuid()
int	getWeight()
<T extends io.jmix.ui.component.ComponentContainer> AbstractCanvasLayout	init(DashboardLayout model, java.lang.Class<T> componentClass)
AbstractCanvasLayout	init(DashboardLayout model, io.jmix.ui.component.ComponentContainer delegate)
void	setButtonsPanel(io.jmix.ui.component.HBoxLayout buttonsPanel) Sets a buttons panel.
void	setUuid(java.util.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.ComponentContainer

add, add, remove, remove, removeAll

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

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

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

add, getComponent, getComponentNN, indexOf

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

getFrame, setFrame

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

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

addShortcutAction, removeShortcutAction

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

delegate

protected io.jmix.ui.component.ComponentContainer delegate

buttonsPanel

protected io.jmix.ui.component.HBoxLayout buttonsPanel

uuid

protected java.util.UUID uuid

model

protected DashboardLayout model

components

@Autowired
protected io.jmix.ui.UiComponents components

Constructor Detail

AbstractCanvasLayout

public AbstractCanvasLayout()

Method Detail

init

public AbstractCanvasLayout init(DashboardLayout model,
                                 io.jmix.ui.component.ComponentContainer delegate)

init

public <T extends io.jmix.ui.component.ComponentContainer> AbstractCanvasLayout init(DashboardLayout model,
                                                                                     java.lang.Class<T> componentClass)

getDelegate

public io.jmix.ui.component.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(io.jmix.ui.component.Component component)

Description copied from interface: CanvasLayout

Add specified component to the layout.

Specified by:

addComponent in interface CanvasLayout

Parameters:

component - component

getLayoutComponents

public java.util.Collection<io.jmix.ui.component.Component> getLayoutComponents()

Specified by:

getLayoutComponents in interface CanvasLayout

Returns:

layout components

createButtonsPanel

public io.jmix.ui.component.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 io.jmix.ui.component.HBoxLayout getButtonsPanel()

Specified by:

getButtonsPanel in interface CanvasLayout

Returns:

buttons panel

setButtonsPanel

public void setButtonsPanel(io.jmix.ui.component.HBoxLayout buttonsPanel)

Description copied from interface: CanvasLayout

Sets a buttons panel.

Specified by:

setButtonsPanel in interface CanvasLayout

Parameters:

buttonsPanel - new buttons panel

addLayoutClickListener

public io.jmix.core.common.event.Subscription addLayoutClickListener(java.util.function.Consumer<io.jmix.ui.component.LayoutClickNotifier.LayoutClickEvent> listener)

Specified by:

addLayoutClickListener in interface io.jmix.ui.component.LayoutClickNotifier

Overrides:

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

setWeight

public void setWeight(int weight)

Specified by:

setWeight in interface HasWeight

getWeight

public int getWeight()

Specified by:

getWeight in interface HasWeight

getUuid

public java.util.UUID getUuid()

Specified by:

getUuid in interface CanvasLayout

Returns:

canvas layout id

setUuid

public void setUuid(java.util.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