Package com.biomatters.geneious.publicapi.plugin

Class DocumentViewer.ViewerLocation

  • Enclosing class:
    DocumentViewer
    public static class DocumentViewer.ViewerLocation
extends java.lang.Object
    Information about the location of a viewer eg. in a split layout.
    Since:
    API 4.11 (Geneious 5.0)

    • Constructor Summary

      Constructors 
      Constructor Description
      ViewerLocation​(boolean isAboveOrBelowAnotherViewer, boolean isBesideAnotherViewer, java.lang.String identifier)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getIdentifier()
      Get a short identifier string which is unique for the position of the viewer in the split layout.
      boolean isAboveOrBelowAnotherViewer()
      Whether or not the viewer is above/below another viewer in a split layout.
      boolean isBesideAnotherViewer()
      Whether or not the viewer is beside another in a split layout.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ViewerLocation

        public ViewerLocation​(boolean isAboveOrBelowAnotherViewer,
                      boolean isBesideAnotherViewer,
                      java.lang.String identifier)
        Parameters:
        isAboveOrBelowAnotherViewer - Whether or not the viewer is above/below another viewer in a split layout.
        isBesideAnotherViewer - Whether or not the viewer is beside another in a split layout.
        identifier - a short identifier string which may be used for storing preferences. must not be null.

    • Method Detail

      • isAboveOrBelowAnotherViewer

        public boolean isAboveOrBelowAnotherViewer()
        Whether or not the viewer is above/below another viewer in a split layout. If true the viewer should conserve vertical space.
        Returns:
        true if there is another viewer above or below this viewer.

      • isBesideAnotherViewer

        public boolean isBesideAnotherViewer()
        Whether or not the viewer is beside another in a split layout. If true the viewer should conserve horizontal space.
        Returns:
        true if there is another viewer to the left or right of this viewer.

      • getIdentifier

        public java.lang.String getIdentifier()
        Get a short identifier string which is unique for the position of the viewer in the split layout.
        Returns:
        short identifier string, never null