Class GuiScrollIndicator

java.lang.Object
com.render.api.gui.GuiScrollIndicator
public final class GuiScrollIndicator extends Object
Scrollbar configuration for ScrollContainerComponent.

  • Constructor Details

    • GuiScrollIndicator

      public GuiScrollIndicator()

  • Method Details

    • enabled

      public boolean enabled()
      Returns whether the scrollbar is enabled.
      Returns:
      true when the scrollbar should render

    • enabled

      public GuiScrollIndicator enabled(boolean enabled)
      Sets whether the scrollbar is enabled.
      Parameters:
      enabled - true to render the scrollbar
      Returns:
      this indicator

    • trackColor

      public RenderColor trackColor()
      Returns the scrollbar track color in ARGB format.
      Returns:
      track color

    • trackColor

      public GuiScrollIndicator trackColor(RenderColor trackColor)
      Sets the scrollbar track color in ARGB format.
      Parameters:
      trackColor - track color
      Returns:
      this indicator

    • trackColor

      @Deprecated(forRemoval=false) public GuiScrollIndicator trackColor(int trackArgb)
      Deprecated.
      Use trackColor(RenderColor).

    • thumbColor

      public RenderColor thumbColor()
      Returns the scrollbar thumb color in ARGB format.
      Returns:
      thumb color

    • thumbColor

      public GuiScrollIndicator thumbColor(RenderColor thumbColor)
      Sets the scrollbar thumb color in ARGB format.
      Parameters:
      thumbColor - thumb color
      Returns:
      this indicator

    • thumbColor

      @Deprecated(forRemoval=false) public GuiScrollIndicator thumbColor(int thumbArgb)
      Deprecated.
      Use thumbColor(RenderColor).

    • thickness

      public float thickness()
      Returns the scrollbar thickness in design-space pixels.
      Returns:
      scrollbar thickness

    • thickness

      public GuiScrollIndicator thickness(float thickness)
      Sets the scrollbar thickness in design-space pixels.
      Parameters:
      thickness - scrollbar thickness
      Returns:
      this indicator

    • margin

      public float margin()
      Returns the inset from the viewport edge in design-space pixels.
      Returns:
      viewport margin

    • margin

      public GuiScrollIndicator margin(float margin)
      Sets the inset from the viewport edge in design-space pixels.
      Parameters:
      margin - viewport margin
      Returns:
      this indicator

    • cornerRadius

      public float cornerRadius()
      Returns the scrollbar corner radius in design-space pixels.
      Returns:
      corner radius

    • cornerRadius

      public GuiScrollIndicator cornerRadius(float cornerRadius)
      Sets the scrollbar corner radius in design-space pixels.
      Parameters:
      cornerRadius - corner radius
      Returns:
      this indicator

    • edge

      public GuiScrollIndicator.Edge edge()
      Returns the edge where the scrollbar is rendered.
      Returns:
      scrollbar edge

    • edge

      public GuiScrollIndicator edge(GuiScrollIndicator.Edge edge)
      Sets the edge where the scrollbar is rendered.
      Parameters:
      edge - scrollbar edge, or null for GuiScrollIndicator.Edge.RIGHT
      Returns:
      this indicator

    • copy

      public GuiScrollIndicator copy()
      Returns a detached copy of this scrollbar configuration.
      Returns:
      copied scrollbar configuration