root / trunk / libraries / libFMap / src / com / iver / cit / gvsig / fmap / core / ILabelable.java @ 10679
History | View | Annotate | Download (3.65 KB)
1 |
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
|
---|---|
2 |
*
|
3 |
* Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.
|
4 |
*
|
5 |
* This program is free software; you can redistribute it and/or
|
6 |
* modify it under the terms of the GNU General Public License
|
7 |
* as published by the Free Software Foundation; either version 2
|
8 |
* of the License, or (at your option) any later version.
|
9 |
*
|
10 |
* This program is distributed in the hope that it will be useful,
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
13 |
* GNU General Public License for more details.
|
14 |
*
|
15 |
* You should have received a copy of the GNU General Public License
|
16 |
* along with this program; if not, write to the Free Software
|
17 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA.
|
18 |
*
|
19 |
* For more information, contact:
|
20 |
*
|
21 |
* Generalitat Valenciana
|
22 |
* Conselleria d'Infraestructures i Transport
|
23 |
* Av. Blasco Ib??ez, 50
|
24 |
* 46010 VALENCIA
|
25 |
* SPAIN
|
26 |
*
|
27 |
* +34 963862235
|
28 |
* gvsig@gva.es
|
29 |
* www.gvsig.gva.es
|
30 |
*
|
31 |
* or
|
32 |
*
|
33 |
* IVER T.I. S.A
|
34 |
* Salamanca 50
|
35 |
* 46005 Valencia
|
36 |
* Spain
|
37 |
*
|
38 |
* +34 963163400
|
39 |
* dac@iver.es
|
40 |
*/
|
41 |
|
42 |
/* CVS MESSAGES:
|
43 |
*
|
44 |
* $Id: ILabelable.java 10679 2007-03-09 11:25:01Z jaume $
|
45 |
* $Log$
|
46 |
* Revision 1.2 2007-03-09 11:20:57 jaume
|
47 |
* Advanced symbology (start committing)
|
48 |
*
|
49 |
* Revision 1.1.2.5 2007/02/15 16:23:44 jaume
|
50 |
* *** empty log message ***
|
51 |
*
|
52 |
* Revision 1.1.2.4 2007/02/09 07:47:05 jaume
|
53 |
* Isymbol moved
|
54 |
*
|
55 |
* Revision 1.1.2.3 2007/02/02 16:21:24 jaume
|
56 |
* start commiting labeling stuff
|
57 |
*
|
58 |
* Revision 1.1.2.2 2007/02/01 17:46:49 jaume
|
59 |
* *** empty log message ***
|
60 |
*
|
61 |
* Revision 1.1.2.1 2007/01/30 18:10:45 jaume
|
62 |
* start commiting labeling stuff
|
63 |
*
|
64 |
*
|
65 |
*/
|
66 |
package com.iver.cit.gvsig.fmap.core; |
67 |
|
68 |
import java.awt.Graphics2D; |
69 |
import java.awt.image.BufferedImage; |
70 |
|
71 |
import com.hardcode.gdbms.driver.exceptions.ReadDriverException; |
72 |
import com.hardcode.gdbms.engine.data.driver.DriverException; |
73 |
import com.iver.cit.gvsig.fmap.ViewPort; |
74 |
import com.iver.cit.gvsig.fmap.rendering.styling.ILabelingStrategy; |
75 |
import com.iver.utiles.swing.threads.Cancellable; |
76 |
/**
|
77 |
* This interface enables support for labeling an object such as a layer, but also others, if any. It gives support for detecting if labeling is being applied (<code>isLabeled()</code> and <code>setIsLabeled()</code>), to manage the labeling strategy (<code>getLabelingStrategy()</code> and <code>setLabelingStrategy</code>). The labeling is performed by the <code>drawLabels(..)</code> method.
|
78 |
* @author jaume dominguez faus - jaume.dominguez@iver.es
|
79 |
*/
|
80 |
public interface ILabelable { |
81 |
/**
|
82 |
* Returns <b>true</b> if labels are drawn, or <b>false</b> otherwise.
|
83 |
* @return <b>boolean</b> telling if labels are drawn
|
84 |
*/
|
85 |
public boolean isLabeled(); |
86 |
|
87 |
/**
|
88 |
* Enables or disables the label drawing.
|
89 |
* @param isLabeled, if true then labels will be drawn
|
90 |
*/
|
91 |
public void setIsLabeled(boolean isLabeled); |
92 |
|
93 |
/**
|
94 |
* Returns the current labeling strategy
|
95 |
* @return ILabelingStrategy
|
96 |
* @see ILabelingStrategy
|
97 |
*/
|
98 |
public ILabelingStrategy getLabelingStrategy();
|
99 |
|
100 |
/**
|
101 |
* Sets the new labeling strategy. Changes on the results will take effect next time the drawLabels(...) method is invoked.
|
102 |
* @param strategy
|
103 |
* @uml.property name="labelingStrategy"
|
104 |
*/
|
105 |
public void setLabelingStrategy(ILabelingStrategy strategy); |
106 |
|
107 |
/**
|
108 |
* Causes the labels to be drawn. The policy of process is determined by
|
109 |
* the LabelingStrategy previously set.
|
110 |
*
|
111 |
* @param image
|
112 |
* @param g
|
113 |
* @param viewPort
|
114 |
* @param cancel
|
115 |
* @param scale
|
116 |
* @throws DriverException
|
117 |
*/
|
118 |
public void drawLabels(BufferedImage image, Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale) throws ReadDriverException; |
119 |
} |