Package io.jmix.ui.component.impl

Class GroupBoxImpl

java.lang.Object

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

io.jmix.ui.component.impl.GroupBoxImpl

All Implemented Interfaces:

AttachNotifier, Collapsable, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, GroupBoxLayout, HasBorder, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOrientation, HasOuterMargin, HasRequiredIndicator, HasSpacing, OrderedContainer, ShortcutNotifier, SupportsExpandRatio, org.springframework.beans.factory.InitializingBean

public class GroupBoxImpl
extends AbstractComponent<JmixGroupBox>
implements GroupBoxLayout, org.springframework.beans.factory.InitializingBean

Nested Class Summary

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

Collapsable.ExpandedStateChangeEvent

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

ExpandingLayout.ExpandDirection

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

HasContextHelp.ContextHelpIconClickEvent

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

HasOrientation.Orientation

Field Summary

Fields

Modifier and Type	Field	Description
protected HasOrientation.Orientation	orientation
protected List<Component>	ownComponents
protected 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

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

NAME

Constructor Summary

Constructors

Constructor	Description
GroupBoxImpl()

Method Summary

Modifier and Type	Method	Description
void	add(Component childComponent)	Adds a component to this container.
void	add(Component childComponent, int index)
Subscription	addExpandedStateChangeListener(Consumer<Collapsable.ExpandedStateChangeEvent> listener)
void	addShortcutAction(ShortcutAction action)
void	afterPropertiesSet()
void	attached()	Notifies all listeners that component has been attached.
protected JmixGroupBox	createComponent()
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 void	fireExpandStateChange(boolean expanded, boolean invokedByUser)
Component	getComponent(int index)	Returns the component at the given position.
Component	getComponent(String id)	Gets a component belonging to the whole components tree below this container.
protected com.vaadin.ui.AbstractOrderedLayout	getComponentContent()
Collection<Component>	getComponents()	Gets all components belonging to the whole components tree below this container.
ExpandingLayout.ExpandDirection	getExpandDirection()
float	getExpandRatio(Component component)
HasOrientation.Orientation	getOrientation()
MarginInfo	getOuterMargin()
Component	getOwnComponent(String id)	Gets component directly owned by this container.
Collection<Component>	getOwnComponents()	Gets all components directly owned by this container.
Stream<Component>	getOwnComponentsStream()	Gets stream of all components directly owned by this container.
boolean	getSpacing()
String	getStyleName()	Styles implementation is client-type-specific.
int	indexOf(Component component)
protected void	initComponent(JmixGroupBox component)
boolean	isBorderVisible()
boolean	isCollapsable()
boolean	isExpanded()
boolean	isExpanded(Component component)	Returns true if the component occupies the maximum available space.
boolean	isRequiredIndicatorVisible()	Returns whether a required indicator should be shown.
boolean	isShowAsPanel()
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	setBorderVisible(boolean borderVisible)
void	setCollapsable(boolean collapsable)
void	setExpanded(boolean expanded)
void	setExpandRatio(Component component, float ratio)	Sets expand ratio for the component.
void	setFrame(Frame frame)
void	setOrientation(HasOrientation.Orientation orientation)
void	setOuterMargin(MarginInfo marginInfo)	Sets margins on all sides according to the passed MarginInfo object.
void	setRequiredIndicatorVisible(boolean visible)	Sets whether a required indicator should be shown.
void	setShowAsPanel(boolean showAsPanel)	Sets layout style as a Vaadin Panel
void	setSpacing(boolean enabled)
void	setStyleName(String name)	Sets one or more style names of the component, replacing any previous styles.

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

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

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

focusFirstComponent, getComponentNN

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

setOuterMargin, setOuterMargin

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

getComponentNN

Field Details

ownComponents

protected List<Component> ownComponents

orientation

protected HasOrientation.Orientation orientation

shortcuts

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

Constructor Details

GroupBoxImpl

public GroupBoxImpl()

Method Details

createComponent

protected JmixGroupBox createComponent()

initComponent

protected void initComponent(JmixGroupBox component)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

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 component)

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.

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

getComponentContent

protected com.vaadin.ui.AbstractOrderedLayout getComponentContent()

getOwnComponent

@Nullable
public Component getOwnComponent(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(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 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 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 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

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface Collapsable

getExpandDirection

public ExpandingLayout.ExpandDirection getExpandDirection()

Specified by:

getExpandDirection in interface ExpandingLayout

Returns:

expand direction

See Also:

• ExpandingLayout.ExpandDirection

setExpanded

public void setExpanded(boolean expanded)

Specified by:

setExpanded in interface Collapsable

isCollapsable

public boolean isCollapsable()

Specified by:

isCollapsable in interface Collapsable

setCollapsable

public void setCollapsable(boolean collapsable)

Specified by:

setCollapsable in interface Collapsable

addExpandedStateChangeListener

public Subscription addExpandedStateChangeListener(Consumer<Collapsable.ExpandedStateChangeEvent> listener)

Specified by:

addExpandedStateChangeListener in interface Collapsable

fireExpandStateChange

protected void fireExpandStateChange(boolean expanded,
 boolean invokedByUser)

isBorderVisible

public boolean isBorderVisible()

Specified by:

isBorderVisible in interface HasBorder

setBorderVisible

public void setBorderVisible(boolean borderVisible)

Specified by:

setBorderVisible in interface HasBorder

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface HasSpacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface HasSpacing

getOrientation

public HasOrientation.Orientation getOrientation()

Specified by:

getOrientation in interface HasOrientation

setOrientation

public void setOrientation(HasOrientation.Orientation orientation)

Specified by:

setOrientation in interface HasOrientation

setShowAsPanel

public void setShowAsPanel(boolean showAsPanel)

Description copied from interface: GroupBoxLayout

Sets layout style as a Vaadin Panel

Specified by:

setShowAsPanel in interface GroupBoxLayout

Parameters:

showAsPanel - whether the layout should appear as a Vaadin Panel

isShowAsPanel

public boolean isShowAsPanel()

Specified by:

isShowAsPanel in interface GroupBoxLayout

Returns:

true if layout looks like Vaadin Panel

setStyleName

public void setStyleName(@Nullable
 String name)

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

Parameters:

name - 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<JmixGroupBox>

Returns:

current style name.

addShortcutAction

public void addShortcutAction(ShortcutAction action)

Specified by:

addShortcutAction in interface ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(ShortcutAction action)

Specified by:

removeShortcutAction in interface ShortcutNotifier

setOuterMargin

public void setOuterMargin(MarginInfo marginInfo)

Description copied from interface: HasOuterMargin

Sets margins on all sides according to the passed MarginInfo object.

Specified by:

setOuterMargin in interface HasOuterMargin

Parameters:

marginInfo - the MarginInfo object that describes the margin settings for each side of a Component.

getOuterMargin

public MarginInfo getOuterMargin()

Specified by:

getOuterMargin in interface HasOuterMargin

Returns:

the MarginInfo object that describes the margin settings for each side of a Component.

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

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