io.jmix.dashboardsui.component.impl

Class CanvasCssLayout

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

io.jmix.dashboardsui.component.impl.CanvasCssLayout

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

public class CanvasCssLayout
extends AbstractCanvasLayout

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.CssLayout	cssLayout
static java.lang.String	NAME

Fields inherited from class io.jmix.dashboardsui.component.impl.AbstractCanvasLayout

buttonsPanel, components, delegate, model, 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

Constructor Summary

Constructors

Constructor and Description
CanvasCssLayout()

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.CssLayout	getDelegate()
CanvasCssLayout	init(CssLayout cssLayoutModel)

Methods inherited from class io.jmix.dashboardsui.component.impl.AbstractCanvasLayout

createButtonsPanel, getButtonsPanel, getLayoutComponents, getModel, getUuid, getWeight, init, init, setButtonsPanel, setUuid, setWeight

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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

cssLayout

protected io.jmix.ui.component.CssLayout cssLayout

Constructor Detail

CanvasCssLayout

public CanvasCssLayout()

Method Detail

init

public CanvasCssLayout init(CssLayout cssLayoutModel)

getDelegate

public io.jmix.ui.component.CssLayout getDelegate()

Specified by:

getDelegate in interface CanvasLayout

Overrides:

getDelegate in class AbstractCanvasLayout

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

Overrides:

addComponent in class AbstractCanvasLayout

Parameters:

component - component

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 AbstractCanvasLayout