Statistics
| Revision:

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

History | View | Annotate | Download (3.29 KB)

1 10679 jaume
/* 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$
45
* $Log$
46 11052 jaume
* Revision 1.6  2007-04-04 15:42:03  jaume
47 11051 jaume
* *** empty log message ***
48
*
49 11052 jaume
* Revision 1.5  2007/04/04 15:41:05  jaume
50
* *** empty log message ***
51
*
52 11051 jaume
* Revision 1.4  2007/04/02 16:34:56  jaume
53 11009 jaume
* Styled labeling (start commiting)
54
*
55
* Revision 1.3  2007/03/29 16:02:01  jaume
56 10977 jaume
* *** empty log message ***
57
*
58
* Revision 1.2  2007/03/09 11:20:56  jaume
59 10679 jaume
* Advanced symbology (start committing)
60
*
61
* Revision 1.1.2.1  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
package com.iver.cit.gvsig.fmap.core.styles;
70
71 11051 jaume
import java.awt.Dimension;
72 11009 jaume
import java.awt.Rectangle;
73 11051 jaume
import java.awt.geom.Point2D;
74 10679 jaume
75
/**
76
 * Defines the style that a Label symbol can contain which typically define
77
 * a background of the label as an Image, the texts that the label holds
78
 * and their position within the label in rendering time.
79
 *
80
 * @author jaume dominguez faus - jaume.dominguez@iver.es
81
 *
82
 */
83
public interface ILabelStyle extends IStyle {
84
        /**
85
         * @return int, the amount of fields this style allows
86
         */
87
        public int getFieldCount();
88
89
        /**
90
         * Sets the texts that will appear in the label.
91
         * @param texts
92
         */
93
        public void setTextFields(String[] texts);
94
95
        /**
96 11009 jaume
         * Returns the text at the i-th field.
97
         * @param int i.
98
         * @return String
99 10679 jaume
         */
100 11009 jaume
        public String getTextAt(int i);
101 10679 jaume
102
        /**
103 11009 jaume
         * Return an array of rectangles defining the text boxes where text is
104
         * placed.
105 10679 jaume
         * @return
106
         */
107 11009 jaume
        public Rectangle[] getTextBounds();
108 10679 jaume
109 11051 jaume
        /**
110
         * The complete bounds of this ILabelStyle
111
         * @return
112
         */
113 11009 jaume
        public Rectangle getBounds();
114 10679 jaume
115 11051 jaume
        /**
116
         * Returns the position of the point labeled by this label in percent units relative
117
         * to the label bounds. It determines the offset to be applied to the label to be
118
         * placed and allows the user to use custom styles.
119
         */
120
        public Point2D getMarkerPoint();
121
122
        /**
123
         * Sets the position of the point labeled by this in percent units relative to the
124
         * label bounds
125
         * @param p
126
         * @throws IllegalArgumentException if the point coordinates are >0.0 or <1.0
127
         */
128
        public void setMarkerPoint(Point2D p) throws IllegalArgumentException;
129
130 10679 jaume
}