Revision 432
trunk/org.gvsig.app.document.layout2.app/org.gvsig.app.document.layout2.app.mainplugin/src/main/java/org/gvsig/app/project/documents/layout/LayoutContext.java | ||
---|---|---|
38 | 38 |
|
39 | 39 |
/** |
40 | 40 |
* Returns the AffineTransform that is applying in the Layout. |
41 |
*
|
|
41 |
* |
|
42 | 42 |
* @return AffineTransform |
43 | 43 |
*/ |
44 | 44 |
public AffineTransform getAT(); |
45 | 45 |
|
46 | 46 |
/** |
47 | 47 |
* Call all LayoutDrawListeners. |
48 |
*
|
|
48 |
* |
|
49 | 49 |
*/ |
50 | 50 |
public void notifAllObservers(); |
51 | 51 |
|
52 | 52 |
/** |
53 | 53 |
* It returns the print attributes of the Layout. |
54 |
*
|
|
54 |
* |
|
55 | 55 |
* @return Attributes. |
56 | 56 |
*/ |
57 | 57 |
public Attributes getAttributes(); |
58 | 58 |
|
59 | 59 |
/** |
60 | 60 |
* Inserts the print attributes of Layout. |
61 |
* |
|
62 |
* @param attributes |
|
63 |
* Attributes. |
|
61 |
* |
|
62 |
* @param attributes Attributes. |
|
64 | 63 |
*/ |
65 | 64 |
public void setAtributes(Attributes attributes); |
66 | 65 |
|
67 | 66 |
/** |
68 | 67 |
* It obtains the Array with all the FFrames that have been added al Layout. |
69 |
*
|
|
68 |
* |
|
70 | 69 |
* @return Array with all the FFrames that have been added al Layout. |
71 | 70 |
*/ |
72 | 71 |
public IFFrame[] getFFrames(); |
73 | 72 |
|
74 | 73 |
/** |
75 | 74 |
* It obtains the FFrame from an index. |
76 |
**/ |
|
75 |
* |
|
76 |
*/ |
|
77 | 77 |
public IFFrame getFFrame(int i); |
78 | 78 |
|
79 | 79 |
/** |
80 | 80 |
* It orders the FFrames depending on its position specified by level. |
81 |
*
|
|
81 |
* |
|
82 | 82 |
*/ |
83 | 83 |
public void updateFFrames(); |
84 | 84 |
|
85 | 85 |
/** |
86 | 86 |
* Remove the fframes selected. |
87 |
*
|
|
87 |
* |
|
88 | 88 |
*/ |
89 | 89 |
public void delFFrameSelected(); |
90 | 90 |
|
91 | 91 |
/** |
92 | 92 |
* Clear the selection of FFrames. |
93 |
*
|
|
93 |
* |
|
94 | 94 |
*/ |
95 | 95 |
public void clearSelection(); |
96 | 96 |
|
97 | 97 |
/** |
98 | 98 |
* Remove the fframe of index. |
99 |
*
|
|
99 |
* |
|
100 | 100 |
*/ |
101 | 101 |
public void delFFrame(int index); |
102 | 102 |
|
103 | 103 |
/** |
104 | 104 |
* Remove the fframe of parameter. |
105 |
* |
|
106 |
* @param frame |
|
107 |
* FFrame to remove. |
|
105 |
* |
|
106 |
* @param frame FFrame to remove. |
|
108 | 107 |
*/ |
109 | 108 |
public void delFFrame(IFFrame frame); |
110 | 109 |
|
111 | 110 |
/** |
112 | 111 |
* Returns the EditableFeatureSource, is the control of all change in the |
113 | 112 |
* FFrames of Layout. |
114 |
*
|
|
113 |
* |
|
115 | 114 |
* @return EditableFatureSource. |
116 | 115 |
*/ |
117 | 116 |
public FrameCommandsRecord getFrameCommandsRecord(); |
118 | 117 |
|
119 | 118 |
/** |
120 | 119 |
* It adds a fframe to Arraylist of FFrames . |
121 |
* |
|
122 |
* @param frame |
|
123 |
* fframe to add. |
|
124 |
* @param clearSelection |
|
125 |
* True |
|
126 |
* True if clean the selection of the fframes already added and |
|
127 |
* false if intends to maintain the same selection. |
|
128 |
* @param select |
|
129 |
* Boolean that indicates if has to remain selected the FFrame |
|
130 |
* that is added or not. |
|
120 |
* |
|
121 |
* @param frame fframe to add. |
|
122 |
* @param clearSelection True True if clean the selection of the fframes |
|
123 |
* already added and false if intends to maintain the same selection. |
|
124 |
* @param select Boolean that indicates if has to remain selected the FFrame |
|
125 |
* that is added or not. |
|
131 | 126 |
*/ |
132 | 127 |
public void addFFrame(IFFrame frame, boolean clearSelection, boolean select); |
133 | 128 |
|
134 | 129 |
/** |
135 | 130 |
* It adds a fframe to Arraylist of FFrames with the same properties. |
136 |
* |
|
137 |
* @param frame |
|
138 |
* fframe to add. |
|
131 |
* |
|
132 |
* @param frame fframe to add. |
|
139 | 133 |
*/ |
140 | 134 |
public void addFFrameSameProperties(IFFrame frame); |
141 | 135 |
|
142 | 136 |
/** |
143 | 137 |
* Returns other number behind the current fframes. |
144 |
*
|
|
138 |
* |
|
145 | 139 |
* @return new Position behind. |
146 | 140 |
*/ |
147 | 141 |
public int getNumBehind(); |
148 | 142 |
|
149 | 143 |
/** |
150 | 144 |
* Returns other number before the current fframes. |
151 |
*
|
|
145 |
* |
|
152 | 146 |
* @return new Position before. |
153 | 147 |
*/ |
154 | 148 |
public int getNumBefore(); |
155 | 149 |
|
156 | 150 |
/** |
157 |
* It returns all the fframes included them erased and modified in all |
|
158 |
* its previous forms.
|
|
159 |
*
|
|
151 |
* It returns all the fframes included them erased and modified in all its
|
|
152 |
* previous forms. |
|
153 |
* |
|
160 | 154 |
* @return IFFrame[] Array of FFrames. |
161 | 155 |
*/ |
162 | 156 |
public IFFrame[] getAllFFrames(); |
163 | 157 |
|
164 | 158 |
/** |
165 | 159 |
* Gets the list of selected FFrames |
166 |
*
|
|
160 |
* |
|
167 | 161 |
* @return An Array of selected FFrames |
168 | 162 |
*/ |
169 | 163 |
public IFFrame[] getSelectedFFrames(); |
170 |
|
|
164 |
|
|
171 | 165 |
/** |
172 |
* Gets the list of selected FFrames that are instance of |
|
173 |
* the provided Class. |
|
166 |
* Gets the list of selected FFrames that are instance of the provided |
|
167 |
* Class. |
|
168 |
* |
|
174 | 169 |
* @param <T> |
175 |
*
|
|
170 |
* |
|
176 | 171 |
* @param clazz A class |
177 | 172 |
* @return An Array of selected FFrames |
178 | 173 |
*/ |
... | ... | |
180 | 175 |
|
181 | 176 |
/** |
182 | 177 |
* It returns if the Layout is in edition. |
183 |
*
|
|
178 |
* |
|
184 | 179 |
* @return True if Layout is in edition. |
185 | 180 |
*/ |
186 | 181 |
public boolean isEditable(); |
187 | 182 |
|
188 | 183 |
/** |
189 | 184 |
* It inserts if the Layout is in edition. |
190 |
* |
|
191 |
* @param b |
|
192 |
* True if Layout is in edition. |
|
185 |
* |
|
186 |
* @param b True if Layout is in edition. |
|
193 | 187 |
*/ |
194 | 188 |
public void setEditable(boolean b); |
195 | 189 |
|
196 | 190 |
/** |
197 | 191 |
* It returns if has been applying in the fframes that are added to Layout |
198 | 192 |
* the grid, or not. |
199 |
*
|
|
193 |
* |
|
200 | 194 |
* @return true if has been applying the grid. |
201 | 195 |
*/ |
202 | 196 |
public boolean isAdjustingToGrid(); |
... | ... | |
204 | 198 |
/** |
205 | 199 |
* It inserts if has been applying in the fframes that are added to Layout |
206 | 200 |
* the grid, or not. |
207 |
* |
|
208 |
* @param b |
|
209 |
* true if has been applying the grid. |
|
201 |
* |
|
202 |
* @param b true if has been applying the grid. |
|
210 | 203 |
*/ |
211 | 204 |
public void setAdjustToGrid(boolean b); |
212 | 205 |
|
213 | 206 |
/** |
214 | 207 |
* It inserts if is shown or not the rule of the Layout. |
215 |
* |
|
216 |
* @param b |
|
217 |
* True if is shown or not the rule of the Layout. |
|
208 |
* |
|
209 |
* @param b True if is shown or not the rule of the Layout. |
|
218 | 210 |
*/ |
219 | 211 |
public void setRuler(boolean b); |
220 | 212 |
|
221 | 213 |
/** |
222 | 214 |
* Returns if is shown or not the rule of the Layout. |
223 |
*
|
|
215 |
* |
|
224 | 216 |
* @return True si se muestra la regla. |
225 | 217 |
*/ |
226 | 218 |
public boolean getRuler(); |
227 | 219 |
|
228 | 220 |
/** |
229 | 221 |
* It returns if has been showing the grid of Layout, or not. |
230 |
*
|
|
222 |
* |
|
231 | 223 |
* @return true if has been showing the grid of Layout. |
232 | 224 |
*/ |
233 | 225 |
public boolean isGridVisible(); |
234 | 226 |
|
235 | 227 |
/** |
236 | 228 |
* It inserts if draws the Grid in the Layout or not. |
237 |
* |
|
238 |
* @param b |
|
239 |
* True if draws the Grid in the Layout. |
|
229 |
* |
|
230 |
* @param b True if draws the Grid in the Layout. |
|
240 | 231 |
*/ |
241 | 232 |
public void setGridVisible(boolean b); |
242 | 233 |
|
... | ... | |
248 | 239 |
public void setNumBehind(int numBehind); |
249 | 240 |
|
250 | 241 |
public void setNumBefore(int numBefore); |
251 |
|
|
242 |
|
|
252 | 243 |
/** |
253 |
* Sets the model of the TOC. The LayoutPanel will create |
|
254 |
* a TOC in the user interface if a tocModel has been set.
|
|
244 |
* Sets the model of the TOC. The LayoutPanel will create a TOC in the user
|
|
245 |
* interface if a tocModel has been set. |
|
255 | 246 |
*/ |
256 | 247 |
public void setTocModel(MapContext tocModel); |
257 | 248 |
|
258 | 249 |
/** |
259 |
* Gets the model of the TOC. The LayoutPanel will create |
|
260 |
* a TOC in the user interface if a tocModel has been set.
|
|
250 |
* Gets the model of the TOC. The LayoutPanel will create a TOC in the user
|
|
251 |
* interface if a tocModel has been set. |
|
261 | 252 |
*/ |
262 | 253 |
public MapContext getTocModel(); |
263 | 254 |
|
... | ... | |
265 | 256 |
* Triggers a notification to the TocModel observers of type |
266 | 257 |
* {@link TocModelChangedNotification#MODEL_CHANGED} |
267 | 258 |
*/ |
268 |
public void notifyTocUpdated(TocModelChangedNotification.Type notificationType);
|
|
269 |
|
|
259 |
public void notifyTocUpdated(TocModelChangedNotification.Type notificationType);
|
|
260 |
|
|
270 | 261 |
public void addTocObserver(TocModelObserver observer); |
271 |
|
|
262 |
|
|
272 | 263 |
public void removeTocObserver(TocModelObserver observer); |
273 |
|
|
264 |
|
|
274 | 265 |
public void removeTocObservers(); |
275 |
|
|
266 |
|
|
276 | 267 |
/** |
277 |
* True when the document window has been opened at least once, false otherwise. This is required |
|
278 |
* to decide whether the page setting dialog has to be shown to the user, otherwise it would be |
|
279 |
* shown every time the document is opened from project persistence |
|
268 |
* True when the document window has been opened at least once, false |
|
269 |
* otherwise. This is required to decide whether the page setting dialog has |
|
270 |
* to be shown to the user, otherwise it would be shown every time the |
|
271 |
* document is opened from project persistence |
|
280 | 272 |
*/ |
281 |
public boolean hasDocBeenOpened();
|
|
273 |
public boolean hasDocBeenOpened();
|
|
282 | 274 |
|
283 | 275 |
/** |
284 |
* True when the document window has been opened at least once, false otherwise. This is required |
|
285 |
* to decide whether the page setting dialog has to be shown to the user, otherwise it would be |
|
286 |
* shown every time the document is opened from project persistence |
|
276 |
* True when the document window has been opened at least once, false |
|
277 |
* otherwise. This is required to decide whether the page setting dialog has |
|
278 |
* to be shown to the user, otherwise it would be shown every time the |
|
279 |
* document is opened from project persistence |
|
287 | 280 |
*/ |
288 |
public void setHasDocBeenOpened(boolean hasBeenOpened);
|
|
281 |
public void setHasDocBeenOpened(boolean hasBeenOpened);
|
|
289 | 282 |
} |
Also available in: Unified diff