Package io.jmix.ui.component.impl
Class ButtonsPanelImpl
java.lang.Object
io.jmix.ui.component.impl.AbstractComponent<T>
io.jmix.ui.component.impl.AbstractOrderedLayout<JmixFlowLayout>
io.jmix.ui.component.impl.FlowBoxLayoutImpl
io.jmix.ui.component.impl.ButtonsPanelImpl
- All Implemented Interfaces:
AttachNotifier
,ButtonsPanel
,Component
,Component.BelongToFrame
,Component.HasCaption
,Component.HasDescription
,Component.HasIcon
,Component.HasXmlDescriptor
,Component.Wrapper
,ComponentContainer
,FlowBoxLayout
,HasComponents
,HasContextHelp
,HasDebugId
,HasHtmlCaption
,HasHtmlDescription
,HasHtmlSanitizer
,HasMargin
,HasRequiredIndicator
,HasSpacing
,LayoutClickNotifier
,OrderedContainer
,ShortcutNotifier
,VisibilityChangeNotifier
public class ButtonsPanelImpl
extends FlowBoxLayoutImpl
implements ButtonsPanel, VisibilityChangeNotifier
-
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
Nested classes/interfaces inherited from interface io.jmix.ui.component.VisibilityChangeNotifier
VisibilityChangeNotifier.VisibilityChangeEvent
-
Field Summary
Fields inherited from class io.jmix.ui.component.impl.FlowBoxLayoutImpl
FLOWLAYOUT_STYLENAME
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.ButtonsPanel
NAME
Fields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Fields inherited from interface io.jmix.ui.component.FlowBoxLayout
NAME
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionStyles implementation is client-type-specific.protected void
initComponent
(JmixFlowLayout component) boolean
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.void
setStyleName
(String name) Sets one or more style names of the component, replacing any previous styles.void
setVisible
(boolean visible) Sets visibility value for the component.Methods inherited from class io.jmix.ui.component.impl.FlowBoxLayoutImpl
createComponent, getMargin, getSpacing, isRequiredIndicatorVisible, setMargin, setRequiredIndicatorVisible, setSpacing
Methods inherited from class io.jmix.ui.component.impl.AbstractOrderedLayout
add, add, addLayoutClickListener, 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, 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, setValidationError, 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, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, 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.HasMargin
getMargin, setMargin, setMargin, setMargin
Methods inherited from interface io.jmix.ui.component.HasRequiredIndicator
isRequiredIndicatorVisible, setRequiredIndicatorVisible
Methods inherited from interface io.jmix.ui.component.HasSpacing
getSpacing, setSpacing
Methods inherited from interface io.jmix.ui.component.LayoutClickNotifier
addLayoutClickListener
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
-
BUTTONS_PANEL_STYLENAME
- See Also:
-
alwaysVisible
protected boolean alwaysVisible
-
-
Constructor Details
-
ButtonsPanelImpl
public ButtonsPanelImpl()
-
-
Method Details
-
initComponent
-
setStyleName
Description copied from interface:Component
Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.- Specified by:
setStyleName
in interfaceComponent
- Overrides:
setStyleName
in classFlowBoxLayoutImpl
- Parameters:
name
- one or more style names separated by space.
-
getStyleName
Description copied from interface:Component
Styles implementation is client-type-specific.- Specified by:
getStyleName
in interfaceComponent
- Overrides:
getStyleName
in classFlowBoxLayoutImpl
- Returns:
- current style name.
-
setVisible
public void setVisible(boolean visible) Description copied from interface:Component
Sets visibility value for the component.
Visible components are drawn in the user interface, while invisible ones are not. The effect is not a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent.- Specified by:
setVisible
in interfaceComponent
- Overrides:
setVisible
in classAbstractComponent<JmixFlowLayout>
- Parameters:
visible
- visible flag
-
addVisibilityChangeListener
public Subscription addVisibilityChangeListener(Consumer<VisibilityChangeNotifier.VisibilityChangeEvent> listener) - Specified by:
addVisibilityChangeListener
in interfaceVisibilityChangeNotifier
-
setAlwaysVisible
public void setAlwaysVisible(boolean alwaysVisible) Description copied from interface:ButtonsPanel
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 isfalse
.- Specified by:
setAlwaysVisible
in interfaceButtonsPanel
- Parameters:
alwaysVisible
- specifies whether buttons panel is always displayed on the lookup screen
-
isAlwaysVisible
public boolean isAlwaysVisible()Description copied from interface:ButtonsPanel
Returns whether buttons panel is always displayed on the lookup screen. Default value isfalse
.- Specified by:
isAlwaysVisible
in interfaceButtonsPanel
- Returns:
- {code true} if the buttons panel is always displayed on the lookup screen
-