/**************************************************************************************************
 **
 ** $Id: Halo.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/go/display/style/Halo.java $
 **
 ** Copyright (C) 2003 Open GIS Consortium, Inc. All Rights Reserved. http://www.opengis.org/Legal/
 **
 *************************************************************************************************/
package org.opengis.go.display.style;


/**
 * TEncapsulates the halo radius that can be applied to any text Graphic.
 *
 * @version 0.2
 * @author OpenGIS® consortium
 */
public interface Halo {
    /**
     * Halo radius attribute name.
     */
    public static final String RADIUS = "HALO_RADIUS";

    /**
     * Returns the halo radius value.
     * @return the value of the halo radius.
     */
    public float getRadius();

    /**
     * Returns whether the halo radius value has been set.
     * @return true if the halo radius value has been set, false otherwise.
     */    
    public boolean isRadiusSet();

    /**
     * Sets the halo radius value.
     * @param haloRadius the value of the halo radius.
     */    
    public void setRadius(float haloRadius);

    /**
     * Sets the fact that the halo radius value has been set.
     * @param flag true if the halo radius value has been set, false otherwise.
     */    
    public void setRadiusSet(boolean flag);
}

 

Ads help maintain this website.