Class EditorScrollbarOptions

  • All Implemented Interfaces:
    java.io.Serializable

    public class EditorScrollbarOptions
    extends org.primefaces.shaded.json.JSONObject
    implements java.io.Serializable
    See Also:
    Serialized Form
    • Constructor Detail

      • EditorScrollbarOptions

        public EditorScrollbarOptions()
    • Method Detail

      • isAlwaysConsumeMouseWheel

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

        public EditorScrollbarOptions setAlwaysConsumeMouseWheel​(java.lang.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 java.lang.Number getArrowSize()
        Returns:
        The size of arrows (if displayed). Defaults to 11.
      • setArrowSize

        public EditorScrollbarOptions setArrowSize​(java.lang.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 java.lang.Boolean isHandleMouseWheel()
        Returns:
        Listen to mouse wheel events and react to them by scrolling. Defaults to true.
      • setHandleMouseWheel

        public EditorScrollbarOptions setHandleMouseWheel​(java.lang.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 java.lang.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.
      • isHorizontalHasArrows

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

        public EditorScrollbarOptions setHorizontalHasArrows​(java.lang.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 java.lang.Number getHorizontalScrollbarSize()
        Returns:
        Height in pixels for the horizontal scrollbar. Defaults to 10 (px).
      • setHorizontalScrollbarSize

        public EditorScrollbarOptions setHorizontalScrollbarSize​(java.lang.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 java.lang.Number getHorizontalSliderSize()
        Returns:
        Height in pixels for the horizontal slider. Defaults to horizontalScrollbarSize.
      • setHorizontalSliderSize

        public EditorScrollbarOptions setHorizontalSliderSize​(java.lang.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.
      • isUseShadows

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

        public EditorScrollbarOptions setUseShadows​(java.lang.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 java.lang.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.
      • isVerticalHasArrows

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

        public EditorScrollbarOptions setVerticalHasArrows​(java.lang.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 java.lang.Number getVerticalScrollbarSize()
        Returns:
        Width in pixels for the vertical scrollbar. Defaults to 10 (px).
      • setVerticalScrollbarSize

        public EditorScrollbarOptions setVerticalScrollbarSize​(java.lang.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 java.lang.Number getVerticalSliderSize()
        Returns:
        Width in pixels for the vertical slider. Defaults to verticalScrollbarSize.
      • setVerticalSliderSize

        public EditorScrollbarOptions setVerticalSliderSize​(java.lang.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.