Statistics
| Revision:

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

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

    
70
package com.iver.cit.gvsig.fmap.rendering.styling;
71

    
72
import java.awt.Graphics2D;
73
import java.awt.geom.AffineTransform;
74

    
75
import org.cresques.px.gml.MultiPolygon;
76

    
77
import com.iver.cit.gvsig.fmap.core.FShape;
78
import com.iver.cit.gvsig.fmap.core.IGeometry;
79
import com.iver.cit.gvsig.fmap.core.symbols.ITextSymbol;
80

    
81
/**
82
 * @author   jaume dominguez faus - jaume.dominguez@iver.es
83
 */
84
public interface IPlacementConstraints {
85

    
86
        // constants regarding label duplication
87
        public static final int REMOVE_DUPLICATE_LABELS             =       2;
88
        public static final int ONE_LABEL_PER_FEATURE               =       3;
89
        public static final int ONE_LABEL_PER_FEATURE_PART          =       4;
90

    
91
        // constants regarding point settings
92
        public static final int OFFSET_HORIZONTALY_AROUND_THE_POINT =       5;
93
        public static final int ON_TOP_OF_THE_POINT                 =       6;
94
        public static final int AT_SPECIFIED_ANGLE                  =       7;
95
        public static final int AT_ANGLE_SPECIFIED_BY_A_FIELD       =       8;
96

    
97
        // constants regarding polygon settings (also apply for lines)
98
        public static final int HORIZONTAL                          =       9;
99
        public static final int PARALLEL                            =      10;
100

    
101
        // constants regarding line settings
102
        public static final int FOLLOWING_LINE                      =      11;
103
        public static final int PERPENDICULAR                             =      12;
104

    
105
        // constants regarding the location along the line
106
        public static final int AT_THE_END_OF_THE_LINE              =      13;
107
        public static final int AT_THE_MIDDLE_OF_THE_LINE           =      14;
108
        public static final int AT_THE_BEGINING_OF_THE_LINE         =      15;
109

    
110
        public abstract void setPlacementMode(int mode);
111

    
112
        // regarding label position along the line
113
        public abstract boolean isAtTheBeginingOfLine();
114
        public abstract void setAtTheBeginingOfLine(boolean b);
115
        public abstract boolean isAtTheEndOfLine();
116
        public abstract void setAtTheEndOfLine(boolean b);
117
        public abstract boolean isBellowTheLine();
118
        public abstract void setBellowTheLine(boolean b);
119
        public abstract boolean isAboveTheLine();
120
        public abstract void setAboveTheLine(boolean b);
121

    
122
        // regarding the orientation system
123
        public abstract boolean isPageOriented();
124
        public abstract void setPageOriented(boolean b);
125

    
126
        // regarding the label duplication
127
        public abstract void setDuplicateLabelsMode(int mode);
128
        public abstract int getDuplicateLabelsMode();
129

    
130

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

    
143
        public abstract void placeLabel(Graphics2D g, IGeometry geom,
144
                LabelClass lc, MultiPolygon exclusionZone, AffineTransform transform, String[] labelTexts);
145

    
146
        public abstract boolean isParallel();
147

    
148
        public abstract boolean isFollowingLine();
149

    
150
        public abstract boolean isPerpendicular();
151

    
152
        public abstract boolean isHorizontal();
153

    
154
}