/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, 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;
 *    version 2.1 of the License.
 *
 *    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.display2d.ext.legend;

import java.awt.*;

import org.geotoolkit.display2d.ext.BackgroundTemplate;

/**
 * Template holding informations about the design of the legend to paint.
 *
 * @author Johann Sorel (Geomatys)
 * @module
 */
public interface LegendTemplate {

    /**
     * The background.
     */
    BackgroundTemplate getBackground();

    /**
     * @return the gap between 2 legend elements
     */
    float getGapSize();

    /**
     * @return size of the glyph, can be null = use the best glyph size
     */
    Dimension getGlyphSize();

    /**
     * @return true if the name of the layer should be displayed
     */
    boolean isLayerVisible();

    /**
     * @return Font for the layer name
     */
    Font getLayerFont();

    /**
     * @return Font for the layer name
     */
    Color getLayerFontColor();

    /**
     * @return Font opacity for the layer name
     */
    Float getLayerFontOpacity();

    /**
     * @return Font to use for style rules
     */
    Font getRuleFont();

    /**
     * @return true if we display legend only for the visible layers on the map,
     * false otherwise.
     */
    boolean displayOnlyVisibleLayers();

    /**
     * A function to decide if we should display only the visible layers on the
     * legend.
     *
     * @param displayOption : set to true if we only want visible layers on the
     * legend, false otherwise.
     */
    void setDisplayOnlyVisibleLayers(boolean displayOption);
}