Package io.jmix.ui.component.impl

Class ScrollBoxLayoutImpl

java.lang.Object

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

io.jmix.ui.component.impl.ScrollBoxLayoutImpl

All Implemented Interfaces:

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

public class ScrollBoxLayoutImpl
extends AbstractComponent<JmixScrollBoxLayout>
implements ScrollBoxLayout

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

HasOrientation.Orientation

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

LayoutClickNotifier.LayoutClickEvent

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

ScrollBoxLayout.ScrollBarPolicy

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.shared.Registration	layoutClickRegistration
protected HasOrientation.Orientation	orientation
protected List<Component>	ownComponents
protected ScrollBoxLayout.ScrollBarPolicy	scrollBarPolicy
protected static final String	SCROLLBOX_CONTENT_STYLENAME
protected static final String	SCROLLBOX_STYLENAME
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.ScrollBoxLayout

NAME

Constructor Summary

Constructors

Constructor	Description
ScrollBoxLayoutImpl()

Method Summary

Modifier and Type	Method	Description
void	add(Component childComponent)	Adds a component to this container.
void	add(Component childComponent, int index)
Subscription	addLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)	Adds a listener that is fired when user clicks inside the layout at any place.
void	addShortcutAction(ShortcutAction action)
protected void	applyScrollBarsPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)
void	attached()	Notifies all listeners that component has been attached.
protected JmixScrollBoxLayout	createComponent()
void	detached()	Notifies all listeners that component has been detached.
protected com.vaadin.ui.Component	findChildComponent(com.vaadin.ui.Component vComponent)
protected Component	findExistingComponent(com.vaadin.ui.Component vComponent)
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.
Collection<Component>	getComponents()	Gets all components belonging to the whole components tree below this container.
protected com.vaadin.ui.AbstractOrderedLayout	getContent()
float	getContentHeight()
SizeUnit	getContentHeightSizeUnit()
String	getContentMaxHeight()
String	getContentMaxWidth()
String	getContentMinHeight()
String	getContentMinWidth()
float	getContentWidth()
SizeUnit	getContentWidthSizeUnit()
MarginInfo	getMargin()
HasOrientation.Orientation	getOrientation()
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.
ScrollBoxLayout.ScrollBarPolicy	getScrollBarPolicy()
int	getScrollLeft()	Gets scroll left offset.
int	getScrollTop()	Gets scroll top offset.
boolean	getSpacing()
String	getStyleName()	Styles implementation is client-type-specific.
int	indexOf(Component component)
protected void	initComponent(JmixScrollBoxLayout component)
protected void	internalRemoveLayoutClickListener(Consumer<LayoutClickNotifier.LayoutClickEvent> listener)
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	setContentHeight(String height)	Sets content height.
void	setContentMaxHeight(String maxHeight)	Sets maximum CSS height for content.
void	setContentMaxWidth(String maxWidth)	Sets maximum CSS width for content.
void	setContentMinHeight(String minHeight)	Sets minimum CSS height for content.
void	setContentMinWidth(String minWidth)	Sets minimum CSS width for content.
void	setContentWidth(String width)	Sets content width.
void	setFrame(Frame frame)
void	setMargin(MarginInfo marginInfo)
void	setOrientation(HasOrientation.Orientation orientation)
void	setRequiredIndicatorVisible(boolean visible)	Sets whether a required indicator should be shown.
void	setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)
void	setScrollLeft(int scrollLeft)	Sets scroll left offset.
void	setScrollTop(int scrollTop)	Sets scroll top offset.
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.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.HasMargin

setMargin, setMargin

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

getComponentNN

Field Details

SCROLLBOX_CONTENT_STYLENAME

protected static final String SCROLLBOX_CONTENT_STYLENAME

See Also:

• Constant Field Values

SCROLLBOX_STYLENAME

protected static final String SCROLLBOX_STYLENAME

See Also:

• Constant Field Values

ownComponents

protected List<Component> ownComponents

layoutClickRegistration

protected com.vaadin.shared.Registration layoutClickRegistration

orientation

protected HasOrientation.Orientation orientation

scrollBarPolicy

protected ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy

shortcuts

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

Constructor Details

ScrollBoxLayoutImpl

public ScrollBoxLayoutImpl()

Method Details

createComponent

protected JmixScrollBoxLayout createComponent()

initComponent

protected void initComponent(JmixScrollBoxLayout component)

getContent

protected com.vaadin.ui.AbstractOrderedLayout getContent()

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.

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

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

Returns:

current style name.

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

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

getOrientation

public HasOrientation.Orientation getOrientation()

Specified by:

getOrientation in interface HasOrientation

setOrientation

public void setOrientation(HasOrientation.Orientation orientation)

Specified by:

setOrientation in interface HasOrientation

getScrollBarPolicy

public ScrollBoxLayout.ScrollBarPolicy getScrollBarPolicy()

Specified by:

getScrollBarPolicy in interface ScrollBoxLayout

setScrollBarPolicy

public void setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)

Specified by:

setScrollBarPolicy in interface ScrollBoxLayout

setContentWidth

public void setContentWidth(@Nullable
 String width)

Description copied from interface: ScrollBoxLayout

Sets content width.

Specified by:

setContentWidth in interface ScrollBoxLayout

Parameters:

width - width

getContentWidth

public float getContentWidth()

Specified by:

getContentWidth in interface ScrollBoxLayout

Returns:

content width value

getContentWidthSizeUnit

public SizeUnit getContentWidthSizeUnit()

Specified by:

getContentWidthSizeUnit in interface ScrollBoxLayout

Returns:

content width size unit

setContentHeight

public void setContentHeight(@Nullable
 String height)

Description copied from interface: ScrollBoxLayout

Sets content height.

Specified by:

setContentHeight in interface ScrollBoxLayout

Parameters:

height - height

getContentHeight

public float getContentHeight()

Specified by:

getContentHeight in interface ScrollBoxLayout

Returns:

content height value

getContentHeightSizeUnit

public SizeUnit getContentHeightSizeUnit()

Specified by:

getContentHeightSizeUnit in interface ScrollBoxLayout

Returns:

content height size unit

setContentMinWidth

public void setContentMinWidth(String minWidth)

Description copied from interface: ScrollBoxLayout

Sets minimum CSS width for content. Examples: "640px", "auto".

Specified by:

setContentMinWidth in interface ScrollBoxLayout

Parameters:

minWidth - minimum width

getContentMinWidth

@Nullable
public String getContentMinWidth()

Specified by:

getContentMinWidth in interface ScrollBoxLayout

Returns:

minimal content width

setContentMaxWidth

public void setContentMaxWidth(String maxWidth)

Description copied from interface: ScrollBoxLayout

Sets maximum CSS width for content. Examples: "640px", "100%".

Specified by:

setContentMaxWidth in interface ScrollBoxLayout

Parameters:

maxWidth - maximum width

getContentMaxWidth

@Nullable
public String getContentMaxWidth()

Specified by:

getContentMaxWidth in interface ScrollBoxLayout

Returns:

maximum content width

setContentMinHeight

public void setContentMinHeight(String minHeight)

Description copied from interface: ScrollBoxLayout

Sets minimum CSS height for content. Examples: "640px", "auto".

Specified by:

setContentMinHeight in interface ScrollBoxLayout

Parameters:

minHeight - minimum height

getContentMinHeight

@Nullable
public String getContentMinHeight()

Specified by:

getContentMinHeight in interface ScrollBoxLayout

Returns:

minimum content width

setContentMaxHeight

public void setContentMaxHeight(String maxHeight)

Description copied from interface: ScrollBoxLayout

Sets maximum CSS height for content. Examples: "640px", "100%".

Specified by:

setContentMaxHeight in interface ScrollBoxLayout

Parameters:

maxHeight - maximum height

getContentMaxHeight

@Nullable
public String getContentMaxHeight()

Specified by:

getContentMaxHeight in interface ScrollBoxLayout

Returns:

maximum content width

addLayoutClickListener

public Subscription addLayoutClickListener(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

internalRemoveLayoutClickListener

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

findChildComponent

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

findExistingComponent

@Nullable
protected Component findExistingComponent(@Nullable
 com.vaadin.ui.Component vComponent)

applyScrollBarsPolicy

protected void applyScrollBarsPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)

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

addShortcutAction

public void addShortcutAction(ShortcutAction action)

Specified by:

addShortcutAction in interface ShortcutNotifier

removeShortcutAction

public void removeShortcutAction(ShortcutAction action)

Specified by:

removeShortcutAction in interface ShortcutNotifier

getScrollLeft

public int getScrollLeft()

Description copied from interface: ScrollBoxLayout

Gets scroll left offset.

Scrolling offset is the number of pixels this scrollable has been scrolled right.

Specified by:

getScrollLeft in interface ScrollBoxLayout

Returns:

horizontal scrolling position in pixels

setScrollLeft

public void setScrollLeft(int scrollLeft)

Description copied from interface: ScrollBoxLayout

Sets scroll left offset.

Scrolling offset is the number of pixels this scrollable has been scrolled right.

Specified by:

setScrollLeft in interface ScrollBoxLayout

Parameters:

scrollLeft - the xOffset

getScrollTop

public int getScrollTop()

Description copied from interface: ScrollBoxLayout

Gets scroll top offset.

Scrolling offset is the number of pixels this scrollable has been scrolled down.

Specified by:

getScrollTop in interface ScrollBoxLayout

Returns:

vertical scrolling position in pixels

setScrollTop

public void setScrollTop(int scrollTop)

Description copied from interface: ScrollBoxLayout

Sets scroll top offset.

Scrolling offset is the number of pixels this scrollable has been scrolled down.

Specified by:

setScrollTop in interface ScrollBoxLayout

Parameters:

scrollTop - the yOffset

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

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