/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2010, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.data.kml.model;

import java.awt.Color;

/**
 *
 * <p>This interface maps BalloonStyle elements.</p>
 *
 * <pre>
 * <element name="BalloonStyle" type="kml:BalloonStyleType" substitutionGroup="kml:AbstractSubStyleGroup"/>
 *
 * <complexType name="BalloonStyleType" final="#all">
 *  <complexContent>
 *      <extension base="kml:AbstractSubStyleType">
 *          <sequence>
 *              <choice>
 *                  <annotation>
 *                      <documentation>color deprecated in 2.1</documentation>
 *                  </annotation>
 *                  <element ref="kml:color" minOccurs="0"/>
 *                  <element ref="kml:bgColor" minOccurs="0"/>
 *              </choice>
 *              <element ref="kml:textColor" minOccurs="0"/>
 *              <element ref="kml:text" minOccurs="0"/>
 *              <element ref="kml:displayMode" minOccurs="0"/>
 *              <element ref="kml:BalloonStyleSimpleExtensionGroup" minOccurs="0" maxOccurs="unbounded"/>
 *              <element ref="kml:BalloonStyleObjectExtensionGroup" minOccurs="0" maxOccurs="unbounded"/>
 *          </sequence>
 *      </extension>
 *  </complexContent>
 * </complexType>
 *
 * <element name="BalloonStyleSimpleExtensionGroup" abstract="true" type="anySimpleType"/>
 * <element name="BalloonStyleObjectExtensionGroup" abstract="true" substitutionGroup="kml:AbstractObjectGroup"/>
 * </pre>
 *
 * @author Samuel Andrés
 * @module
 */
public interface BalloonStyle extends AbstractSubStyle {

    /**
     *
     * @return the background color.
     */
    Color getBgColor();

    /**
     *
     * @return the text color.
     */
    Color getTextColor();

    /**
     *
     * @return the text content.
     */
    Object getText();

    /**
     *
     * @return the display mode
     */
    DisplayMode getDisplayMode();
    
    /**
     *
     * @param bgColor
     */
    void setBgColor(Color bgColor);

    /**
     *
     * @param textColor
     */
    void setTextColor(Color textColor);

    /**
     *
     * @param text
     */
    void setText(Object text);

    /**
     *
     * @param displayMode
     */
    void setDisplayMode(DisplayMode displayMode);

}