io.jmix.ui.component

Interface ScrollBoxLayout

All Superinterfaces:

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

All Known Implementing Classes:

ScrollBoxLayoutImpl

@StudioComponent(caption="VerticalScrollBox",
                 category="Containers",
                 xmlElement="scrollBox",
                 icon="io/jmix/ui/icon/container/verticalScrollBox.svg",
                 canvasBehaviour=CONTAINER,
                 containerType=SCROLL_BOX,
                 unsupportedProperties="orientation",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/containers/scroll-box-layout.html")
public interface ScrollBoxLayout
extends OrderedContainer, Component.BelongToFrame, HasMargin, HasSpacing, HasOrientation, Component.HasIcon, Component.HasCaption, ShortcutNotifier, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasRequiredIndicator, LayoutClickNotifier, HasHtmlSanitizer

Component container that shows scrollbars if its content does not fit the viewport.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScrollBoxLayout.ScrollBarPolicy

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

HasOrientation.Orientation

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 and Description
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
float	getContentHeight()
SizeUnit	getContentHeightSizeUnit()
java.lang.String	getContentMaxHeight()
java.lang.String	getContentMaxWidth()
java.lang.String	getContentMinHeight()
java.lang.String	getContentMinWidth()
float	getContentWidth()
SizeUnit	getContentWidthSizeUnit()
ScrollBoxLayout.ScrollBarPolicy	getScrollBarPolicy()
int	getScrollLeft() Gets scroll left offset.
int	getScrollTop() Gets scroll top offset.
void	setContentHeight(java.lang.String height) Sets content height.
void	setContentMaxHeight(java.lang.String maxHeight) Sets maximum CSS height for content.
void	setContentMaxWidth(java.lang.String maxWidth) Sets maximum CSS width for content.
void	setContentMinHeight(java.lang.String minHeight) Sets minimum CSS height for content.
void	setContentMinWidth(java.lang.String minWidth) Sets minimum CSS width for content.
void	setContentWidth(java.lang.String width) Sets content width.
void	setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)
void	setScrollLeft(int scrollLeft) Sets scroll left offset.
void	setScrollTop(int scrollTop) Sets scroll top offset.

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

add, getComponent, getComponentNN, indexOf

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

add, add, remove, remove, removeAll

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, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

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

getFrame, setFrame

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

getMargin, setMargin, setMargin, setMargin

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

getSpacing, setSpacing

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

getOrientation, setOrientation

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

getIcon, setIcon, setIconFromSet

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

addShortcutAction, removeShortcutAction

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

addLayoutClickListener

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getScrollBarPolicy

ScrollBoxLayout.ScrollBarPolicy getScrollBarPolicy()

setScrollBarPolicy

void setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)

setContentWidth

@StudioProperty(name="contentWidth",
                type=SIZE)
void setContentWidth(@Nullable
                                                                                     java.lang.String width)

Sets content width.

Parameters:

width - width

getContentWidth

float getContentWidth()

Returns:

content width value

getContentWidthSizeUnit

SizeUnit getContentWidthSizeUnit()

Returns:

content width size unit

setContentHeight

@StudioProperty(name="contentHeight",
                type=SIZE)
void setContentHeight(@Nullable
                                                                                       java.lang.String height)

Sets content height.

Parameters:

height - height

getContentHeight

float getContentHeight()

Returns:

content height value

getContentHeightSizeUnit

SizeUnit getContentHeightSizeUnit()

Returns:

content height size unit

setContentMinWidth

@StudioProperty(name="contentMinWidth",
                type=SIZE)
void setContentMinWidth(java.lang.String minWidth)

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

Parameters:

minWidth - minimum width

getContentMinWidth

@Nullable
java.lang.String getContentMinWidth()

Returns:

minimal content width

setContentMaxWidth

@StudioProperty(name="contentMaxWidth",
                type=SIZE)
void setContentMaxWidth(java.lang.String maxWidth)

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

Parameters:

maxWidth - maximum width

getContentMaxWidth

@Nullable
java.lang.String getContentMaxWidth()

Returns:

maximum content width

setContentMinHeight

@StudioProperty(name="contentMinHeight",
                type=SIZE)
void setContentMinHeight(java.lang.String minHeight)

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

Parameters:

minHeight - minimum height

getContentMinHeight

@Nullable
java.lang.String getContentMinHeight()

Returns:

minimum content width

setContentMaxHeight

@StudioProperty(name="contentMaxHeight",
                type=SIZE)
void setContentMaxHeight(java.lang.String maxHeight)

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

Parameters:

maxHeight - maximum height

getContentMaxHeight

@Nullable
java.lang.String getContentMaxHeight()

Returns:

maximum content width

getScrollLeft

int getScrollLeft()

Gets scroll left offset.

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

Returns:

horizontal scrolling position in pixels

setScrollLeft

void setScrollLeft(int scrollLeft)

Sets scroll left offset.

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

Parameters:

scrollLeft - the xOffset

getScrollTop

int getScrollTop()

Gets scroll top offset.

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

Returns:

vertical scrolling position in pixels

setScrollTop

void setScrollTop(int scrollTop)

Sets scroll top offset.

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

Parameters:

scrollTop - the yOffset