Merge branch 'develop' into features/JAL-1759jmolUpdate
[jalview.git] / src / jalview / schemabinding / version2 / StructureState.java
1 /*
2  * This class was automatically generated with 
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
4  * Schema.
5  * $Id$
6  */
7
8 package jalview.schemabinding.version2;
9
10   //---------------------------------/
11  //- Imported classes and packages -/
12 //---------------------------------/
13
14 import org.exolab.castor.xml.Marshaller;
15 import org.exolab.castor.xml.Unmarshaller;
16
17 /**
18  * Class StructureState.
19  * 
20  * @version $Revision$ $Date$
21  */
22 public class StructureState implements java.io.Serializable {
23
24
25       //--------------------------/
26      //- Class/Member Variables -/
27     //--------------------------/
28
29     /**
30      * internal content storage
31      */
32     private java.lang.String _content = "";
33
34     /**
35      * Field _visible.
36      */
37     private boolean _visible;
38
39     /**
40      * keeps track of state for field: _visible
41      */
42     private boolean _has_visible;
43
44     /**
45      * additional
46      *  identifier
47      *  which
48      *  properly
49      *  disambiguates
50      *  the
51      *  structure
52      *  view
53      *  from
54      *  any
55      *  other
56      *  view
57      *  with
58      *  the
59      *  same
60      *  attributes.
61      *  This
62      *  is
63      *  not
64      *  an
65      *  ID,
66      *  because
67      *  it
68      *  is
69      *  possible
70      *  to
71      *  have
72      *  many
73      *  references
74      *  to
75      *  the
76      *  same
77      *  physical
78      *  structure
79      *  view
80      *  from
81      *  different
82      *  sequences
83      *  in
84      *  an
85      *  alignment.
86      *  A
87      *  structureState
88      *  element
89      *  citing
90      *  the
91      *  same
92      *  viewId
93      *  will
94      *  appear
95      *  for
96      *  each
97      *  instance.
98      *  
99      */
100     private java.lang.String _viewId;
101
102     /**
103      * Flag
104      *  set
105      *  if
106      *  the
107      *  alignment
108      *  panel
109      *  containing
110      *  this
111      *  JSeq
112      *  should
113      *  be
114      *  included
115      *  in
116      *  those
117      *  used
118      *  to
119      *  perform
120      *  a
121      *  structure
122      *  superposition
123      *  (since
124      *  Jalview
125      *  2.7).
126      *  
127      */
128     private boolean _alignwithAlignPanel = true;
129
130     /**
131      * keeps track of state for field: _alignwithAlignPanel
132      */
133     private boolean _has_alignwithAlignPanel;
134
135     /**
136      * Flag
137      *  set
138      *  if
139      *  the
140      *  alignment
141      *  panel
142      *  containing
143      *  this
144      *  JSeq
145      *  should
146      *  be
147      *  included
148      *  in
149      *  those
150      *  used
151      *  to
152      *  colour
153      *  its
154      *  associated
155      *  sequences
156      *  in
157      *  this
158      *  structureState(since
159      *  Jalview
160      *  2.7).
161      *  
162      */
163     private boolean _colourwithAlignPanel = false;
164
165     /**
166      * keeps track of state for field: _colourwithAlignPanel
167      */
168     private boolean _has_colourwithAlignPanel;
169
170     /**
171      * Flag
172      *  set
173      *  if
174      *  the
175      *  structure
176      *  display
177      *  is
178      *  coloured
179      *  by
180      *  the
181      *  Jmol
182      *  state,
183      *  rather
184      *  than
185      *  by
186      *  one
187      *  or
188      *  more
189      *  linked
190      *  alignment
191      *  views.
192      *  
193      */
194     private boolean _colourByJmol = true;
195
196     /**
197      * keeps track of state for field: _colourByJmol
198      */
199     private boolean _has_colourByJmol;
200
201     /**
202      * An
203      *  identifier
204      *  for
205      *  the
206      *  viewer
207      *  type,
208      *  currently
209      *  either
210      *  JMOL
211      *  or
212      *  CHIMERA
213      *  
214      */
215     private java.lang.String _type;
216
217     /**
218      * Field _width.
219      */
220     private int _width;
221
222     /**
223      * keeps track of state for field: _width
224      */
225     private boolean _has_width;
226
227     /**
228      * Field _height.
229      */
230     private int _height;
231
232     /**
233      * keeps track of state for field: _height
234      */
235     private boolean _has_height;
236
237     /**
238      * Field _xpos.
239      */
240     private int _xpos;
241
242     /**
243      * keeps track of state for field: _xpos
244      */
245     private boolean _has_xpos;
246
247     /**
248      * Field _ypos.
249      */
250     private int _ypos;
251
252     /**
253      * keeps track of state for field: _ypos
254      */
255     private boolean _has_ypos;
256
257
258       //----------------/
259      //- Constructors -/
260     //----------------/
261
262     public StructureState() {
263         super();
264         setContent("");
265     }
266
267
268       //-----------/
269      //- Methods -/
270     //-----------/
271
272     /**
273      */
274     public void deleteAlignwithAlignPanel(
275     ) {
276         this._has_alignwithAlignPanel= false;
277     }
278
279     /**
280      */
281     public void deleteColourByJmol(
282     ) {
283         this._has_colourByJmol= false;
284     }
285
286     /**
287      */
288     public void deleteColourwithAlignPanel(
289     ) {
290         this._has_colourwithAlignPanel= false;
291     }
292
293     /**
294      */
295     public void deleteHeight(
296     ) {
297         this._has_height= false;
298     }
299
300     /**
301      */
302     public void deleteVisible(
303     ) {
304         this._has_visible= false;
305     }
306
307     /**
308      */
309     public void deleteWidth(
310     ) {
311         this._has_width= false;
312     }
313
314     /**
315      */
316     public void deleteXpos(
317     ) {
318         this._has_xpos= false;
319     }
320
321     /**
322      */
323     public void deleteYpos(
324     ) {
325         this._has_ypos= false;
326     }
327
328     /**
329      * Returns the value of field 'alignwithAlignPanel'. The field
330      * 'alignwithAlignPanel' has the following description: Flag
331      *  set
332      *  if
333      *  the
334      *  alignment
335      *  panel
336      *  containing
337      *  this
338      *  JSeq
339      *  should
340      *  be
341      *  included
342      *  in
343      *  those
344      *  used
345      *  to
346      *  perform
347      *  a
348      *  structure
349      *  superposition
350      *  (since
351      *  Jalview
352      *  2.7).
353      *  
354      * 
355      * @return the value of field 'AlignwithAlignPanel'.
356      */
357     public boolean getAlignwithAlignPanel(
358     ) {
359         return this._alignwithAlignPanel;
360     }
361
362     /**
363      * Returns the value of field 'colourByJmol'. The field
364      * 'colourByJmol' has the following description: Flag
365      *  set
366      *  if
367      *  the
368      *  structure
369      *  display
370      *  is
371      *  coloured
372      *  by
373      *  the
374      *  Jmol
375      *  state,
376      *  rather
377      *  than
378      *  by
379      *  one
380      *  or
381      *  more
382      *  linked
383      *  alignment
384      *  views.
385      *  
386      * 
387      * @return the value of field 'ColourByJmol'.
388      */
389     public boolean getColourByJmol(
390     ) {
391         return this._colourByJmol;
392     }
393
394     /**
395      * Returns the value of field 'colourwithAlignPanel'. The field
396      * 'colourwithAlignPanel' has the following description: Flag
397      *  set
398      *  if
399      *  the
400      *  alignment
401      *  panel
402      *  containing
403      *  this
404      *  JSeq
405      *  should
406      *  be
407      *  included
408      *  in
409      *  those
410      *  used
411      *  to
412      *  colour
413      *  its
414      *  associated
415      *  sequences
416      *  in
417      *  this
418      *  structureState(since
419      *  Jalview
420      *  2.7).
421      *  
422      * 
423      * @return the value of field 'ColourwithAlignPanel'.
424      */
425     public boolean getColourwithAlignPanel(
426     ) {
427         return this._colourwithAlignPanel;
428     }
429
430     /**
431      * Returns the value of field 'content'. The field 'content'
432      * has the following description: internal content storage
433      * 
434      * @return the value of field 'Content'.
435      */
436     public java.lang.String getContent(
437     ) {
438         return this._content;
439     }
440
441     /**
442      * Returns the value of field 'height'.
443      * 
444      * @return the value of field 'Height'.
445      */
446     public int getHeight(
447     ) {
448         return this._height;
449     }
450
451     /**
452      * Returns the value of field 'type'. The field 'type' has the
453      * following description: An
454      *  identifier
455      *  for
456      *  the
457      *  viewer
458      *  type,
459      *  currently
460      *  either
461      *  JMOL
462      *  or
463      *  CHIMERA
464      *  
465      * 
466      * @return the value of field 'Type'.
467      */
468     public java.lang.String getType(
469     ) {
470         return this._type;
471     }
472
473     /**
474      * Returns the value of field 'viewId'. The field 'viewId' has
475      * the following description: additional
476      *  identifier
477      *  which
478      *  properly
479      *  disambiguates
480      *  the
481      *  structure
482      *  view
483      *  from
484      *  any
485      *  other
486      *  view
487      *  with
488      *  the
489      *  same
490      *  attributes.
491      *  This
492      *  is
493      *  not
494      *  an
495      *  ID,
496      *  because
497      *  it
498      *  is
499      *  possible
500      *  to
501      *  have
502      *  many
503      *  references
504      *  to
505      *  the
506      *  same
507      *  physical
508      *  structure
509      *  view
510      *  from
511      *  different
512      *  sequences
513      *  in
514      *  an
515      *  alignment.
516      *  A
517      *  structureState
518      *  element
519      *  citing
520      *  the
521      *  same
522      *  viewId
523      *  will
524      *  appear
525      *  for
526      *  each
527      *  instance.
528      *  
529      * 
530      * @return the value of field 'ViewId'.
531      */
532     public java.lang.String getViewId(
533     ) {
534         return this._viewId;
535     }
536
537     /**
538      * Returns the value of field 'visible'.
539      * 
540      * @return the value of field 'Visible'.
541      */
542     public boolean getVisible(
543     ) {
544         return this._visible;
545     }
546
547     /**
548      * Returns the value of field 'width'.
549      * 
550      * @return the value of field 'Width'.
551      */
552     public int getWidth(
553     ) {
554         return this._width;
555     }
556
557     /**
558      * Returns the value of field 'xpos'.
559      * 
560      * @return the value of field 'Xpos'.
561      */
562     public int getXpos(
563     ) {
564         return this._xpos;
565     }
566
567     /**
568      * Returns the value of field 'ypos'.
569      * 
570      * @return the value of field 'Ypos'.
571      */
572     public int getYpos(
573     ) {
574         return this._ypos;
575     }
576
577     /**
578      * Method hasAlignwithAlignPanel.
579      * 
580      * @return true if at least one AlignwithAlignPanel has been
581      * added
582      */
583     public boolean hasAlignwithAlignPanel(
584     ) {
585         return this._has_alignwithAlignPanel;
586     }
587
588     /**
589      * Method hasColourByJmol.
590      * 
591      * @return true if at least one ColourByJmol has been added
592      */
593     public boolean hasColourByJmol(
594     ) {
595         return this._has_colourByJmol;
596     }
597
598     /**
599      * Method hasColourwithAlignPanel.
600      * 
601      * @return true if at least one ColourwithAlignPanel has been
602      * added
603      */
604     public boolean hasColourwithAlignPanel(
605     ) {
606         return this._has_colourwithAlignPanel;
607     }
608
609     /**
610      * Method hasHeight.
611      * 
612      * @return true if at least one Height has been added
613      */
614     public boolean hasHeight(
615     ) {
616         return this._has_height;
617     }
618
619     /**
620      * Method hasVisible.
621      * 
622      * @return true if at least one Visible has been added
623      */
624     public boolean hasVisible(
625     ) {
626         return this._has_visible;
627     }
628
629     /**
630      * Method hasWidth.
631      * 
632      * @return true if at least one Width has been added
633      */
634     public boolean hasWidth(
635     ) {
636         return this._has_width;
637     }
638
639     /**
640      * Method hasXpos.
641      * 
642      * @return true if at least one Xpos has been added
643      */
644     public boolean hasXpos(
645     ) {
646         return this._has_xpos;
647     }
648
649     /**
650      * Method hasYpos.
651      * 
652      * @return true if at least one Ypos has been added
653      */
654     public boolean hasYpos(
655     ) {
656         return this._has_ypos;
657     }
658
659     /**
660      * Returns the value of field 'alignwithAlignPanel'. The field
661      * 'alignwithAlignPanel' has the following description: Flag
662      *  set
663      *  if
664      *  the
665      *  alignment
666      *  panel
667      *  containing
668      *  this
669      *  JSeq
670      *  should
671      *  be
672      *  included
673      *  in
674      *  those
675      *  used
676      *  to
677      *  perform
678      *  a
679      *  structure
680      *  superposition
681      *  (since
682      *  Jalview
683      *  2.7).
684      *  
685      * 
686      * @return the value of field 'AlignwithAlignPanel'.
687      */
688     public boolean isAlignwithAlignPanel(
689     ) {
690         return this._alignwithAlignPanel;
691     }
692
693     /**
694      * Returns the value of field 'colourByJmol'. The field
695      * 'colourByJmol' has the following description: Flag
696      *  set
697      *  if
698      *  the
699      *  structure
700      *  display
701      *  is
702      *  coloured
703      *  by
704      *  the
705      *  Jmol
706      *  state,
707      *  rather
708      *  than
709      *  by
710      *  one
711      *  or
712      *  more
713      *  linked
714      *  alignment
715      *  views.
716      *  
717      * 
718      * @return the value of field 'ColourByJmol'.
719      */
720     public boolean isColourByJmol(
721     ) {
722         return this._colourByJmol;
723     }
724
725     /**
726      * Returns the value of field 'colourwithAlignPanel'. The field
727      * 'colourwithAlignPanel' has the following description: Flag
728      *  set
729      *  if
730      *  the
731      *  alignment
732      *  panel
733      *  containing
734      *  this
735      *  JSeq
736      *  should
737      *  be
738      *  included
739      *  in
740      *  those
741      *  used
742      *  to
743      *  colour
744      *  its
745      *  associated
746      *  sequences
747      *  in
748      *  this
749      *  structureState(since
750      *  Jalview
751      *  2.7).
752      *  
753      * 
754      * @return the value of field 'ColourwithAlignPanel'.
755      */
756     public boolean isColourwithAlignPanel(
757     ) {
758         return this._colourwithAlignPanel;
759     }
760
761     /**
762      * Method isValid.
763      * 
764      * @return true if this object is valid according to the schema
765      */
766     public boolean isValid(
767     ) {
768         try {
769             validate();
770         } catch (org.exolab.castor.xml.ValidationException vex) {
771             return false;
772         }
773         return true;
774     }
775
776     /**
777      * Returns the value of field 'visible'.
778      * 
779      * @return the value of field 'Visible'.
780      */
781     public boolean isVisible(
782     ) {
783         return this._visible;
784     }
785
786     /**
787      * 
788      * 
789      * @param out
790      * @throws org.exolab.castor.xml.MarshalException if object is
791      * null or if any SAXException is thrown during marshaling
792      * @throws org.exolab.castor.xml.ValidationException if this
793      * object is an invalid instance according to the schema
794      */
795     public void marshal(
796             final java.io.Writer out)
797     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
798         Marshaller.marshal(this, out);
799     }
800
801     /**
802      * 
803      * 
804      * @param handler
805      * @throws java.io.IOException if an IOException occurs during
806      * marshaling
807      * @throws org.exolab.castor.xml.ValidationException if this
808      * object is an invalid instance according to the schema
809      * @throws org.exolab.castor.xml.MarshalException if object is
810      * null or if any SAXException is thrown during marshaling
811      */
812     public void marshal(
813             final org.xml.sax.ContentHandler handler)
814     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
815         Marshaller.marshal(this, handler);
816     }
817
818     /**
819      * Sets the value of field 'alignwithAlignPanel'. The field
820      * 'alignwithAlignPanel' has the following description: Flag
821      *  set
822      *  if
823      *  the
824      *  alignment
825      *  panel
826      *  containing
827      *  this
828      *  JSeq
829      *  should
830      *  be
831      *  included
832      *  in
833      *  those
834      *  used
835      *  to
836      *  perform
837      *  a
838      *  structure
839      *  superposition
840      *  (since
841      *  Jalview
842      *  2.7).
843      *  
844      * 
845      * @param alignwithAlignPanel the value of field
846      * 'alignwithAlignPanel'.
847      */
848     public void setAlignwithAlignPanel(
849             final boolean alignwithAlignPanel) {
850         this._alignwithAlignPanel = alignwithAlignPanel;
851         this._has_alignwithAlignPanel = true;
852     }
853
854     /**
855      * Sets the value of field 'colourByJmol'. The field
856      * 'colourByJmol' has the following description: Flag
857      *  set
858      *  if
859      *  the
860      *  structure
861      *  display
862      *  is
863      *  coloured
864      *  by
865      *  the
866      *  Jmol
867      *  state,
868      *  rather
869      *  than
870      *  by
871      *  one
872      *  or
873      *  more
874      *  linked
875      *  alignment
876      *  views.
877      *  
878      * 
879      * @param colourByJmol the value of field 'colourByJmol'.
880      */
881     public void setColourByJmol(
882             final boolean colourByJmol) {
883         this._colourByJmol = colourByJmol;
884         this._has_colourByJmol = true;
885     }
886
887     /**
888      * Sets the value of field 'colourwithAlignPanel'. The field
889      * 'colourwithAlignPanel' has the following description: Flag
890      *  set
891      *  if
892      *  the
893      *  alignment
894      *  panel
895      *  containing
896      *  this
897      *  JSeq
898      *  should
899      *  be
900      *  included
901      *  in
902      *  those
903      *  used
904      *  to
905      *  colour
906      *  its
907      *  associated
908      *  sequences
909      *  in
910      *  this
911      *  structureState(since
912      *  Jalview
913      *  2.7).
914      *  
915      * 
916      * @param colourwithAlignPanel the value of field
917      * 'colourwithAlignPanel'.
918      */
919     public void setColourwithAlignPanel(
920             final boolean colourwithAlignPanel) {
921         this._colourwithAlignPanel = colourwithAlignPanel;
922         this._has_colourwithAlignPanel = true;
923     }
924
925     /**
926      * Sets the value of field 'content'. The field 'content' has
927      * the following description: internal content storage
928      * 
929      * @param content the value of field 'content'.
930      */
931     public void setContent(
932             final java.lang.String content) {
933         this._content = content;
934     }
935
936     /**
937      * Sets the value of field 'height'.
938      * 
939      * @param height the value of field 'height'.
940      */
941     public void setHeight(
942             final int height) {
943         this._height = height;
944         this._has_height = true;
945     }
946
947     /**
948      * Sets the value of field 'type'. The field 'type' has the
949      * following description: An
950      *  identifier
951      *  for
952      *  the
953      *  viewer
954      *  type,
955      *  currently
956      *  either
957      *  JMOL
958      *  or
959      *  CHIMERA
960      *  
961      * 
962      * @param type the value of field 'type'.
963      */
964     public void setType(
965             final java.lang.String type) {
966         this._type = type;
967     }
968
969     /**
970      * Sets the value of field 'viewId'. The field 'viewId' has the
971      * following description: additional
972      *  identifier
973      *  which
974      *  properly
975      *  disambiguates
976      *  the
977      *  structure
978      *  view
979      *  from
980      *  any
981      *  other
982      *  view
983      *  with
984      *  the
985      *  same
986      *  attributes.
987      *  This
988      *  is
989      *  not
990      *  an
991      *  ID,
992      *  because
993      *  it
994      *  is
995      *  possible
996      *  to
997      *  have
998      *  many
999      *  references
1000      *  to
1001      *  the
1002      *  same
1003      *  physical
1004      *  structure
1005      *  view
1006      *  from
1007      *  different
1008      *  sequences
1009      *  in
1010      *  an
1011      *  alignment.
1012      *  A
1013      *  structureState
1014      *  element
1015      *  citing
1016      *  the
1017      *  same
1018      *  viewId
1019      *  will
1020      *  appear
1021      *  for
1022      *  each
1023      *  instance.
1024      *  
1025      * 
1026      * @param viewId the value of field 'viewId'.
1027      */
1028     public void setViewId(
1029             final java.lang.String viewId) {
1030         this._viewId = viewId;
1031     }
1032
1033     /**
1034      * Sets the value of field 'visible'.
1035      * 
1036      * @param visible the value of field 'visible'.
1037      */
1038     public void setVisible(
1039             final boolean visible) {
1040         this._visible = visible;
1041         this._has_visible = true;
1042     }
1043
1044     /**
1045      * Sets the value of field 'width'.
1046      * 
1047      * @param width the value of field 'width'.
1048      */
1049     public void setWidth(
1050             final int width) {
1051         this._width = width;
1052         this._has_width = true;
1053     }
1054
1055     /**
1056      * Sets the value of field 'xpos'.
1057      * 
1058      * @param xpos the value of field 'xpos'.
1059      */
1060     public void setXpos(
1061             final int xpos) {
1062         this._xpos = xpos;
1063         this._has_xpos = true;
1064     }
1065
1066     /**
1067      * Sets the value of field 'ypos'.
1068      * 
1069      * @param ypos the value of field 'ypos'.
1070      */
1071     public void setYpos(
1072             final int ypos) {
1073         this._ypos = ypos;
1074         this._has_ypos = true;
1075     }
1076
1077     /**
1078      * Method unmarshal.
1079      * 
1080      * @param reader
1081      * @throws org.exolab.castor.xml.MarshalException if object is
1082      * null or if any SAXException is thrown during marshaling
1083      * @throws org.exolab.castor.xml.ValidationException if this
1084      * object is an invalid instance according to the schema
1085      * @return the unmarshaled
1086      * jalview.schemabinding.version2.StructureState
1087      */
1088     public static jalview.schemabinding.version2.StructureState unmarshal(
1089             final java.io.Reader reader)
1090     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
1091         return (jalview.schemabinding.version2.StructureState) Unmarshaller.unmarshal(jalview.schemabinding.version2.StructureState.class, reader);
1092     }
1093
1094     /**
1095      * 
1096      * 
1097      * @throws org.exolab.castor.xml.ValidationException if this
1098      * object is an invalid instance according to the schema
1099      */
1100     public void validate(
1101     )
1102     throws org.exolab.castor.xml.ValidationException {
1103         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
1104         validator.validate(this);
1105     }
1106
1107 }