io.jmix.ui.component.impl

Class AbstractBox<T extends com.vaadin.ui.AbstractOrderedLayout>

java.lang.Object

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

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

All Implemented Interfaces:

AttachNotifier, BoxLayout, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasMargin, HasRequiredIndicator, HasSpacing, LayoutClickNotifier, OrderedContainer, ShortcutNotifier, SupportsExpandRatio

Direct Known Subclasses:

HBoxLayoutImpl, VBoxLayoutImpl

public abstract class AbstractBox<T extends com.vaadin.ui.AbstractOrderedLayout>
extends AbstractComponent<T>
implements BoxLayout

Nested Class Summary

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

ExpandingLayout.ExpandDirection

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

LayoutClickNotifier.LayoutClickEvent

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.shared.Registration	layoutClickRegistration
protected java.util.List<Component>	ownComponents
protected java.util.Map<ShortcutAction,com.vaadin.event.ShortcutListener>	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
AbstractBox()

Method Summary

Modifier and Type	Method and Description
void	add(Component childComponent) Adds a component to this container.
void	add(Component childComponent, int index)
io.jmix.core.common.event.Subscription	addLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener) Adds a listener that is fired when user clicks inside the layout at any place.
void	addShortcutAction(ShortcutAction action)
void	attached() Notifies all listeners that component has been attached.
protected void	attachToFrame(Component childComponent)
void	detached() Notifies all listeners that component has been detached.
void	expand(Component childComponent) Specifies the component that will be given maximum available space.
protected Component	findChildComponent(com.vaadin.ui.Component childComponent)
Component	getComponent(int index) Returns the component at the given position.
Component	getComponent(java.lang.String id) Gets a component belonging to the whole components tree below this container.
java.util.Collection<Component>	getComponents() Gets all components belonging to the whole components tree below this container.
float	getExpandRatio(Component component)
MarginInfo	getMargin()
Component	getOwnComponent(java.lang.String id) Gets component directly owned by this container.
java.util.Collection<Component>	getOwnComponents() Gets all components directly owned by this container.
java.util.stream.Stream<Component>	getOwnComponentsStream() Gets stream of all components directly owned by this container.
boolean	getSpacing()
int	indexOf(Component childComponent)
protected void	internalRemoveLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
boolean	isExpanded(Component component) Returns true if the component occupies the maximum available space.
boolean	isRequiredIndicatorVisible() Returns whether a required indicator should be shown.
void	remove(Component childComponent) Removes a component from this container.
void	removeAll() Removes all components from this container.
void	removeShortcutAction(ShortcutAction action)
void	resetExpanded() Resets the expanded component and provides equal space for all nested components.
void	setExpandRatio(Component component, float ratio) Sets expand ratio for the component.
void	setFrame(Frame frame)
void	setMargin(MarginInfo marginInfo)
void	setRequiredIndicatorVisible(boolean visible) Sets whether a required indicator should be shown.
void	setSpacing(boolean enabled)

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, 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, setDescription, 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.ExpandingLayout

getExpandDirection

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

getComponentNN

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

add, remove

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

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

setMargin, setMargin

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

getFrame

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

ownComponents

protected java.util.List<Component> ownComponents

layoutClickRegistration

protected com.vaadin.shared.Registration layoutClickRegistration

shortcuts

protected java.util.Map<ShortcutAction,com.vaadin.event.ShortcutListener> shortcuts

Constructor Detail

AbstractBox

public AbstractBox()

Method Detail

add

public void add(Component childComponent)

Description copied from interface: ComponentContainer

Adds a component to this container.

Specified by:

add in interface ComponentContainer

Parameters:

childComponent - a component to add

add

public void add(Component childComponent,
                int index)

Specified by:

add in interface OrderedContainer

indexOf

public int indexOf(Component childComponent)

Specified by:

indexOf in interface OrderedContainer

getComponent

@Nullable
public Component getComponent(int index)

Description copied from interface: OrderedContainer

Returns the component at the given position.

Specified by:

getComponent in interface OrderedContainer

Parameters:

index - component index

Returns:

the component at the given index or null.

attachToFrame

protected void attachToFrame(Component childComponent)

remove

public void remove(Component childComponent)

Description copied from interface: ComponentContainer

Removes a component from this container.

Specified by:

remove in interface ComponentContainer

Parameters:

childComponent - a component to remove

removeAll

public void removeAll()

Description copied from interface: ComponentContainer

Removes all components from this container.

Specified by:

removeAll in interface ComponentContainer

setFrame

public void setFrame(@Nullable
                     Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class AbstractComponent<T extends com.vaadin.ui.AbstractOrderedLayout>

getOwnComponent

@Nullable
public Component getOwnComponent(java.lang.String id)

Description copied from interface: HasComponents

Gets component directly owned by this container.

Specified by:

getOwnComponent in interface HasComponents

Returns:

component or null if not found

getComponent

@Nullable
public Component getComponent(java.lang.String id)

Description copied from interface: HasComponents

Gets a component belonging to the whole components tree below this container.

Specified by:

getComponent in interface HasComponents

Returns:

component or null if not found

getOwnComponents

public java.util.Collection<Component> getOwnComponents()

Description copied from interface: HasComponents

Gets all components directly owned by this container.

Specified by:

getOwnComponents in interface HasComponents

Returns:

all components directly owned by this container

getOwnComponentsStream

public java.util.stream.Stream<Component> getOwnComponentsStream()

Description copied from interface: HasComponents

Gets stream of all components directly owned by this container.

Specified by:

getOwnComponentsStream in interface HasComponents

Returns:

stream of all components directly owned by this container

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: HasComponents

Gets all components belonging to the whole components tree below this container.

Specified by:

getComponents in interface HasComponents

Returns:

all components belonging to the whole components tree below this container

expand

public void expand(Component childComponent)

Description copied from interface: ExpandingLayout

Specifies the component that will be given maximum available space.

Specified by:

expand in interface ExpandingLayout

Parameters:

childComponent - the component

resetExpanded

public void resetExpanded()

Description copied from interface: ExpandingLayout

Resets the expanded component and provides equal space for all nested components.

Specified by:

resetExpanded in interface ExpandingLayout

isExpanded

public boolean isExpanded(Component component)

Description copied from interface: ExpandingLayout

Returns true if the component occupies the maximum available space.

Specified by:

isExpanded in interface ExpandingLayout

Parameters:

component - component to check

Returns:

true if the component occupies the maximum available space

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

addLayoutClickListener

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

Description copied from interface: LayoutClickNotifier

Adds a listener that is fired when user clicks inside the layout at any place.

Specified by:

addLayoutClickListener in interface LayoutClickNotifier

Parameters:

listener - a listener to add

findChildComponent

@Nullable
protected Component findChildComponent(com.vaadin.ui.Component childComponent)

internalRemoveLayoutClickListener

protected void internalRemoveLayoutClickListener(java.util.function.Consumer<LayoutClickNotifier.LayoutClickEvent> listener)

addShortcutAction

public void addShortcutAction(ShortcutAction action)

Specified by:

addShortcutAction in interface ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(ShortcutAction action)

Specified by:

removeShortcutAction in interface ShortcutNotifier

setExpandRatio

public void setExpandRatio(Component component,
                           float ratio)

Description copied from interface: SupportsExpandRatio

Sets expand ratio for the component. The ratio must be greater than or equal to 0.

Specified by:

setExpandRatio in interface SupportsExpandRatio

Parameters:

component - component to expand with ratio

ratio - ratio

getExpandRatio

public float getExpandRatio(Component component)

Specified by:

getExpandRatio in interface SupportsExpandRatio

Parameters:

component - component for which returns ratio

Returns:

ratio for the component, 0.0f by default

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

attached

public void attached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been attached.

Specified by:

attached in interface AttachNotifier

Overrides:

attached in class AbstractComponent<T extends com.vaadin.ui.AbstractOrderedLayout>

detached

public void detached()

Description copied from interface: AttachNotifier

Notifies all listeners that component has been detached.

Specified by:

detached in interface AttachNotifier

Overrides:

detached in class AbstractComponent<T extends com.vaadin.ui.AbstractOrderedLayout>