Class Page.LayoutViewport

    • Field Summary

       
      Serializable ID
      Modifier and Type Field
      protected static long serialVersionUID
      For Object Serialization.
       
      Type Properties
      Modifier and Type Field
      int clientHeight
      Height (CSS pixels), excludes scrollbar if present.
      int clientWidth
      Width (CSS pixels), excludes scrollbar if present.
      int pageX
      Horizontal offset relative to the document (CSS pixels).
      int pageY
      Vertical offset relative to the document (CSS pixels).
    • Constructor Summary

      Constructors 
      Constructor Description
      LayoutViewport​(int pageX, int pageY, int clientWidth, int clientHeight)
      Constructor
      LayoutViewport​(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

      • LayoutViewport

        🡅  🡇     🗕  🗗  🗖
        public LayoutViewport​(int pageX,
                              int pageY,
                              int clientWidth,
                              int clientHeight)
        Constructor
        Parameters:
        pageX - Horizontal offset relative to the document (CSS pixels).
        pageY - Vertical offset relative to the document (CSS pixels).
        clientWidth - Width (CSS pixels), excludes scrollbar if present.
        clientHeight - Height (CSS pixels), excludes scrollbar if present.
    • 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[] { false, false, false, false, };
        
      • 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;
                
         LayoutViewport o = (LayoutViewport) other;
                
         return
                 (this.pageX == o.pageX)
             &&  (this.pageY == o.pageY)
             &&  (this.clientWidth == o.clientWidth)
             &&  (this.clientHeight == o.clientHeight);
        
      • hashCode

        🡅     🗕  🗗  🗖
        public int hashCode()
        Generates a Hash-Code for 'this' instance
        Overrides:
        hashCode in class java.lang.Object
        Code:
        Exact Method Body:
         return
                 this.pageX
             +   this.pageY
             +   this.clientWidth
             +   this.clientHeight;