Class Overlay.GridHighlightConfig

    • Constructor Summary

      Constructors 
      Constructor Description
      GridHighlightConfig​(Boolean showGridExtensionLines, Boolean showPositiveLineNumbers, Boolean showNegativeLineNumbers, Boolean showAreaNames, Boolean showLineNames, Boolean showTrackSizes, DOM.RGBA gridBorderColor, DOM.RGBA cellBorderColor, DOM.RGBA rowLineColor, DOM.RGBA columnLineColor, Boolean gridBorderDash, Boolean cellBorderDash, Boolean rowLineDash, Boolean columnLineDash, DOM.RGBA rowGapColor, DOM.RGBA rowHatchColor, DOM.RGBA columnGapColor, DOM.RGBA columnHatchColor, DOM.RGBA areaBorderColor, DOM.RGBA gridBackgroundColor)
      Constructor
      GridHighlightConfig​(JsonObject jo)
      JSON Object Constructor

    • Method Summary

       
      Generate Array that Indicates which Parameter are Optional
      Modifier and Type Method
      boolean[] optionals()
      Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.
       
      Methods: class java.lang.Object
      Modifier and Type Method
      boolean equals​(Object other)
      Checks whether 'this' equals an input Java-Object
      int hashCode()
      Generates a Hash-Code for 'this' instance

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • GridHighlightConfig

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public GridHighlightConfig​(java.lang.Boolean showGridExtensionLines,
                           java.lang.Boolean showPositiveLineNumbers,
                           java.lang.Boolean showNegativeLineNumbers,
                           java.lang.Boolean showAreaNames,
                           java.lang.Boolean showLineNames,
                           java.lang.Boolean showTrackSizes,
                           DOM.RGBA gridBorderColor,
                           DOM.RGBA cellBorderColor,
                           DOM.RGBA rowLineColor,
                           DOM.RGBA columnLineColor,
                           java.lang.Boolean gridBorderDash,
                           java.lang.Boolean cellBorderDash,
                           java.lang.Boolean rowLineDash,
                           java.lang.Boolean columnLineDash,
                           DOM.RGBA rowGapColor,
                           DOM.RGBA rowHatchColor,
                           DOM.RGBA columnGapColor,
                           DOM.RGBA columnHatchColor,
                           DOM.RGBA areaBorderColor,
                           DOM.RGBA gridBackgroundColor)
        Constructor
        Parameters:
        showGridExtensionLines - Whether the extension lines from grid cells to the rulers should be shown (default: false).
        OPTIONAL
        showPositiveLineNumbers - Show Positive line number labels (default: false).
        OPTIONAL
        showNegativeLineNumbers - Show Negative line number labels (default: false).
        OPTIONAL
        showAreaNames - Show area name labels (default: false).
        OPTIONAL
        showLineNames - Show line name labels (default: false).
        OPTIONAL
        showTrackSizes - Show track size labels (default: false).
        OPTIONAL
        gridBorderColor - The grid container border highlight color (default: transparent).
        OPTIONAL
        cellBorderColor - The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
        OPTIONAL
        DEPRECATED
        rowLineColor - The row line color (default: transparent).
        OPTIONAL
        columnLineColor - The column line color (default: transparent).
        OPTIONAL
        gridBorderDash - Whether the grid border is dashed (default: false).
        OPTIONAL
        cellBorderDash - Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.
        OPTIONAL
        DEPRECATED
        rowLineDash - Whether row lines are dashed (default: false).
        OPTIONAL
        columnLineDash - Whether column lines are dashed (default: false).
        OPTIONAL
        rowGapColor - The row gap highlight fill color (default: transparent).
        OPTIONAL
        rowHatchColor - The row gap hatching fill color (default: transparent).
        OPTIONAL
        columnGapColor - The column gap highlight fill color (default: transparent).
        OPTIONAL
        columnHatchColor - The column gap hatching fill color (default: transparent).
        OPTIONAL
        areaBorderColor - The named grid areas border color (Default: transparent).
        OPTIONAL
        gridBackgroundColor - The grid container background color (Default: transparent).
        OPTIONAL

    • Method Detail

      • optionals

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public boolean[] optionals()
        Description copied from class: BaseType
        Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

        NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...
        Specified by:
        optionals in class BaseType
        Returns:
        A boolean[] array whose length is precisely equal to the number of fields in the Java Object.
        Code:
        Exact Method Body:
         return new boolean[] { true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, };

      • equals

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public boolean equals​(java.lang.Object other)
        Checks whether 'this' equals an input Java-Object
        Overrides:
        equals in class java.lang.Object
        Code:
        Exact Method Body:
         if (other == null)                       return false;
 if (other.getClass() != this.getClass()) return false;
        
 GridHighlightConfig o = (GridHighlightConfig) other;
        
 return
         Objects.equals(this.showGridExtensionLines, o.showGridExtensionLines)
     &&  Objects.equals(this.showPositiveLineNumbers, o.showPositiveLineNumbers)
     &&  Objects.equals(this.showNegativeLineNumbers, o.showNegativeLineNumbers)
     &&  Objects.equals(this.showAreaNames, o.showAreaNames)
     &&  Objects.equals(this.showLineNames, o.showLineNames)
     &&  Objects.equals(this.showTrackSizes, o.showTrackSizes)
     &&  Objects.equals(this.gridBorderColor, o.gridBorderColor)
     &&  Objects.equals(this.cellBorderColor, o.cellBorderColor)
     &&  Objects.equals(this.rowLineColor, o.rowLineColor)
     &&  Objects.equals(this.columnLineColor, o.columnLineColor)
     &&  Objects.equals(this.gridBorderDash, o.gridBorderDash)
     &&  Objects.equals(this.cellBorderDash, o.cellBorderDash)
     &&  Objects.equals(this.rowLineDash, o.rowLineDash)
     &&  Objects.equals(this.columnLineDash, o.columnLineDash)
     &&  Objects.equals(this.rowGapColor, o.rowGapColor)
     &&  Objects.equals(this.rowHatchColor, o.rowHatchColor)
     &&  Objects.equals(this.columnGapColor, o.columnGapColor)
     &&  Objects.equals(this.columnHatchColor, o.columnHatchColor)
     &&  Objects.equals(this.areaBorderColor, o.areaBorderColor)
     &&  Objects.equals(this.gridBackgroundColor, o.gridBackgroundColor);

      • hashCode

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public int hashCode()
        Generates a Hash-Code for 'this' instance
        Overrides:
        hashCode in class java.lang.Object
        Code:
        Exact Method Body:
         return
         Objects.hashCode(this.showGridExtensionLines)
     +   Objects.hashCode(this.showPositiveLineNumbers)
     +   Objects.hashCode(this.showNegativeLineNumbers)
     +   Objects.hashCode(this.showAreaNames)
     +   Objects.hashCode(this.showLineNames)
     +   Objects.hashCode(this.showTrackSizes)
     +   this.gridBorderColor.hashCode()
     +   this.cellBorderColor.hashCode()
     +   this.rowLineColor.hashCode()
     +   this.columnLineColor.hashCode()
     +   Objects.hashCode(this.gridBorderDash)
     +   Objects.hashCode(this.cellBorderDash)
     +   Objects.hashCode(this.rowLineDash)
     +   Objects.hashCode(this.columnLineDash)
     +   this.rowGapColor.hashCode()
     +   this.rowHatchColor.hashCode()
     +   this.columnGapColor.hashCode()
     +   this.columnHatchColor.hashCode()
     +   this.areaBorderColor.hashCode()
     +   this.gridBackgroundColor.hashCode();