001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/graphics/displayelements/DisplayElement.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    package org.deegree.graphics.displayelements;
037    
038    import java.awt.Graphics;
039    
040    import org.deegree.graphics.transformation.GeoTransform;
041    import org.deegree.model.feature.Feature;
042    
043    /**
044     * Basic interface for all display elements. A <code>DisplayElement</code> is associated to one
045     * {@link Feature} instance that may have a geometry property or not (which is the common case).
046     *
047     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
048     * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
049     * @author last edited by: $Author: mschneider $
050     *
051     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
052     */
053    public interface DisplayElement {
054    
055        /**
056         * Returns the associated {@link Feature}.
057         *
058         * @return the associated feature
059         */
060        Feature getFeature();
061    
062        /**
063         * Sets the associated {@link Feature}.
064         *
065         * @param feature
066         */
067        void setFeature( Feature feature );
068    
069        /**
070         * Returns the id of the associated feature.
071         *
072         * @return the associated feature's id
073         */
074        String getAssociateFeatureId();
075    
076        /**
077         * Renders the <code>DisplayElement</code> to the submitted graphic context.
078         *
079         * @param g
080         *            graphics context to render to
081         * @param projection
082         * @param scale
083         */
084        void paint( Graphics g, GeoTransform projection, double scale );
085    
086        /**
087         * Sets the selection state of the <code>DisplayElement</code>.
088         *
089         * @param selected
090         *            true, if the <code>DisplayElement</code> is selected, false otherwise
091         */
092        void setSelected( boolean selected );
093    
094        /**
095         * Returns whether the <code>DisplayElement</code> is selected.
096         *
097         * @return true, if the <code>DisplayElement</code> is selected, false otherwise
098         */
099        boolean isSelected();
100    
101        /**
102         * Sets the highlighting state of the <code>DisplayElement</code>.
103         *
104         * @param highlighted
105         *            true, if the <code>DisplayElement</code> is highlighted, false otherwise
106         */
107        void setHighlighted( boolean highlighted );
108    
109        /**
110         * Returns whether the <code>DisplayElement</code> is highlighted.
111         *
112         * @return true, if the <code>DisplayElement</code> is highlighted, false otherwise
113         */
114        boolean isHighlighted();
115    
116        /**
117         * Returns whether the <code>DisplayElement</code> should be painted at the given scale.
118         *
119         * @param scale
120         *            scale to check
121         * @return true, if the <code>DisplayElement</code> has to be painted, false otherwise
122         */
123        boolean doesScaleConstraintApply( double scale );
124    }