Statistics
| Revision:

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

History | View | Annotate | Download (4.77 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 11138 2007-04-11 16:01:08Z jaume $
45
 * $Log$
46
 * Revision 1.4  2007-04-11 16:01:08  jaume
47
 * maybe a label placer refactor
48
 *
49
 * Revision 1.3  2007/04/02 16:34:56  jaume
50
 * Styled labeling (start commiting)
51
 *
52
 * Revision 1.2  2007/03/09 08:33:43  jaume
53
 * *** empty log message ***
54
 *
55
 * Revision 1.1.2.2  2007/02/15 16:23:44  jaume
56
 * *** empty log message ***
57
 *
58
 * Revision 1.1.2.1  2007/02/09 07:47:05  jaume
59
 * Isymbol moved
60
 *
61
 *
62
 */
63

    
64
package com.iver.cit.gvsig.fmap.rendering.styling;
65

    
66
import java.awt.geom.AffineTransform;
67

    
68
import org.cresques.px.gml.MultiPolygon;
69

    
70
import com.iver.cit.gvsig.fmap.core.FShape;
71
import com.iver.cit.gvsig.fmap.core.IGeometry;
72
import com.iver.cit.gvsig.fmap.core.symbols.ITextSymbol;
73

    
74
/**
75
 * @author   jaume dominguez faus - jaume.dominguez@iver.es
76
 */
77
public interface IPlacementConstraints {
78

    
79
        // constants regarding label duplication
80
        public static final int REMOVE_DUPLICATE_LABELS             =       2;
81
        public static final int ONE_LABEL_PER_FEATURE               =       3;
82
        public static final int ONE_LABEL_PER_FEATURE_PART          =       4;
83

    
84
        // constants regarding point settings
85
        public static final int OFFSET_HORIZONTALY_AROUND_THE_POINT =       5;
86
        public static final int ON_TOP_OF_THE_POINT                 =       6;
87
        public static final int AT_SPECIFIED_ANGLE                  =       7;
88
        public static final int AT_ANGLE_SPECIFIED_BY_A_FIELD       =       8;
89

    
90
        // constants regarding polygon settings (also apply for lines)
91
        public static final int HORIZONTAL                          =       9;
92
        public static final int PARALLEL                            =      10;
93

    
94
        // constants regarding line settings
95
        public static final int FOLLOWING_LINE                      =      11;
96
        public static final int PERPENDICULAR                       =      12;
97

    
98
        // constants regarding label position along the line
99
        public static final int ABOVE_THE_LINE                      =    1000;
100
        public static final int ON_THE_LINE                         =    1100;
101
        public static final int BELLOW_THE_LINE                     =    1200;
102
        public static final int AT_THE_BEGINING                     =   10000;
103
        public static final int AT_THE_END                          =   20000;
104
        public static final int PAGE_ORIENTED                       =  100000;
105
        public static final int LINE_ORIENTED                       =  200000;
106

    
107
        public abstract void setDuplicateLabelsMode(int mode);
108

    
109
        public abstract void setPlacementMode(int mode);
110

    
111
        public abstract boolean isHorizontal();
112

    
113
        public abstract boolean isPerpendicular();
114

    
115
        public abstract boolean isFollowingLine();
116

    
117
        public abstract boolean isParallel();
118

    
119
        public abstract int getDuplicateLabelsMode();
120

    
121
        /**
122
         * Tells if the place mode selected is to put the label over the <b>POINT</b>
123
         * @return boolean
124
         */
125
        public abstract boolean isOnTopOfThePoint();
126

    
127
        public abstract boolean isAtTheBeginingOfLine();
128
        public abstract boolean isAtTheEndOfLine();
129
        public abstract boolean isBellowTheLine();
130
        public abstract boolean isAboveTheLine();
131
        public abstract boolean isPageOriented();
132
        public abstract boolean isLineOriented();
133

    
134

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

    
147
        public abstract void placeLabel(IGeometry geom, LabelClass lc, MultiPolygon exclusionZone, AffineTransform transform);
148

    
149
}