Package com.esri.arcgisruntime.hydrography

Class EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayCategories

  • Enclosing class:
    EncEnvironmentSettings.DisplaySettings.MarinerSettings
    public static final class EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayCategories
extends java.lang.Object
    Represents settings in the S-52 standard that allow selection of different display categories. These settings are specified by the S-52 Presentation Library 4.0.

    All display categories are enabled, true, by default.

    Since:
    100.2.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isDisplayBase()
      Gets whether the "base" display category is enabled.
      boolean isOtherDisplay()
      Gets whether "other" display category is enabled.
      boolean isStandardDisplay()
      Gets whether the "standard" display category is enabled.
      void setIsDisplayBase​(boolean isDisplayBase)
      Sets whether to enable the "base" display category.
      void setIsOtherDisplay​(boolean isOtherDisplay)
      Sets whether to enable the "other" display category.
      void setIsStandardDisplay​(boolean isStandardDisplay)
      Sets whether to enable the "standard" display category.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • isDisplayBase

        public boolean isDisplayBase()
        Gets whether the "base" display category is enabled.

        Displaybase contains a subset of the objects in "standard".

        Defaults to true, meaning enabled.

        Returns:
        true if the "base" display category is enabled, otherwise false
        Since:
        100.2.0

      • setIsDisplayBase

        public void setIsDisplayBase​(boolean isDisplayBase)
        Sets whether to enable the "base" display category.
        Parameters:
        isDisplayBase - true if the "base" display category should be enabled, otherwise false
        Since:
        100.2.0

      • isStandardDisplay

        public boolean isStandardDisplay()
        Gets whether the "standard" display category is enabled.

        Once an object has been added to or removed from display, display is no longer showing the "Standard Display". This will not be reflected by this property and must be enforced by ECDIS implementers.

        Defaults to true, meaning enabled.

        Returns:
        true if the "standard" display category is enabled, otherwise false
        Since:
        100.2.0

      • setIsStandardDisplay

        public void setIsStandardDisplay​(boolean isStandardDisplay)
        Sets whether to enable the "standard" display category.
        Parameters:
        isStandardDisplay - true if the "standard" display category should be enabled, otherwise false
        Since:
        100.2.0

      • isOtherDisplay

        public boolean isOtherDisplay()
        Gets whether "other" display category is enabled.

        The "other" category contains all objects that are not enabled by default in "Standard Display".

        Defaults to true, meaning enabled.

        Returns:
        true if "other" display category is enabled, otherwise false
        Since:
        100.2.0

      • setIsOtherDisplay

        public void setIsOtherDisplay​(boolean isOtherDisplay)
        Sets whether to enable the "other" display category.
        Parameters:
        isOtherDisplay - true if "other" display category should be enabled, otherwise false
        Since:
        100.2.0