gov.nasa.worldwind.ogc.kml.KMLBalloonStyle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation
worldwind-pcm
The newest version!
/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.ogc.kml;

/**
 * Represents the KML BalloonStyle element and provides access to its contents.
 *
 * @author tag
 * @version $Id: KMLBalloonStyle.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public class KMLBalloonStyle extends KMLAbstractSubStyle
{
    /**
     * Construct an instance.
     *
     * @param namespaceURI the qualifying namespace URI. May be null to indicate no namespace qualification.
     */
    public KMLBalloonStyle(String namespaceURI)
    {
        super(namespaceURI);
    }

    /**
     * Specifies this KMLBalloonStyle's background color as a hexadecimal string in the form: aabbggrr
     * (deprecated). The color style attribute was Deprecated in KML 2.1 and replaced by
     * bgColor.
     *
     * @return the background color as a hexadecimal string.
     */
    public String getColor()
    {
        return (String) this.getField("color");
    }

    /**
     * Specifies this KMLBalloonStyle's background color as a hexadecimal string in the form: aabbggrr.
     * This is the preferred attribute for encoding a balloon's background color since KML 2.1.
     *
     * @return the background color as a hexadecimal string.
     */
    public String getBgColor()
    {
        return (String) this.getField("bgColor");
    }

    public String getTextColor()
    {
        return (String) this.getField("textColor");
    }

    /**
     * Get the text field.
     *
     * @return Balloon text field.
     */
    public String getText()
    {
        return (String) this.getField("text");
    }

    public String getDisplayMode()
    {
        return (String) this.getField("displayMode");
    }

    /**
     * Does the style have at least one BalloonStyle field set? This method tests for the existence of the BalloonStyle
     * content fields (text, displayMode, bgColor, etc).
     *
     * @return True if at least one of the BalloonStyle fields is set (text, displayMode, bgColor, etc).
     */
    public boolean hasStyleFields()
    {
        return this.hasField("text")
            || this.hasField("bgColor")
            || this.hasField("textColor")
            || this.hasField("color")
            || this.hasField("displayMode");
    }
}