Package org.primefaces.extensions.model.monacoeditor

Class EditorScrollbarOptions

java.lang.Object
org.primefaces.shaded.json.JSONObject
org.primefaces.extensions.model.monacoeditor.EditorScrollbarOptions
All Implemented Interfaces:
Serializable
public class EditorScrollbarOptions extends org.primefaces.shaded.json.JSONObject implements Serializable
Configuration options for editor scrollbars
See Also:

  • Constructor Details

    • EditorScrollbarOptions

      public EditorScrollbarOptions()

  • Method Details

    • isAlwaysConsumeMouseWheel

      public Boolean isAlwaysConsumeMouseWheel()
      Returns:
      Always consume mouse wheel events (always call preventDefault() and stopPropagation() on the browser events). Defaults to true.

    • setAlwaysConsumeMouseWheel

      public EditorScrollbarOptions setAlwaysConsumeMouseWheel(Boolean alwaysConsumeMouseWheel)
      Parameters:
      alwaysConsumeMouseWheel - Always consume mouse wheel events (always call preventDefault() and stopPropagation() on the browser events). Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getArrowSize

      public Number getArrowSize()
      Returns:
      The size of arrows (if displayed). Defaults to 11.

    • setArrowSize

      public EditorScrollbarOptions setArrowSize(Number arrowSize)
      Parameters:
      arrowSize - The size of arrows (if displayed). Defaults to 11.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isHandleMouseWheel

      public Boolean isHandleMouseWheel()
      Returns:
      Listen to mouse wheel events and react to them by scrolling. Defaults to true.

    • setHandleMouseWheel

      public EditorScrollbarOptions setHandleMouseWheel(Boolean handleMouseWheel)
      Parameters:
      handleMouseWheel - Listen to mouse wheel events and react to them by scrolling. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getHorizontal

      public String getHorizontal()
      Returns:
      Render horizontal scrollbar. Defaults to auto.

    • setHorizontal

      public EditorScrollbarOptions setHorizontal(EScrollbarHorizontal horizontal)
      Parameters:
      horizontal - Render horizontal scrollbar. Defaults to auto.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setHorizontal

      public EditorScrollbarOptions setHorizontal(String horizontal)
      Parameters:
      horizontal - Render horizontal scrollbar. Defaults to auto.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isHorizontalHasArrows

      public Boolean isHorizontalHasArrows()
      Returns:
      Render arrows at the left and right of the horizontal scrollbar. Defaults to false.

    • setHorizontalHasArrows

      public EditorScrollbarOptions setHorizontalHasArrows(Boolean horizontalHasArrows)
      Parameters:
      horizontalHasArrows - Render arrows at the left and right of the horizontal scrollbar. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getHorizontalScrollbarSize

      public Number getHorizontalScrollbarSize()
      Returns:
      Height in pixels for the horizontal scrollbar. Defaults to 10 (px).

    • setHorizontalScrollbarSize

      public EditorScrollbarOptions setHorizontalScrollbarSize(Number horizontalScrollbarSize)
      Parameters:
      horizontalScrollbarSize - Height in pixels for the horizontal scrollbar. Defaults to 10 (px).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getHorizontalSliderSize

      public Number getHorizontalSliderSize()
      Returns:
      Height in pixels for the horizontal slider. Defaults to horizontalScrollbarSize.

    • setHorizontalSliderSize

      public EditorScrollbarOptions setHorizontalSliderSize(Number horizontalSliderSize)
      Parameters:
      horizontalSliderSize - Height in pixels for the horizontal slider. Defaults to horizontalScrollbarSize.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isIgnoreHorizontalScrollbarInContentHeight

      public Boolean isIgnoreHorizontalScrollbarInContentHeight()
      Returns:
      When set, the horizontal scrollbar will not increase content height. Defaults to false.

    • setIgnoreHorizontalScrollbarInContentHeight

      public EditorScrollbarOptions setIgnoreHorizontalScrollbarInContentHeight(Boolean ignoreHorizontalScrollbarInContentHeight)
      Parameters:
      ignoreHorizontalScrollbarInContentHeight - When set, the horizontal scrollbar will not increase content height. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isScrollByPage

      public Boolean isScrollByPage()
      Returns:
      Scroll gutter clicks move by page vs jump to position. Defaults to false.

    • setScrollByPage

      public EditorScrollbarOptions setScrollByPage(Boolean scrollByPage)
      Parameters:
      scrollByPage - Scroll gutter clicks move by page vs jump to position. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isUseShadows

      public Boolean isUseShadows()
      Returns:
      Cast horizontal and vertical shadows when the content is scrolled. Defaults to true.

    • setUseShadows

      public EditorScrollbarOptions setUseShadows(Boolean useShadows)
      Parameters:
      useShadows - Cast horizontal and vertical shadows when the content is scrolled. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getVertical

      public String getVertical()
      Returns:
      Render vertical scrollbar. Defaults to auto.

    • setVertical

      public EditorScrollbarOptions setVertical(EScrollbarVertical vertical)
      Parameters:
      vertical - Render vertical scrollbar. Defaults to auto.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • setVertical

      public EditorScrollbarOptions setVertical(String vertical)
      Parameters:
      vertical - Render vertical scrollbar. Defaults to auto.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isVerticalHasArrows

      public Boolean isVerticalHasArrows()
      Returns:
      Render arrows at the top and bottom of the vertical scrollbar. Defaults to false.

    • setVerticalHasArrows

      public EditorScrollbarOptions setVerticalHasArrows(Boolean verticalHasArrows)
      Parameters:
      verticalHasArrows - Render arrows at the top and bottom of the vertical scrollbar. Defaults to false.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getVerticalScrollbarSize

      public Number getVerticalScrollbarSize()
      Returns:
      Width in pixels for the vertical scrollbar. Defaults to 10 (px).

    • setVerticalScrollbarSize

      public EditorScrollbarOptions setVerticalScrollbarSize(Number verticalScrollbarSize)
      Parameters:
      verticalScrollbarSize - Width in pixels for the vertical scrollbar. Defaults to 10 (px).
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getVerticalSliderSize

      public Number getVerticalSliderSize()
      Returns:
      Width in pixels for the vertical slider. Defaults to verticalScrollbarSize.

    • setVerticalSliderSize

      public EditorScrollbarOptions setVerticalSliderSize(Number verticalSliderSize)
      Parameters:
      verticalSliderSize - Width in pixels for the vertical slider. Defaults to verticalScrollbarSize.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.