Package org.primefaces.extensions.model.monacoeditor

Class EditorMinimapOptions

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

  • Constructor Details

    • EditorMinimapOptions

      public EditorMinimapOptions()

  • Method Details

    • isAutohide

      public Boolean isAutohide()
      Returns:
      Control the rendering of minimap.

    • setAutohide

      public EditorMinimapOptions setAutohide(Boolean autohide)
      Parameters:
      autohide - Control the rendering of minimap.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isEnabled

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

    • setEnabled

      public EditorMinimapOptions setEnabled(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 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(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 Boolean isRenderCharacters()
      Returns:
      Render the actual text on a line (as opposed to color blocks). Defaults to true.

    • setRenderCharacters

      public EditorMinimapOptions setRenderCharacters(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 Number getScale()
      Returns:
      Relative size of the font in the minimap. Defaults to 1.

    • setScale

      public EditorMinimapOptions setScale(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.

    • getSectionHeaderFontSize

      public Number getSectionHeaderFontSize()
      Returns:
      Font size of section headers. Defaults to 9.

    • setSectionHeaderFontSize

      public EditorMinimapOptions setSectionHeaderFontSize(Number sectionHeaderFontSize)
      Parameters:
      sectionHeaderFontSize - Font size of section headers. Defaults to 9.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getSectionHeaderLetterSpacing

      public Number getSectionHeaderLetterSpacing()
      Returns:
      Spacing between the section header characters (in CSS px). Defaults to 1.

    • setSectionHeaderLetterSpacing

      public EditorMinimapOptions setSectionHeaderLetterSpacing(Number sectionHeaderLetterSpacing)
      Parameters:
      sectionHeaderLetterSpacing - Spacing between the section header characters (in CSS px). Defaults to 1.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowMarkSectionHeaders

      public Boolean isShowMarkSectionHeaders()
      Returns:
      Whether to show MARK: comments as section headers. Defaults to true.

    • setShowMarkSectionHeaders

      public EditorMinimapOptions setShowMarkSectionHeaders(Boolean showMarkSectionHeaders)
      Parameters:
      showMarkSectionHeaders - Whether to show MARK: comments as section headers. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • isShowRegionSectionHeaders

      public Boolean isShowRegionSectionHeaders()
      Returns:
      Whether to show named regions as section headers. Defaults to true.

    • setShowRegionSectionHeaders

      public EditorMinimapOptions setShowRegionSectionHeaders(Boolean showRegionSectionHeaders)
      Parameters:
      showRegionSectionHeaders - Whether to show named regions as section headers. Defaults to true.
      Returns:
      This same instance, useful for chaining multiple setter methods in one call.

    • getShowSlider

      public 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(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 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(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 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(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.