Package io.jmix.ui.component.impl

Class FlowBoxLayoutImpl

java.lang.Object

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

io.jmix.ui.component.impl.AbstractOrderedLayout<JmixFlowLayout>

io.jmix.ui.component.impl.FlowBoxLayoutImpl

All Implemented Interfaces:

AttachNotifier, 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

Direct Known Subclasses:

ButtonsPanelImpl

public class FlowBoxLayoutImpl
extends AbstractOrderedLayout<JmixFlowLayout>
implements FlowBoxLayout

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 static final String	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.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

Constructor Summary

Constructors

Constructor	Description
FlowBoxLayoutImpl()

Method Summary

Modifier and Type	Method	Description
protected JmixFlowLayout	createComponent()
MarginInfo	getMargin()
boolean	getSpacing()
String	getStyleName()	Styles implementation is client-type-specific.
boolean	isRequiredIndicatorVisible()	Returns whether a required indicator should be shown.
void	setMargin(MarginInfo marginInfo)
void	setRequiredIndicatorVisible(boolean visible)	Sets whether a required indicator should be shown.
void	setSpacing(boolean enabled)
void	setStyleName(String styleName)	Sets one or more style names of the component, replacing any previous styles.

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, 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, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, 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.HasMargin

setMargin, setMargin

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

FLOWLAYOUT_STYLENAME

protected static final String FLOWLAYOUT_STYLENAME

See Also:

• Constant Field Values

Constructor Details

FlowBoxLayoutImpl

public FlowBoxLayoutImpl()

Method Details

createComponent

protected JmixFlowLayout createComponent()

setStyleName

public void setStyleName(@Nullable
 String styleName)

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 interface Component

Overrides:

setStyleName in class AbstractComponent<JmixFlowLayout>

Parameters:

styleName - one or more style names separated by space.

getStyleName

public String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class AbstractComponent<JmixFlowLayout>

Returns:

current style name.

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface HasMargin

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface HasMargin

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface HasSpacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface HasSpacing

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

Description copied from interface: HasRequiredIndicator

Returns whether a required indicator should be shown.

Specified by:

isRequiredIndicatorVisible in interface HasRequiredIndicator

Returns:

true if a required indicator should be shown, false otherwise

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean visible)

Description copied from interface: HasRequiredIndicator

Sets whether a required indicator should be shown.

Specified by:

setRequiredIndicatorVisible in interface HasRequiredIndicator

Parameters:

visible - true if a required indicator should be shown, false otherwise