Package com.esri.arcgisruntime.ogc.kml

Class KmlColorStyle

  • Direct Known Subclasses:
    KmlIconStyle, KmlLabelStyle, KmlLineStyle, KmlPolygonStyle
    public abstract class KmlColorStyle
extends java.lang.Object
    Defines how KmlNode will appear based on the specified color and KmlColorMode properties.

    For a KmlNode with a KmlIcon, the color that is specified is blended with the existing color of the base image. Due to this blending effect, to have the exact color appear that was specified by the color property, it is recommended that the base image be white. Also note that, because color defaults to white, the color property of KmlIcon will result in the original color of the base image.

    Since:
    100.6.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getColor()
      Gets the color of the KmlColorStyle.
      KmlColorMode getColorMode()
      Gets the color mode of the KmlColorStyle.
      void setColor​(int color)
      Sets the color of the KmlColorStyle.
      void setColorMode​(KmlColorMode kmlColorMode)
      Sets the color mode of the KmlColorStyle.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getColor

        public int getColor()
        Gets the color of the KmlColorStyle.

        The default color is white 0xFFFFFFFF.

        Returns:
        the color in 0xAARRGGBB format
        Since:
        100.6.0

      • setColor

        public void setColor​(int color)
        Sets the color of the KmlColorStyle.
        Parameters:
        color - the color in 0xAARRGGBB format
        Since:
        100.6.0

      • getColorMode

        public KmlColorMode getColorMode()
        Gets the color mode of the KmlColorStyle.
        Returns:
        a KmlColorMode
        Since:
        100.6.0

      • setColorMode

        public void setColorMode​(KmlColorMode kmlColorMode)
        Sets the color mode of the KmlColorStyle.
        Parameters:
        kmlColorMode - a KmlColorMode
        Throws:
        java.lang.IllegalArgumentException - if kmlColorMode is null
        Since:
        100.6.0