Class EditorMinimapOptions

  • All Implemented Interfaces:
    java.io.Serializable

    public class EditorMinimapOptions
    extends org.primefaces.shaded.json.JSONObject
    implements java.io.Serializable
    Configuration options for editor minimap
    See Also:
    Serialized Form
    • Constructor Detail

      • EditorMinimapOptions

        public EditorMinimapOptions()
    • Method Detail

      • isEnabled

        public java.lang.Boolean isEnabled()
        Returns:
        Enable the rendering of the minimap. Defaults to true.
      • setEnabled

        public EditorMinimapOptions setEnabled​(java.lang.Boolean enabled)
        Parameters:
        enabled - Enable the rendering of the minimap. Defaults to true.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getMaxColumn

        public java.lang.Number getMaxColumn()
        Returns:
        Limit the width of the minimap to render at most a certain number of columns. Defaults to 120.
      • setMaxColumn

        public EditorMinimapOptions setMaxColumn​(java.lang.Number maxColumn)
        Parameters:
        maxColumn - Limit the width of the minimap to render at most a certain number of columns. Defaults to 120.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • isRenderCharacters

        public java.lang.Boolean isRenderCharacters()
        Returns:
        Render the actual text on a line (as opposed to color blocks). Defaults to true.
      • setRenderCharacters

        public EditorMinimapOptions setRenderCharacters​(java.lang.Boolean renderCharacters)
        Parameters:
        renderCharacters - Render the actual text on a line (as opposed to color blocks). Defaults to true.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getScale

        public java.lang.Number getScale()
        Returns:
        Relative size of the font in the minimap. Defaults to 1.
      • setScale

        public EditorMinimapOptions setScale​(java.lang.Number scale)
        Parameters:
        scale - Relative size of the font in the minimap. Defaults to 1.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getShowSlider

        public java.lang.String getShowSlider()
        Returns:
        Control the rendering of the minimap slider. Defaults to mouseover.
      • setShowSlider

        public EditorMinimapOptions setShowSlider​(EMinimapShowSlider showSlider)
        Parameters:
        showSlider - Control the rendering of the minimap slider. Defaults to mouseover.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • setShowSlider

        public EditorMinimapOptions setShowSlider​(java.lang.String showSlider)
        Parameters:
        showSlider - Control the rendering of the minimap slider. Defaults to mouseover.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getSide

        public java.lang.String getSide()
        Returns:
        Control the side of the minimap in editor. Defaults to right.
      • setSide

        public EditorMinimapOptions setSide​(EMinimapSide side)
        Parameters:
        side - Control the side of the minimap in editor. Defaults to right.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • setSide

        public EditorMinimapOptions setSide​(java.lang.String side)
        Parameters:
        side - Control the side of the minimap in editor. Defaults to right.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • getSize

        public java.lang.String getSize()
        Returns:
        Control the minimap rendering mode. Defaults to actual.
      • setSize

        public EditorMinimapOptions setSize​(EMinimapSize size)
        Parameters:
        size - Control the minimap rendering mode. Defaults to actual.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.
      • setSize

        public EditorMinimapOptions setSize​(java.lang.String size)
        Parameters:
        size - Control the minimap rendering mode. Defaults to actual.
        Returns:
        This same instance, useful for chaining multiple setter methods in one call.