com.haulmont.cuba.gui.components

Interface ScrollBoxLayout

All Superinterfaces:

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

public interface ScrollBoxLayout
extends OrderedContainer, Component.BelongToFrame, HasMargin, HasSpacing, HasOrientation, Component.HasIcon, Component.HasCaption, ShortcutNotifier, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasRequiredIndicator

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 com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasOrientation

HasOrientation.Orientation

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

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

Methods inherited from interface com.haulmont.cuba.gui.components.OrderedContainer

add, getComponent, getComponentNN, indexOf

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.HasMargin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.HasSpacing

getSpacing, setSpacing

Methods inherited from interface com.haulmont.cuba.gui.components.HasOrientation

getOrientation, setOrientation

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.ShortcutNotifier

addShortcutAction, removeShortcutAction

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasRequiredIndicator

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

void setContentWidth(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

void setContentHeight(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

void setContentMinWidth(java.lang.String minWidth)

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

Parameters:

minWidth - minimum width

getContentMinWidth

java.lang.String getContentMinWidth()

Returns:

minimal content width

setContentMaxWidth

void setContentMaxWidth(java.lang.String maxWidth)

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

Parameters:

maxWidth - maximum width

getContentMaxWidth

java.lang.String getContentMaxWidth()

Returns:

maximum content width

setContentMinHeight

void setContentMinHeight(java.lang.String minHeight)

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

Parameters:

minHeight - minimum height

getContentMinHeight

java.lang.String getContentMinHeight()

Returns:

minimum content width

setContentMaxHeight

void setContentMaxHeight(java.lang.String maxHeight)

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

Parameters:

maxHeight - maximum height

getContentMaxHeight

java.lang.String getContentMaxHeight()

Returns:

maximum content width