Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.ogc.kml

Class KmlColorStyle

java.lang.Object
com.esri.arcgisruntime.ogc.kml.KmlColorStyle
Direct Known Subclasses:
KmlIconStyle, KmlLabelStyle, KmlLineStyle, KmlPolygonStyle
public abstract class KmlColorStyle extends 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

  • Property Details

  • Method Details

    • colorProperty

      public ObjectProperty<Color> colorProperty()
      The color of the KmlColorStyle.

      The default color is Color.WHITE.

      Attempting to set the color to null will throw a NullPointerException exception.

      Returns:
      the color property
      Since:
      200.0.0
      See Also:

    • getColor

      public Color getColor()
      Gets the value of the color property.
      Property description:
      The color of the KmlColorStyle.

      The default color is Color.WHITE.

      Attempting to set the color to null will throw a NullPointerException exception.

      Returns:
      the value of the color property
      Since:
      200.0.0
      See Also:

    • setColor

      public void setColor(Color color)
      Sets the value of the color property.
      Property description:
      The color of the KmlColorStyle.

      The default color is Color.WHITE.

      Attempting to set the color to null will throw a NullPointerException exception.

      Parameters:
      color - the value for the color property
      Since:
      200.0.0
      See Also:

    • setColor

      @Deprecated(since="200.0.0", forRemoval=true) public void setColor(int color)
      Deprecated, for removal: This API element is subject to removal in a future version.
      as of 200.0.0, replaced by setColor(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:
      IllegalArgumentException - if kmlColorMode is null
      Since:
      100.6.0