Statistics
| Revision:

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

History | View | Annotate | Download (5.01 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 11199 2007-04-13 12:46:40Z jaume $
45
 * $Log$
46
 * Revision 1.8  2007-04-13 12:42:32  jaume
47
 * *** empty log message ***
48
 *
49
 * Revision 1.7  2007/04/13 11:59:30  jaume
50
 * *** empty log message ***
51
 *
52
 * Revision 1.6  2007/04/12 16:01:11  jaume
53
 * *** empty log message ***
54
 *
55
 * Revision 1.5  2007/04/12 14:28:43  jaume
56
 * basic labeling support for lines
57
 *
58
 * Revision 1.4  2007/04/11 16:01:08  jaume
59
 * maybe a label placer refactor
60
 *
61
 * Revision 1.3  2007/04/02 16:34:56  jaume
62
 * Styled labeling (start commiting)
63
 *
64
 * Revision 1.2  2007/03/09 08:33:43  jaume
65
 * *** empty log message ***
66
 *
67
 * Revision 1.1.2.2  2007/02/15 16:23:44  jaume
68
 * *** empty log message ***
69
 *
70
 * Revision 1.1.2.1  2007/02/09 07:47:05  jaume
71
 * Isymbol moved
72
 *
73
 *
74
 */
75

    
76
package com.iver.cit.gvsig.fmap.rendering.styling;
77

    
78
import java.awt.Graphics2D;
79
import java.awt.geom.AffineTransform;
80

    
81
import org.cresques.px.gml.MultiPolygon;
82

    
83
import com.iver.cit.gvsig.fmap.core.FShape;
84
import com.iver.cit.gvsig.fmap.core.IGeometry;
85
import com.iver.cit.gvsig.fmap.core.symbols.ITextSymbol;
86
import com.iver.utiles.IPersistance;
87

    
88
/**
89
 * @author   jaume dominguez faus - jaume.dominguez@iver.es
90
 */
91
public interface IPlacementConstraints extends IPersistance {
92

    
93
        // constants regarding label duplication
94
        public static final int REMOVE_DUPLICATE_LABELS             =       2;
95
        public static final int ONE_LABEL_PER_FEATURE               =       3;
96
        public static final int ONE_LABEL_PER_FEATURE_PART          =       4;
97

    
98
        // constants regarding point settings
99
        public static final int OFFSET_HORIZONTALY_AROUND_THE_POINT =       5;
100
        public static final int ON_TOP_OF_THE_POINT                 =       6;
101
        public static final int AT_SPECIFIED_ANGLE                  =       7;
102
        public static final int AT_ANGLE_SPECIFIED_BY_A_FIELD       =       8;
103

    
104
        // constants regarding polygon settings (also apply for lines)
105
        public static final int HORIZONTAL                          =       9;
106
        public static final int PARALLEL                            =      10;
107

    
108
        // constants regarding line settings
109
        public static final int FOLLOWING_LINE                      =      11;
110
        public static final int PERPENDICULAR                             =      12;
111

    
112
        // constants regarding the location along the line
113
        public static final int AT_THE_END_OF_THE_LINE              =      13;
114
        public static final int AT_THE_MIDDLE_OF_THE_LINE           =      14;
115
        public static final int AT_THE_BEGINING_OF_THE_LINE         =      15;
116

    
117
        public abstract void setPlacementMode(int mode);
118

    
119
        // regarding label position along the line
120
        public abstract boolean isBellowTheLine();
121
        public abstract void setBellowTheLine(boolean b);
122
        public abstract boolean isAboveTheLine();
123
        public abstract void setAboveTheLine(boolean b);
124
        public abstract boolean isOnTheLine();
125
        public abstract void setOnTheLine(boolean b);
126
        public abstract void setLocationAlongTheLine(int location);
127

    
128

    
129
        // regarding the orientation system
130
        public abstract boolean isPageOriented();
131
        public abstract void setPageOriented(boolean b);
132

    
133
        // regarding the label duplication
134
        public abstract void setDuplicateLabelsMode(int mode);
135
        public abstract int getDuplicateLabelsMode();
136

    
137

    
138
        /**
139
         * Calculates the position where the next label will be placed. Or null
140
         * if the label does not have to be placed.
141
         *
142
         * @param geom, the geometry surface
143
         * @param label, the label to be placed
144
         * @param MultiPolygon exclusionZone
145
         * @return FShape[], the FShapes where the label will be placed
146
         */
147
        public abstract FShape[] getLocationsFor(IGeometry geom, FShape labelShape,
148
                        MultiPolygon exclusionZone);
149

    
150
        public abstract void placeLabel(Graphics2D g, IGeometry geom,
151
                LabelClass lc, MultiPolygon exclusionZone, AffineTransform transform);
152

    
153
        public abstract boolean isParallel();
154

    
155
        public abstract boolean isFollowingLine();
156

    
157
        public abstract boolean isPerpendicular();
158

    
159
        public abstract boolean isHorizontal();
160
}