Statistics
| Revision:

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

History | View | Annotate | Download (5.98 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: IPlacementConstraints.java 13606 2007-09-10 15:47:11Z jaume $
45
 * $Log$
46
 * Revision 1.11  2007-09-10 15:47:11  jaume
47
 * *** empty log message ***
48
 *
49
 * Revision 1.10  2007/07/18 06:54:34  jaume
50
 * continuing with cartographic support
51
 *
52
 * Revision 1.9  2007/04/18 15:35:11  jaume
53
 * *** empty log message ***
54
 *
55
 * Revision 1.8  2007/04/13 12:42:32  jaume
56
 * *** empty log message ***
57
 *
58
 * Revision 1.7  2007/04/13 11:59:30  jaume
59
 * *** empty log message ***
60
 *
61
 * Revision 1.6  2007/04/12 16:01:11  jaume
62
 * *** empty log message ***
63
 *
64
 * Revision 1.5  2007/04/12 14:28:43  jaume
65
 * basic labeling support for lines
66
 *
67
 * Revision 1.4  2007/04/11 16:01:08  jaume
68
 * maybe a label placer refactor
69
 *
70
 * Revision 1.3  2007/04/02 16:34:56  jaume
71
 * Styled labeling (start commiting)
72
 *
73
 * Revision 1.2  2007/03/09 08:33:43  jaume
74
 * *** empty log message ***
75
 *
76
 * Revision 1.1.2.2  2007/02/15 16:23:44  jaume
77
 * *** empty log message ***
78
 *
79
 * Revision 1.1.2.1  2007/02/09 07:47:05  jaume
80
 * Isymbol moved
81
 *
82
 *
83
 */
84

    
85
package com.iver.cit.gvsig.fmap.rendering.styling;
86

    
87
import java.awt.Graphics2D;
88
import java.awt.geom.AffineTransform;
89

    
90
import org.cresques.px.gml.MultiPolygon;
91

    
92
import com.iver.cit.gvsig.fmap.core.FShape;
93
import com.iver.cit.gvsig.fmap.core.IGeometry;
94
import com.iver.cit.gvsig.fmap.drivers.IFeatureIterator;
95
import com.iver.utiles.IPersistance;
96

    
97
/**
98
 * @author   jaume dominguez faus - jaume.dominguez@iver.es
99
 */
100
public interface IPlacementConstraints extends IPersistance {
101

    
102
        // constants regarding label duplication
103
        public static final int REMOVE_DUPLICATE_LABELS             =       2;
104
        public static final int ONE_LABEL_PER_FEATURE               =       3;
105
        public static final int ONE_LABEL_PER_FEATURE_PART          =       4;
106

    
107
        // constants regarding point settings
108
        public static final int OFFSET_HORIZONTALY_AROUND_THE_POINT =       5;
109
        public static final int ON_TOP_OF_THE_POINT                 =       6;
110
        public static final int AT_SPECIFIED_ANGLE                  =       7;
111
        public static final int AT_ANGLE_SPECIFIED_BY_A_FIELD       =       8;
112

    
113
        // constants regarding polygon settings (also apply for lines)
114
        public static final int HORIZONTAL                          =       9;
115
        public static final int PARALLEL                            =      10;
116

    
117
        // constants regarding line settings
118
        public static final int FOLLOWING_LINE                      =      11;
119
        public static final int PERPENDICULAR                             =      12;
120

    
121
        // constants regarding the location along the line
122
        public static final int AT_THE_END_OF_THE_LINE              =      13;
123
        public static final int AT_THE_MIDDLE_OF_THE_LINE           =      14;
124
        public static final int AT_THE_BEGINING_OF_THE_LINE         =      15;
125

    
126
        public abstract void setPlacementMode(int mode);
127

    
128
        // regarding label position along the line
129
        public abstract boolean isBellowTheLine();
130
        public abstract void setBellowTheLine(boolean b);
131
        public abstract boolean isAboveTheLine();
132
        public abstract void setAboveTheLine(boolean b);
133
        public abstract boolean isOnTheLine();
134
        public abstract void setOnTheLine(boolean b);
135
        public abstract void setLocationAlongTheLine(int location);
136

    
137

    
138
        // regarding the orientation system
139
        public abstract boolean isPageOriented();
140
        public abstract void setPageOriented(boolean b);
141

    
142
        // regarding the label duplication
143
        public abstract void setDuplicateLabelsMode(int mode);
144
        public abstract int getDuplicateLabelsMode();
145

    
146

    
147
        /**
148
         * Calculates the position where the next label will be placed. Or null
149
         * if the label does not have to be placed.
150
         *
151
         * @deprecated 03/09/07 (per comprovar utilitat)
152
         * @param geom, the geometry surface
153
         * @param label, the label to be placed
154
         * @param MultiPolygon exclusionZone
155
         * @return FShape[], the FShapes where the label will be placed
156
         */
157
        public abstract FShape[] getLocationsFor(IGeometry geom, FShape labelShape,
158
                        MultiPolygon exclusionZone);
159

    
160
        /**
161
         * @deprecated 03/09/07 (per comprovar utilitat)
162
         * @param g
163
         * @param geom
164
         * @param lc
165
         * @param exclusionZone
166
         * @param transform
167
         */
168
        public abstract void placeLabel(Graphics2D g, IGeometry geom,
169
                LabelClass lc, MultiPolygon exclusionZone, AffineTransform transform);
170

    
171
        public abstract boolean isParallel();
172

    
173
        public abstract boolean isFollowingLine();
174

    
175
        public abstract boolean isPerpendicular();
176

    
177
        public abstract boolean isHorizontal();
178

    
179
        public abstract boolean isAtTheBeginingOfLine();
180

    
181
        public abstract boolean isInTheMiddleOfLine();
182

    
183
        public abstract boolean isAtTheEndOfLine();
184

    
185
        public abstract boolean isOnTopOfThePoint();
186

    
187
        public abstract boolean isAroundThePoint();
188

    
189
        public boolean isFitInsidePolygon();
190

    
191
        public void setFitInsidePolygon(boolean b);
192

    
193
        /**
194
         * @deprecated 03/09/07 (per comprovar utilitat)
195
         * @param featIterator
196
         */
197
        public void preprocess(IFeatureIterator featIterator);
198
        
199
        /**
200
         * @deprecated 03/09/07 (per comprovar utilitat)
201
         */
202
        public void postprocess();
203
        
204
}