Coverage details for edu.umn.gis.mapscript.imp.legendObj

LineHitsSource
1 // A Java MapScript module for MapServer.
2 // See <http://mapserver.gis.umn.edu> for information on MapServer.
3 //
4 // Copyright (C) 2003 Andrew Collins <andrewrcollins@yahoo.com>
5 //
6 // This library is free software; you can redistribute it
7 // and/or modify it under the terms of the GNU Lesser General
8 // Public License as published by the Free Software Foundation;
9 // either version 2.1 of the License, or (at your option) any
10 // later version.
11 //
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty
14 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 // See the GNU Lesser General Public License for more details.
16 //
17 // You should have received a copy of the GNU Lesser General
18 // Public License along with this library; if not, write to
19 // the Free Software Foundation, Inc., 59 Temple Place,
20 // Suite 330, Boston, MA 02111-1307 USA
21 package edu.umn.gis.mapscript.imp;
22  
23 /**
24  * DOCUMENT ME!
25  *
26  * @author <a href="mailto:ADDRESS">NAME</a>
27  *
28  * @todo CLASS_DESCRIPTION
29  */
30 public class legendObj
31 {
32   /**
33    * DOCUMENT ME!
34    *
35    * @todo FIELD_DESCRIPTION
36    */
37   protected boolean swigCMemOwn;
38  
39   /**
40    * DOCUMENT ME!
41    *
42    * @todo FIELD_DESCRIPTION
43    */
44   private long swigCPtr;
45  
46   /**
47    * Creates a new legendObj object.
48    */
49   public legendObj()
50   {
510    this(MapScriptJNI.new_legendObj(), true);
520  }
53  
54   /**
55    * Creates a new legendObj object.
56    *
57    * @param cPtr PARAMETER
58    * @param cMemoryOwn PARAMETER
59    */
60   protected legendObj(long cPtr, boolean cMemoryOwn)
610  {
620    swigCMemOwn = cMemoryOwn;
630    swigCPtr = cPtr;
640  }
65  
66   /**
67    * DOCUMENT ME!
68    *
69    * @param height PARAMETER
70    *
71    * @todo METHOD_DESCRIPTION
72    */
73   public void setHeight(int height)
74   {
750    MapScriptJNI.set_legendObj_height(swigCPtr, height);
760  }
77  
78   /**
79    * DOCUMENT ME!
80    *
81    * @return RETURN
82    *
83    * @todo METHOD_DESCRIPTION
84    */
85   public int getHeight()
86   {
870    return MapScriptJNI.get_legendObj_height(swigCPtr);
88   }
89  
90   /**
91    * DOCUMENT ME!
92    *
93    * @param imagecolor PARAMETER
94    *
95    * @todo METHOD_DESCRIPTION
96    */
97   public void setImagecolor(colorObj imagecolor)
98   {
990    MapScriptJNI.set_legendObj_imagecolor(swigCPtr, colorObj.getCPtr(imagecolor));
1000  }
101  
102   /**
103    * DOCUMENT ME!
104    *
105    * @return RETURN
106    *
107    * @todo METHOD_DESCRIPTION
108    */
109   public colorObj getImagecolor()
110   {
1110    return new colorObj(MapScriptJNI.get_legendObj_imagecolor(swigCPtr), false);
112   }
113  
114   /**
115    * DOCUMENT ME!
116    *
117    * @param interlace PARAMETER
118    *
119    * @todo METHOD_DESCRIPTION
120    */
121   public void setInterlace(int interlace)
122   {
1230    MapScriptJNI.set_legendObj_interlace(swigCPtr, interlace);
1240  }
125  
126   /**
127    * DOCUMENT ME!
128    *
129    * @return RETURN
130    *
131    * @todo METHOD_DESCRIPTION
132    */
133   public int getInterlace()
134   {
1350    return MapScriptJNI.get_legendObj_interlace(swigCPtr);
136   }
137  
138   /**
139    * DOCUMENT ME!
140    *
141    * @param keysizex PARAMETER
142    *
143    * @todo METHOD_DESCRIPTION
144    */
145   public void setKeysizex(int keysizex)
146   {
1470    MapScriptJNI.set_legendObj_keysizex(swigCPtr, keysizex);
1480  }
149  
150   /**
151    * DOCUMENT ME!
152    *
153    * @return RETURN
154    *
155    * @todo METHOD_DESCRIPTION
156    */
157   public int getKeysizex()
158   {
1590    return MapScriptJNI.get_legendObj_keysizex(swigCPtr);
160   }
161  
162   /**
163    * DOCUMENT ME!
164    *
165    * @param keysizey PARAMETER
166    *
167    * @todo METHOD_DESCRIPTION
168    */
169   public void setKeysizey(int keysizey)
170   {
1710    MapScriptJNI.set_legendObj_keysizey(swigCPtr, keysizey);
1720  }
173  
174   /**
175    * DOCUMENT ME!
176    *
177    * @return RETURN
178    *
179    * @todo METHOD_DESCRIPTION
180    */
181   public int getKeysizey()
182   {
1830    return MapScriptJNI.get_legendObj_keysizey(swigCPtr);
184   }
185  
186   /**
187    * DOCUMENT ME!
188    *
189    * @param keyspacingx PARAMETER
190    *
191    * @todo METHOD_DESCRIPTION
192    */
193   public void setKeyspacingx(int keyspacingx)
194   {
1950    MapScriptJNI.set_legendObj_keyspacingx(swigCPtr, keyspacingx);
1960  }
197  
198   /**
199    * DOCUMENT ME!
200    *
201    * @return RETURN
202    *
203    * @todo METHOD_DESCRIPTION
204    */
205   public int getKeyspacingx()
206   {
2070    return MapScriptJNI.get_legendObj_keyspacingx(swigCPtr);
208   }
209  
210   /**
211    * DOCUMENT ME!
212    *
213    * @param keyspacingy PARAMETER
214    *
215    * @todo METHOD_DESCRIPTION
216    */
217   public void setKeyspacingy(int keyspacingy)
218   {
2190    MapScriptJNI.set_legendObj_keyspacingy(swigCPtr, keyspacingy);
2200  }
221  
222   /**
223    * DOCUMENT ME!
224    *
225    * @return RETURN
226    *
227    * @todo METHOD_DESCRIPTION
228    */
229   public int getKeyspacingy()
230   {
2310    return MapScriptJNI.get_legendObj_keyspacingy(swigCPtr);
232   }
233  
234   /**
235    * DOCUMENT ME!
236    *
237    * @param label PARAMETER
238    *
239    * @todo METHOD_DESCRIPTION
240    */
241   public void setLabel(labelObj label)
242   {
2430    MapScriptJNI.set_legendObj_label(swigCPtr, labelObj.getCPtr(label));
2440  }
245  
246   /**
247    * DOCUMENT ME!
248    *
249    * @return RETURN
250    *
251    * @todo METHOD_DESCRIPTION
252    */
253   public labelObj getLabel()
254   {
2550    return new labelObj(MapScriptJNI.get_legendObj_label(swigCPtr), false);
256   }
257  
258   /**
259    * DOCUMENT ME!
260    *
261    * @param outlinecolor PARAMETER
262    *
263    * @todo METHOD_DESCRIPTION
264    */
265   public void setOutlinecolor(int outlinecolor)
266   {
2670    MapScriptJNI.set_legendObj_outlinecolor(swigCPtr, outlinecolor);
2680  }
269  
270   /**
271    * DOCUMENT ME!
272    *
273    * @return RETURN
274    *
275    * @todo METHOD_DESCRIPTION
276    */
277   public int getOutlinecolor()
278   {
2790    return MapScriptJNI.get_legendObj_outlinecolor(swigCPtr);
280   }
281  
282   /**
283    * DOCUMENT ME!
284    *
285    * @param position PARAMETER
286    *
287    * @todo METHOD_DESCRIPTION
288    */
289   public void setPosition(int position)
290   {
2910    MapScriptJNI.set_legendObj_position(swigCPtr, position);
2920  }
293  
294   /**
295    * DOCUMENT ME!
296    *
297    * @return RETURN
298    *
299    * @todo METHOD_DESCRIPTION
300    */
301   public int getPosition()
302   {
3030    return MapScriptJNI.get_legendObj_position(swigCPtr);
304   }
305  
306   /**
307    * DOCUMENT ME!
308    *
309    * @param postlabelcache PARAMETER
310    *
311    * @todo METHOD_DESCRIPTION
312    */
313   public void setPostlabelcache(int postlabelcache)
314   {
3150    MapScriptJNI.set_legendObj_postlabelcache(swigCPtr, postlabelcache);
3160  }
317  
318   /**
319    * DOCUMENT ME!
320    *
321    * @return RETURN
322    *
323    * @todo METHOD_DESCRIPTION
324    */
325   public int getPostlabelcache()
326   {
3270    return MapScriptJNI.get_legendObj_postlabelcache(swigCPtr);
328   }
329  
330   /**
331    * DOCUMENT ME!
332    *
333    * @param status PARAMETER
334    *
335    * @todo METHOD_DESCRIPTION
336    */
337   public void setStatus(int status)
338   {
3390    MapScriptJNI.set_legendObj_status(swigCPtr, status);
3400  }
341  
342   /**
343    * DOCUMENT ME!
344    *
345    * @return RETURN
346    *
347    * @todo METHOD_DESCRIPTION
348    */
349   public int getStatus()
350   {
3510    return MapScriptJNI.get_legendObj_status(swigCPtr);
352   }
353  
354   /**
355    * DOCUMENT ME!
356    *
357    * @param template PARAMETER
358    *
359    * @todo METHOD_DESCRIPTION
360    */
361   public void setTemplate(String template)
362   {
3630    MapScriptJNI.set_legendObj_template(swigCPtr, template);
3640  }
365  
366   /**
367    * DOCUMENT ME!
368    *
369    * @return RETURN
370    *
371    * @todo METHOD_DESCRIPTION
372    */
373   public String getTemplate()
374   {
3750    return MapScriptJNI.get_legendObj_template(swigCPtr);
376   }
377  
378   /**
379    * DOCUMENT ME!
380    *
381    * @param transparent PARAMETER
382    *
383    * @todo METHOD_DESCRIPTION
384    */
385   public void setTransparent(int transparent)
386   {
3870    MapScriptJNI.set_legendObj_transparent(swigCPtr, transparent);
3880  }
389  
390   /**
391    * DOCUMENT ME!
392    *
393    * @return RETURN
394    *
395    * @todo METHOD_DESCRIPTION
396    */
397   public int getTransparent()
398   {
3990    return MapScriptJNI.get_legendObj_transparent(swigCPtr);
400   }
401  
402   /**
403    * DOCUMENT ME!
404    *
405    * @param width PARAMETER
406    *
407    * @todo METHOD_DESCRIPTION
408    */
409   public void setWidth(int width)
410   {
4110    MapScriptJNI.set_legendObj_width(swigCPtr, width);
4120  }
413  
414   /**
415    * DOCUMENT ME!
416    *
417    * @return RETURN
418    *
419    * @todo METHOD_DESCRIPTION
420    */
421   public int getWidth()
422   {
4230    return MapScriptJNI.get_legendObj_width(swigCPtr);
424   }
425  
426   /**
427    * DOCUMENT ME!
428    *
429    * @todo METHOD_DESCRIPTION
430    */
431   public void delete()
432   {
4330    if ((swigCPtr != 0) && swigCMemOwn)
434     {
4350      MapScriptJNI.delete_legendObj(swigCPtr);
4360      swigCMemOwn = false;
437     }
438  
4390    swigCPtr = 0;
4400  }
441  
442   /**
443    * DOCUMENT ME!
444    *
445    * @param obj PARAMETER
446    *
447    * @return RETURN
448    *
449    * @todo METHOD_DESCRIPTION
450    */
451   public boolean equals(Object obj)
452   {
4530    boolean equal = false;
454  
4550    if (obj instanceof legendObj)
456     {
4570      equal = (((legendObj) obj).swigCPtr == this.swigCPtr);
458     }
459  
4600    return equal;
461   }
462  
463   /**
464    * DOCUMENT ME!
465    *
466    * @param obj PARAMETER
467    *
468    * @return RETURN
469    *
470    * @todo METHOD_DESCRIPTION
471    */
472   protected static long getCPtr(legendObj obj)
473   {
4740    return obj.swigCPtr;
475   }
476  
477   /**
478    * DOCUMENT ME!
479    *
480    * @todo METHOD_DESCRIPTION
481    */
482   protected void finalize()
483   {
4840    delete();
4850  }
486 }

this report was generated by version 1.0.2 of jcoverage.
visit www.jcoverage.com for updates.

copyright © 2003, jcoverage ltd. all rights reserved.
Java is a trademark of Sun Microsystems, Inc. in the United States and other countries.