Statistics
| Revision:

root / trunk / libraries / libFMap / src / com / iver / cit / gvsig / fmap / core / styles / ILabelStyle.java @ 11073

History | View | Annotate | Download (3.52 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: ILabelStyle.java 11073 2007-04-05 16:08:34Z jaume $
45
* $Log$
46
* Revision 1.7  2007-04-05 16:07:14  jaume
47
* Styled labeling stuff
48
*
49
* Revision 1.6  2007/04/04 15:42:03  jaume
50
* *** empty log message ***
51
*
52
* Revision 1.5  2007/04/04 15:41:05  jaume
53
* *** empty log message ***
54
*
55
* Revision 1.4  2007/04/02 16:34:56  jaume
56
* Styled labeling (start commiting)
57
*
58
* Revision 1.3  2007/03/29 16:02:01  jaume
59
* *** empty log message ***
60
*
61
* Revision 1.2  2007/03/09 11:20:56  jaume
62
* Advanced symbology (start committing)
63
*
64
* Revision 1.1.2.1  2007/02/15 16:23:44  jaume
65
* *** empty log message ***
66
*
67
* Revision 1.1.2.1  2007/02/09 07:47:05  jaume
68
* Isymbol moved
69
*
70
*
71
*/
72
package com.iver.cit.gvsig.fmap.core.styles;
73

    
74
import java.awt.Rectangle;
75
import java.awt.geom.Point2D;
76
import java.awt.geom.Rectangle2D;
77

    
78
/**
79
 * Defines the style that a Label symbol can contain which typically define
80
 * a background of the label as an Image, the texts that the label holds
81
 * and their position within the label in rendering time.
82
 *
83
 * @author jaume dominguez faus - jaume.dominguez@iver.es
84
 *
85
 */
86
public interface ILabelStyle extends IStyle {
87
        /**
88
         * @return int, the amount of fields this style allows
89
         */
90
        public int getFieldCount();
91

    
92
        /**
93
         * Sets the texts that will appear in the label.
94
         * @param texts
95
         */
96
        public void setTextFields(String[] texts);
97

    
98
        /**
99
         * Returns the text at the i-th field.
100
         * @param int i.
101
         * @return String
102
         */
103
        public String getTextAt(int i);
104

    
105
        /**
106
         * Return an array of rectangles defining the text boxes where text is
107
         * placed.
108
         * @return
109
         */
110
        public Rectangle2D[] getTextBounds();
111

    
112
        /**
113
         * The complete bounds of this ILabelStyle
114
         * @return
115
         */
116
        public Rectangle getBounds();
117

    
118
        /**
119
         * Returns the position of the point labeled by this label in percent units relative
120
         * to the label bounds. It determines the offset to be applied to the label to be
121
         * placed and allows the user to use custom styles.
122
         */
123
        public Point2D getMarkerPoint();
124

    
125
        /**
126
         * Sets the position of the point labeled by this in percent units relative to the
127
         * label bounds
128
         * @param p
129
         * @throws IllegalArgumentException if the point coordinates are >0.0 or <1.0
130
         */
131
        public void setMarkerPoint(Point2D p) throws IllegalArgumentException;
132

    
133
        public void setTextFieldArea(int index, Rectangle2D rect);
134

    
135
        public void addTextFieldArea(Rectangle2D rect);
136

    
137
        public void deleteTextFieldArea(int index);
138

    
139
}