Statistics
| Revision:

root / trunk / libraries / libFMap / src / com / iver / cit / gvsig / fmap / rendering / styling / ILabelingStrategy.java @ 10679

History | View | Annotate | Download (4.29 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: ILabelingStrategy.java 10679 2007-03-09 11:25:01Z jaume $
45
* $Log$
46
* Revision 1.3  2007-03-09 11:20:57  jaume
47
* Advanced symbology (start committing)
48
*
49
* Revision 1.2  2007/03/09 08:33:43  jaume
50
* *** empty log message ***
51
*
52
* Revision 1.1.2.4  2007/02/15 16:23:44  jaume
53
* *** empty log message ***
54
*
55
* Revision 1.1.2.3  2007/02/09 07:47:05  jaume
56
* Isymbol moved
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.rendering.styling;
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.utiles.IPersistance;
75
import com.iver.utiles.swing.threads.Cancellable;
76

    
77
/**
78
 * A LabelingStrategy is a way to define how the labels are painted in a map, or potentially other object implementing ILabelable. It contains methods for allowing the definition of labeling classes through the labeling method (see <b>ILabelingMethod</b>), the placement of such labels (see <b>IPlacementConstraints</b>), and the zoom properties (see <b>ZoomConstraints</b>)
79
 * @author   jaume dominguez faus - jaume.dominguez@iver.es
80
 */
81
public interface ILabelingStrategy extends IPersistance {
82

    
83
        /**
84
         * Returns the labeling method currently in use. The labeling method handles
85
         * a list of LabelClass that allows to handle several definition of labels
86
         * in the layer.
87
         * @return ILabelingMethod, the current one.
88
         * @see ILabelingMethod
89
         */
90
    public ILabelingMethod getLabelingMethod();
91

    
92
    /**
93
         * Sets the labeling method that will be used the next time the the draw is invoked.
94
         * @param   method, the new labeling method
95
         */
96
    public void setLabelingMethod(ILabelingMethod method);
97

    
98

    
99
    /**
100
     * Returns the current placement constraints that determine the position
101
     * where the label is placed.
102
     * @return
103
     */
104
    public IPlacementConstraints getPlacementConstraints();
105

    
106
    /**
107
         * Sets the PlacementConstraints that will determine where to place the labels. The change will take effect next time the draw(...) method is invoked.
108
         * @param  constraints
109
         */
110
    public void setPlacementConstraints(IPlacementConstraints constraints);
111

    
112
    /**
113
     * Returns the current placement constraints that determine the position
114
     * where the label is placed.
115
     * @return
116
     */
117
    public IZoomConstraints getZoomConstraints();
118

    
119
    /**
120
         * Sets the PlacementConstraints that will determine where to place the labels. The change will take effect next time the draw(...) method is invoked.
121
         * @param  constraints
122
         */
123
    public void setZoomConstraints(IZoomConstraints constraints);
124

    
125
    /** Causes the labels to be drawn. The policy of process is determined by
126
         * the LabelingStrategy previously set.
127
         *
128
         * @param image
129
         * @param g
130
         * @param viewPort
131
         * @param cancel
132
         * @param scale
133
         * @throws DriverException
134
         */
135
     public void draw(BufferedImage image, Graphics2D g, ViewPort viewPort,
136
        Cancellable cancel) throws ReadDriverException;
137

    
138
}