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