Package 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%/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.

  • Field Details

  • Method Details

    • getScrollBarPolicy

      ScrollBoxLayout.ScrollBarPolicy getScrollBarPolicy()

    • setScrollBarPolicy

      void setScrollBarPolicy(ScrollBoxLayout.ScrollBarPolicy scrollBarPolicy)

    • setContentWidth

      @StudioProperty(name="contentWidth", type=SIZE) void setContentWidth(@Nullable 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 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(String minWidth)
      Sets minimum CSS width for content. Examples: "640px", "auto".
      Parameters:
      minWidth - minimum width

    • getContentMinWidth

      @Nullable String getContentMinWidth()
      Returns:
      minimal content width

    • setContentMaxWidth

      @StudioProperty(name="contentMaxWidth", type=SIZE) void setContentMaxWidth(String maxWidth)
      Sets maximum CSS width for content. Examples: "640px", "100%".
      Parameters:
      maxWidth - maximum width

    • getContentMaxWidth

      @Nullable String getContentMaxWidth()
      Returns:
      maximum content width

    • setContentMinHeight

      @StudioProperty(name="contentMinHeight", type=SIZE) void setContentMinHeight(String minHeight)
      Sets minimum CSS height for content. Examples: "640px", "auto".
      Parameters:
      minHeight - minimum height

    • getContentMinHeight

      @Nullable String getContentMinHeight()
      Returns:
      minimum content width

    • setContentMaxHeight

      @StudioProperty(name="contentMaxHeight", type=SIZE) void setContentMaxHeight(String maxHeight)
      Sets maximum CSS height for content. Examples: "640px", "100%".
      Parameters:
      maxHeight - maximum height

    • getContentMaxHeight

      @Nullable 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