fixes JAL-778 - flag to indicate binding between an alignment panel and Jmol view...
[jalview.git] / src / jalview / schemabinding / version2 / Tree.java
1 /*\r
2  * This class was automatically generated with \r
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package jalview.schemabinding.version2;\r
9 \r
10   //---------------------------------/\r
11  //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import org.exolab.castor.xml.Marshaller;\r
15 import org.exolab.castor.xml.Unmarshaller;\r
16 \r
17 /**\r
18  * Class Tree.\r
19  * \r
20  * @version $Revision$ $Date$\r
21  */\r
22 public class Tree implements java.io.Serializable {\r
23 \r
24 \r
25       //--------------------------/\r
26      //- Class/Member Variables -/\r
27     //--------------------------/\r
28 \r
29     /**\r
30      * Field _width.\r
31      */\r
32     private int _width;\r
33 \r
34     /**\r
35      * keeps track of state for field: _width\r
36      */\r
37     private boolean _has_width;\r
38 \r
39     /**\r
40      * Field _height.\r
41      */\r
42     private int _height;\r
43 \r
44     /**\r
45      * keeps track of state for field: _height\r
46      */\r
47     private boolean _has_height;\r
48 \r
49     /**\r
50      * Field _xpos.\r
51      */\r
52     private int _xpos;\r
53 \r
54     /**\r
55      * keeps track of state for field: _xpos\r
56      */\r
57     private boolean _has_xpos;\r
58 \r
59     /**\r
60      * Field _ypos.\r
61      */\r
62     private int _ypos;\r
63 \r
64     /**\r
65      * keeps track of state for field: _ypos\r
66      */\r
67     private boolean _has_ypos;\r
68 \r
69     /**\r
70      * Field _fontName.\r
71      */\r
72     private java.lang.String _fontName;\r
73 \r
74     /**\r
75      * Field _fontSize.\r
76      */\r
77     private int _fontSize;\r
78 \r
79     /**\r
80      * keeps track of state for field: _fontSize\r
81      */\r
82     private boolean _has_fontSize;\r
83 \r
84     /**\r
85      * Field _fontStyle.\r
86      */\r
87     private int _fontStyle;\r
88 \r
89     /**\r
90      * keeps track of state for field: _fontStyle\r
91      */\r
92     private boolean _has_fontStyle;\r
93 \r
94     /**\r
95      * Field _threshold.\r
96      */\r
97     private float _threshold;\r
98 \r
99     /**\r
100      * keeps track of state for field: _threshold\r
101      */\r
102     private boolean _has_threshold;\r
103 \r
104     /**\r
105      * Field _showBootstrap.\r
106      */\r
107     private boolean _showBootstrap;\r
108 \r
109     /**\r
110      * keeps track of state for field: _showBootstrap\r
111      */\r
112     private boolean _has_showBootstrap;\r
113 \r
114     /**\r
115      * Field _showDistances.\r
116      */\r
117     private boolean _showDistances;\r
118 \r
119     /**\r
120      * keeps track of state for field: _showDistances\r
121      */\r
122     private boolean _has_showDistances;\r
123 \r
124     /**\r
125      * Field _markUnlinked.\r
126      */\r
127     private boolean _markUnlinked;\r
128 \r
129     /**\r
130      * keeps track of state for field: _markUnlinked\r
131      */\r
132     private boolean _has_markUnlinked;\r
133 \r
134     /**\r
135      * Field _fitToWindow.\r
136      */\r
137     private boolean _fitToWindow;\r
138 \r
139     /**\r
140      * keeps track of state for field: _fitToWindow\r
141      */\r
142     private boolean _has_fitToWindow;\r
143 \r
144     /**\r
145      * Field _currentTree.\r
146      */\r
147     private boolean _currentTree;\r
148 \r
149     /**\r
150      * keeps track of state for field: _currentTree\r
151      */\r
152     private boolean _has_currentTree;\r
153 \r
154     /**\r
155      * Tree ID added for binding tree visualization settings to\r
156      * vamsas document trees in jalview 2.4.1\r
157      */\r
158     private java.lang.String _id;\r
159 \r
160     /**\r
161      * Field _title.\r
162      */\r
163     private java.lang.String _title;\r
164 \r
165     /**\r
166      * Field _newick.\r
167      */\r
168     private java.lang.String _newick;\r
169 \r
170 \r
171       //----------------/\r
172      //- Constructors -/\r
173     //----------------/\r
174 \r
175     public Tree() {\r
176         super();\r
177     }\r
178 \r
179 \r
180       //-----------/\r
181      //- Methods -/\r
182     //-----------/\r
183 \r
184     /**\r
185      */\r
186     public void deleteCurrentTree(\r
187     ) {\r
188         this._has_currentTree= false;\r
189     }\r
190 \r
191     /**\r
192      */\r
193     public void deleteFitToWindow(\r
194     ) {\r
195         this._has_fitToWindow= false;\r
196     }\r
197 \r
198     /**\r
199      */\r
200     public void deleteFontSize(\r
201     ) {\r
202         this._has_fontSize= false;\r
203     }\r
204 \r
205     /**\r
206      */\r
207     public void deleteFontStyle(\r
208     ) {\r
209         this._has_fontStyle= false;\r
210     }\r
211 \r
212     /**\r
213      */\r
214     public void deleteHeight(\r
215     ) {\r
216         this._has_height= false;\r
217     }\r
218 \r
219     /**\r
220      */\r
221     public void deleteMarkUnlinked(\r
222     ) {\r
223         this._has_markUnlinked= false;\r
224     }\r
225 \r
226     /**\r
227      */\r
228     public void deleteShowBootstrap(\r
229     ) {\r
230         this._has_showBootstrap= false;\r
231     }\r
232 \r
233     /**\r
234      */\r
235     public void deleteShowDistances(\r
236     ) {\r
237         this._has_showDistances= false;\r
238     }\r
239 \r
240     /**\r
241      */\r
242     public void deleteThreshold(\r
243     ) {\r
244         this._has_threshold= false;\r
245     }\r
246 \r
247     /**\r
248      */\r
249     public void deleteWidth(\r
250     ) {\r
251         this._has_width= false;\r
252     }\r
253 \r
254     /**\r
255      */\r
256     public void deleteXpos(\r
257     ) {\r
258         this._has_xpos= false;\r
259     }\r
260 \r
261     /**\r
262      */\r
263     public void deleteYpos(\r
264     ) {\r
265         this._has_ypos= false;\r
266     }\r
267 \r
268     /**\r
269      * Returns the value of field 'currentTree'.\r
270      * \r
271      * @return the value of field 'CurrentTree'.\r
272      */\r
273     public boolean getCurrentTree(\r
274     ) {\r
275         return this._currentTree;\r
276     }\r
277 \r
278     /**\r
279      * Returns the value of field 'fitToWindow'.\r
280      * \r
281      * @return the value of field 'FitToWindow'.\r
282      */\r
283     public boolean getFitToWindow(\r
284     ) {\r
285         return this._fitToWindow;\r
286     }\r
287 \r
288     /**\r
289      * Returns the value of field 'fontName'.\r
290      * \r
291      * @return the value of field 'FontName'.\r
292      */\r
293     public java.lang.String getFontName(\r
294     ) {\r
295         return this._fontName;\r
296     }\r
297 \r
298     /**\r
299      * Returns the value of field 'fontSize'.\r
300      * \r
301      * @return the value of field 'FontSize'.\r
302      */\r
303     public int getFontSize(\r
304     ) {\r
305         return this._fontSize;\r
306     }\r
307 \r
308     /**\r
309      * Returns the value of field 'fontStyle'.\r
310      * \r
311      * @return the value of field 'FontStyle'.\r
312      */\r
313     public int getFontStyle(\r
314     ) {\r
315         return this._fontStyle;\r
316     }\r
317 \r
318     /**\r
319      * Returns the value of field 'height'.\r
320      * \r
321      * @return the value of field 'Height'.\r
322      */\r
323     public int getHeight(\r
324     ) {\r
325         return this._height;\r
326     }\r
327 \r
328     /**\r
329      * Returns the value of field 'id'. The field 'id' has the\r
330      * following description: Tree ID added for binding tree\r
331      * visualization settings to vamsas document trees in jalview\r
332      * 2.4.1\r
333      * \r
334      * @return the value of field 'Id'.\r
335      */\r
336     public java.lang.String getId(\r
337     ) {\r
338         return this._id;\r
339     }\r
340 \r
341     /**\r
342      * Returns the value of field 'markUnlinked'.\r
343      * \r
344      * @return the value of field 'MarkUnlinked'.\r
345      */\r
346     public boolean getMarkUnlinked(\r
347     ) {\r
348         return this._markUnlinked;\r
349     }\r
350 \r
351     /**\r
352      * Returns the value of field 'newick'.\r
353      * \r
354      * @return the value of field 'Newick'.\r
355      */\r
356     public java.lang.String getNewick(\r
357     ) {\r
358         return this._newick;\r
359     }\r
360 \r
361     /**\r
362      * Returns the value of field 'showBootstrap'.\r
363      * \r
364      * @return the value of field 'ShowBootstrap'.\r
365      */\r
366     public boolean getShowBootstrap(\r
367     ) {\r
368         return this._showBootstrap;\r
369     }\r
370 \r
371     /**\r
372      * Returns the value of field 'showDistances'.\r
373      * \r
374      * @return the value of field 'ShowDistances'.\r
375      */\r
376     public boolean getShowDistances(\r
377     ) {\r
378         return this._showDistances;\r
379     }\r
380 \r
381     /**\r
382      * Returns the value of field 'threshold'.\r
383      * \r
384      * @return the value of field 'Threshold'.\r
385      */\r
386     public float getThreshold(\r
387     ) {\r
388         return this._threshold;\r
389     }\r
390 \r
391     /**\r
392      * Returns the value of field 'title'.\r
393      * \r
394      * @return the value of field 'Title'.\r
395      */\r
396     public java.lang.String getTitle(\r
397     ) {\r
398         return this._title;\r
399     }\r
400 \r
401     /**\r
402      * Returns the value of field 'width'.\r
403      * \r
404      * @return the value of field 'Width'.\r
405      */\r
406     public int getWidth(\r
407     ) {\r
408         return this._width;\r
409     }\r
410 \r
411     /**\r
412      * Returns the value of field 'xpos'.\r
413      * \r
414      * @return the value of field 'Xpos'.\r
415      */\r
416     public int getXpos(\r
417     ) {\r
418         return this._xpos;\r
419     }\r
420 \r
421     /**\r
422      * Returns the value of field 'ypos'.\r
423      * \r
424      * @return the value of field 'Ypos'.\r
425      */\r
426     public int getYpos(\r
427     ) {\r
428         return this._ypos;\r
429     }\r
430 \r
431     /**\r
432      * Method hasCurrentTree.\r
433      * \r
434      * @return true if at least one CurrentTree has been added\r
435      */\r
436     public boolean hasCurrentTree(\r
437     ) {\r
438         return this._has_currentTree;\r
439     }\r
440 \r
441     /**\r
442      * Method hasFitToWindow.\r
443      * \r
444      * @return true if at least one FitToWindow has been added\r
445      */\r
446     public boolean hasFitToWindow(\r
447     ) {\r
448         return this._has_fitToWindow;\r
449     }\r
450 \r
451     /**\r
452      * Method hasFontSize.\r
453      * \r
454      * @return true if at least one FontSize has been added\r
455      */\r
456     public boolean hasFontSize(\r
457     ) {\r
458         return this._has_fontSize;\r
459     }\r
460 \r
461     /**\r
462      * Method hasFontStyle.\r
463      * \r
464      * @return true if at least one FontStyle has been added\r
465      */\r
466     public boolean hasFontStyle(\r
467     ) {\r
468         return this._has_fontStyle;\r
469     }\r
470 \r
471     /**\r
472      * Method hasHeight.\r
473      * \r
474      * @return true if at least one Height has been added\r
475      */\r
476     public boolean hasHeight(\r
477     ) {\r
478         return this._has_height;\r
479     }\r
480 \r
481     /**\r
482      * Method hasMarkUnlinked.\r
483      * \r
484      * @return true if at least one MarkUnlinked has been added\r
485      */\r
486     public boolean hasMarkUnlinked(\r
487     ) {\r
488         return this._has_markUnlinked;\r
489     }\r
490 \r
491     /**\r
492      * Method hasShowBootstrap.\r
493      * \r
494      * @return true if at least one ShowBootstrap has been added\r
495      */\r
496     public boolean hasShowBootstrap(\r
497     ) {\r
498         return this._has_showBootstrap;\r
499     }\r
500 \r
501     /**\r
502      * Method hasShowDistances.\r
503      * \r
504      * @return true if at least one ShowDistances has been added\r
505      */\r
506     public boolean hasShowDistances(\r
507     ) {\r
508         return this._has_showDistances;\r
509     }\r
510 \r
511     /**\r
512      * Method hasThreshold.\r
513      * \r
514      * @return true if at least one Threshold has been added\r
515      */\r
516     public boolean hasThreshold(\r
517     ) {\r
518         return this._has_threshold;\r
519     }\r
520 \r
521     /**\r
522      * Method hasWidth.\r
523      * \r
524      * @return true if at least one Width has been added\r
525      */\r
526     public boolean hasWidth(\r
527     ) {\r
528         return this._has_width;\r
529     }\r
530 \r
531     /**\r
532      * Method hasXpos.\r
533      * \r
534      * @return true if at least one Xpos has been added\r
535      */\r
536     public boolean hasXpos(\r
537     ) {\r
538         return this._has_xpos;\r
539     }\r
540 \r
541     /**\r
542      * Method hasYpos.\r
543      * \r
544      * @return true if at least one Ypos has been added\r
545      */\r
546     public boolean hasYpos(\r
547     ) {\r
548         return this._has_ypos;\r
549     }\r
550 \r
551     /**\r
552      * Returns the value of field 'currentTree'.\r
553      * \r
554      * @return the value of field 'CurrentTree'.\r
555      */\r
556     public boolean isCurrentTree(\r
557     ) {\r
558         return this._currentTree;\r
559     }\r
560 \r
561     /**\r
562      * Returns the value of field 'fitToWindow'.\r
563      * \r
564      * @return the value of field 'FitToWindow'.\r
565      */\r
566     public boolean isFitToWindow(\r
567     ) {\r
568         return this._fitToWindow;\r
569     }\r
570 \r
571     /**\r
572      * Returns the value of field 'markUnlinked'.\r
573      * \r
574      * @return the value of field 'MarkUnlinked'.\r
575      */\r
576     public boolean isMarkUnlinked(\r
577     ) {\r
578         return this._markUnlinked;\r
579     }\r
580 \r
581     /**\r
582      * Returns the value of field 'showBootstrap'.\r
583      * \r
584      * @return the value of field 'ShowBootstrap'.\r
585      */\r
586     public boolean isShowBootstrap(\r
587     ) {\r
588         return this._showBootstrap;\r
589     }\r
590 \r
591     /**\r
592      * Returns the value of field 'showDistances'.\r
593      * \r
594      * @return the value of field 'ShowDistances'.\r
595      */\r
596     public boolean isShowDistances(\r
597     ) {\r
598         return this._showDistances;\r
599     }\r
600 \r
601     /**\r
602      * Method isValid.\r
603      * \r
604      * @return true if this object is valid according to the schema\r
605      */\r
606     public boolean isValid(\r
607     ) {\r
608         try {\r
609             validate();\r
610         } catch (org.exolab.castor.xml.ValidationException vex) {\r
611             return false;\r
612         }\r
613         return true;\r
614     }\r
615 \r
616     /**\r
617      * \r
618      * \r
619      * @param out\r
620      * @throws org.exolab.castor.xml.MarshalException if object is\r
621      * null or if any SAXException is thrown during marshaling\r
622      * @throws org.exolab.castor.xml.ValidationException if this\r
623      * object is an invalid instance according to the schema\r
624      */\r
625     public void marshal(\r
626             final java.io.Writer out)\r
627     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
628         Marshaller.marshal(this, out);\r
629     }\r
630 \r
631     /**\r
632      * \r
633      * \r
634      * @param handler\r
635      * @throws java.io.IOException if an IOException occurs during\r
636      * marshaling\r
637      * @throws org.exolab.castor.xml.ValidationException if this\r
638      * object is an invalid instance according to the schema\r
639      * @throws org.exolab.castor.xml.MarshalException if object is\r
640      * null or if any SAXException is thrown during marshaling\r
641      */\r
642     public void marshal(\r
643             final org.xml.sax.ContentHandler handler)\r
644     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
645         Marshaller.marshal(this, handler);\r
646     }\r
647 \r
648     /**\r
649      * Sets the value of field 'currentTree'.\r
650      * \r
651      * @param currentTree the value of field 'currentTree'.\r
652      */\r
653     public void setCurrentTree(\r
654             final boolean currentTree) {\r
655         this._currentTree = currentTree;\r
656         this._has_currentTree = true;\r
657     }\r
658 \r
659     /**\r
660      * Sets the value of field 'fitToWindow'.\r
661      * \r
662      * @param fitToWindow the value of field 'fitToWindow'.\r
663      */\r
664     public void setFitToWindow(\r
665             final boolean fitToWindow) {\r
666         this._fitToWindow = fitToWindow;\r
667         this._has_fitToWindow = true;\r
668     }\r
669 \r
670     /**\r
671      * Sets the value of field 'fontName'.\r
672      * \r
673      * @param fontName the value of field 'fontName'.\r
674      */\r
675     public void setFontName(\r
676             final java.lang.String fontName) {\r
677         this._fontName = fontName;\r
678     }\r
679 \r
680     /**\r
681      * Sets the value of field 'fontSize'.\r
682      * \r
683      * @param fontSize the value of field 'fontSize'.\r
684      */\r
685     public void setFontSize(\r
686             final int fontSize) {\r
687         this._fontSize = fontSize;\r
688         this._has_fontSize = true;\r
689     }\r
690 \r
691     /**\r
692      * Sets the value of field 'fontStyle'.\r
693      * \r
694      * @param fontStyle the value of field 'fontStyle'.\r
695      */\r
696     public void setFontStyle(\r
697             final int fontStyle) {\r
698         this._fontStyle = fontStyle;\r
699         this._has_fontStyle = true;\r
700     }\r
701 \r
702     /**\r
703      * Sets the value of field 'height'.\r
704      * \r
705      * @param height the value of field 'height'.\r
706      */\r
707     public void setHeight(\r
708             final int height) {\r
709         this._height = height;\r
710         this._has_height = true;\r
711     }\r
712 \r
713     /**\r
714      * Sets the value of field 'id'. The field 'id' has the\r
715      * following description: Tree ID added for binding tree\r
716      * visualization settings to vamsas document trees in jalview\r
717      * 2.4.1\r
718      * \r
719      * @param id the value of field 'id'.\r
720      */\r
721     public void setId(\r
722             final java.lang.String id) {\r
723         this._id = id;\r
724     }\r
725 \r
726     /**\r
727      * Sets the value of field 'markUnlinked'.\r
728      * \r
729      * @param markUnlinked the value of field 'markUnlinked'.\r
730      */\r
731     public void setMarkUnlinked(\r
732             final boolean markUnlinked) {\r
733         this._markUnlinked = markUnlinked;\r
734         this._has_markUnlinked = true;\r
735     }\r
736 \r
737     /**\r
738      * Sets the value of field 'newick'.\r
739      * \r
740      * @param newick the value of field 'newick'.\r
741      */\r
742     public void setNewick(\r
743             final java.lang.String newick) {\r
744         this._newick = newick;\r
745     }\r
746 \r
747     /**\r
748      * Sets the value of field 'showBootstrap'.\r
749      * \r
750      * @param showBootstrap the value of field 'showBootstrap'.\r
751      */\r
752     public void setShowBootstrap(\r
753             final boolean showBootstrap) {\r
754         this._showBootstrap = showBootstrap;\r
755         this._has_showBootstrap = true;\r
756     }\r
757 \r
758     /**\r
759      * Sets the value of field 'showDistances'.\r
760      * \r
761      * @param showDistances the value of field 'showDistances'.\r
762      */\r
763     public void setShowDistances(\r
764             final boolean showDistances) {\r
765         this._showDistances = showDistances;\r
766         this._has_showDistances = true;\r
767     }\r
768 \r
769     /**\r
770      * Sets the value of field 'threshold'.\r
771      * \r
772      * @param threshold the value of field 'threshold'.\r
773      */\r
774     public void setThreshold(\r
775             final float threshold) {\r
776         this._threshold = threshold;\r
777         this._has_threshold = true;\r
778     }\r
779 \r
780     /**\r
781      * Sets the value of field 'title'.\r
782      * \r
783      * @param title the value of field 'title'.\r
784      */\r
785     public void setTitle(\r
786             final java.lang.String title) {\r
787         this._title = title;\r
788     }\r
789 \r
790     /**\r
791      * Sets the value of field 'width'.\r
792      * \r
793      * @param width the value of field 'width'.\r
794      */\r
795     public void setWidth(\r
796             final int width) {\r
797         this._width = width;\r
798         this._has_width = true;\r
799     }\r
800 \r
801     /**\r
802      * Sets the value of field 'xpos'.\r
803      * \r
804      * @param xpos the value of field 'xpos'.\r
805      */\r
806     public void setXpos(\r
807             final int xpos) {\r
808         this._xpos = xpos;\r
809         this._has_xpos = true;\r
810     }\r
811 \r
812     /**\r
813      * Sets the value of field 'ypos'.\r
814      * \r
815      * @param ypos the value of field 'ypos'.\r
816      */\r
817     public void setYpos(\r
818             final int ypos) {\r
819         this._ypos = ypos;\r
820         this._has_ypos = true;\r
821     }\r
822 \r
823     /**\r
824      * Method unmarshal.\r
825      * \r
826      * @param reader\r
827      * @throws org.exolab.castor.xml.MarshalException if object is\r
828      * null or if any SAXException is thrown during marshaling\r
829      * @throws org.exolab.castor.xml.ValidationException if this\r
830      * object is an invalid instance according to the schema\r
831      * @return the unmarshaled jalview.schemabinding.version2.Tree\r
832      */\r
833     public static jalview.schemabinding.version2.Tree unmarshal(\r
834             final java.io.Reader reader)\r
835     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
836         return (jalview.schemabinding.version2.Tree) Unmarshaller.unmarshal(jalview.schemabinding.version2.Tree.class, reader);\r
837     }\r
838 \r
839     /**\r
840      * \r
841      * \r
842      * @throws org.exolab.castor.xml.ValidationException if this\r
843      * object is an invalid instance according to the schema\r
844      */\r
845     public void validate(\r
846     )\r
847     throws org.exolab.castor.xml.ValidationException {\r
848         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
849         validator.validate(this);\r
850     }\r
851 \r
852 }\r