io.jmix.ui.component

Interface ButtonsPanel

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, FlowBoxLayout, HasComponents, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasMargin, HasRequiredIndicator, HasSpacing, LayoutClickNotifier, OrderedContainer, ShortcutNotifier

All Known Implementing Classes:

ButtonsPanelImpl

@StudioComponent(caption="ButtonsPanel",
                 category="Containers",
                 xmlElement="buttonsPanel",
                 icon="io/jmix/ui/icon/container/buttonsPanel.svg",
                 canvasBehaviour=CONTAINER,
                 containerType=FLOW,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/containers/buttons-panel.html")
public interface ButtonsPanel
extends FlowBoxLayout

A container that streamlines the use and placement of the components (usually, buttons) for data management in a components that implement HasButtonsPanel interface.

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 and Description
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
boolean	isAlwaysVisible() Returns whether buttons panel is always displayed on the lookup screen.
void	setAlwaysVisible(boolean alwaysVisible) Sets whether or not buttons panel is always displayed on the lookup screen.

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

add, getComponent, getComponentNN, indexOf

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.Component.BelongToFrame

getFrame, setFrame

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

getMargin, setMargin, setMargin, setMargin

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

getSpacing, setSpacing

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

addLayoutClickListener

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setAlwaysVisible

@StudioProperty(defaultValue="false")
void setAlwaysVisible(boolean alwaysVisible)

Sets whether or not buttons panel is always displayed on the lookup screen. If the attribute value is true, the buttons panel is not hidden. Default value is false.

Parameters:

alwaysVisible - specifies whether buttons panel is always displayed on the lookup screen

isAlwaysVisible

boolean isAlwaysVisible()

Returns whether buttons panel is always displayed on the lookup screen. Default value is false.

Returns:

{code true} if the buttons panel is always displayed on the lookup screen