src/jalview/schemabinding/version2/Viewport.java

   1 /*******************************************************************************
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.
  17  * If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19  ******************************************************************************/
  20 /*
  21  * This class was automatically generated with
  22  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  23  * Schema.
  24  * $Id$
  25  */
  26
  27 package jalview.schemabinding.version2;
  28
  29 //---------------------------------/
  30 //- Imported classes and packages -/
  31 //---------------------------------/
  32
  33 import org.exolab.castor.xml.Marshaller;
  34 import org.exolab.castor.xml.Unmarshaller;
  35
  36 /**
  37  * Class Viewport.
  38  *
  39  * @version $Revision$ $Date$
  40  */
  41 public class Viewport implements java.io.Serializable
  42 {
  43
  44   // --------------------------/
  45   // - Class/Member Variables -/
  46   // --------------------------/
  47
  48   /**
  49    * Field _conservationSelected.
  50    */
  51   private boolean _conservationSelected;
  52
  53   /**
  54    * keeps track of state for field: _conservationSelected
  55    */
  56   private boolean _has_conservationSelected;
  57
  58   /**
  59    * Field _pidSelected.
  60    */
  61   private boolean _pidSelected;
  62
  63   /**
  64    * keeps track of state for field: _pidSelected
  65    */
  66   private boolean _has_pidSelected;
  67
  68   /**
  69    * Field _bgColour.
  70    */
  71   private java.lang.String _bgColour;
  72
  73   /**
  74    * Field _consThreshold.
  75    */
  76   private int _consThreshold;
  77
  78   /**
  79    * keeps track of state for field: _consThreshold
  80    */
  81   private boolean _has_consThreshold;
  82
  83   /**
  84    * Field _pidThreshold.
  85    */
  86   private int _pidThreshold;
  87
  88   /**
  89    * keeps track of state for field: _pidThreshold
  90    */
  91   private boolean _has_pidThreshold;
  92
  93   /**
  94    * Field _title.
  95    */
  96   private java.lang.String _title;
  97
  98   /**
  99    * Field _showFullId.
 100    */
 101   private boolean _showFullId;
 102
 103   /**
 104    * keeps track of state for field: _showFullId
 105    */
 106   private boolean _has_showFullId;
 107
 108   /**
 109    * Field _rightAlignIds.
 110    */
 111   private boolean _rightAlignIds;
 112
 113   /**
 114    * keeps track of state for field: _rightAlignIds
 115    */
 116   private boolean _has_rightAlignIds;
 117
 118   /**
 119    * Field _showText.
 120    */
 121   private boolean _showText;
 122
 123   /**
 124    * keeps track of state for field: _showText
 125    */
 126   private boolean _has_showText;
 127
 128   /**
 129    * Field _showColourText.
 130    */
 131   private boolean _showColourText;
 132
 133   /**
 134    * keeps track of state for field: _showColourText
 135    */
 136   private boolean _has_showColourText;
 137
 138   /**
 139    * Field _showUnconserved.
 140    */
 141   private boolean _showUnconserved = false;
 142
 143   /**
 144    * keeps track of state for field: _showUnconserved
 145    */
 146   private boolean _has_showUnconserved;
 147
 148   /**
 149    * Field _showBoxes.
 150    */
 151   private boolean _showBoxes;
 152
 153   /**
 154    * keeps track of state for field: _showBoxes
 155    */
 156   private boolean _has_showBoxes;
 157
 158   /**
 159    * Field _wrapAlignment.
 160    */
 161   private boolean _wrapAlignment;
 162
 163   /**
 164    * keeps track of state for field: _wrapAlignment
 165    */
 166   private boolean _has_wrapAlignment;
 167
 168   /**
 169    * Field _renderGaps.
 170    */
 171   private boolean _renderGaps;
 172
 173   /**
 174    * keeps track of state for field: _renderGaps
 175    */
 176   private boolean _has_renderGaps;
 177
 178   /**
 179    * Field _showSequenceFeatures.
 180    */
 181   private boolean _showSequenceFeatures;
 182
 183   /**
 184    * keeps track of state for field: _showSequenceFeatures
 185    */
 186   private boolean _has_showSequenceFeatures;
 187
 188   /**
 189    * Field _showNPfeatureTooltip.
 190    */
 191   private boolean _showNPfeatureTooltip;
 192
 193   /**
 194    * keeps track of state for field: _showNPfeatureTooltip
 195    */
 196   private boolean _has_showNPfeatureTooltip;
 197
 198   /**
 199    * Field _showDbRefTooltip.
 200    */
 201   private boolean _showDbRefTooltip;
 202
 203   /**
 204    * keeps track of state for field: _showDbRefTooltip
 205    */
 206   private boolean _has_showDbRefTooltip;
 207
 208   /**
 209    * Field _followHighlight.
 210    */
 211   private boolean _followHighlight = true;
 212
 213   /**
 214    * keeps track of state for field: _followHighlight
 215    */
 216   private boolean _has_followHighlight;
 217
 218   /**
 219    * Field _followSelection.
 220    */
 221   private boolean _followSelection = true;
 222
 223   /**
 224    * keeps track of state for field: _followSelection
 225    */
 226   private boolean _has_followSelection;
 227
 228   /**
 229    * Field _showAnnotation.
 230    */
 231   private boolean _showAnnotation;
 232
 233   /**
 234    * keeps track of state for field: _showAnnotation
 235    */
 236   private boolean _has_showAnnotation;
 237
 238   /**
 239    * Field _centreColumnLabels.
 240    */
 241   private boolean _centreColumnLabels = false;
 242
 243   /**
 244    * keeps track of state for field: _centreColumnLabels
 245    */
 246   private boolean _has_centreColumnLabels;
 247
 248   /**
 249    * Field _showGroupConservation.
 250    */
 251   private boolean _showGroupConservation = false;
 252
 253   /**
 254    * keeps track of state for field: _showGroupConservation
 255    */
 256   private boolean _has_showGroupConservation;
 257
 258   /**
 259    * Field _showGroupConsensus.
 260    */
 261   private boolean _showGroupConsensus = false;
 262
 263   /**
 264    * keeps track of state for field: _showGroupConsensus
 265    */
 266   private boolean _has_showGroupConsensus;
 267
 268   /**
 269    * Field _showConsensusHistogram.
 270    */
 271   private boolean _showConsensusHistogram = true;
 272
 273   /**
 274    * keeps track of state for field: _showConsensusHistogram
 275    */
 276   private boolean _has_showConsensusHistogram;
 277
 278   /**
 279    * Field _showSequenceLogo.
 280    */
 281   private boolean _showSequenceLogo = false;
 282
 283   /**
 284    * keeps track of state for field: _showSequenceLogo
 285    */
 286   private boolean _has_showSequenceLogo;
 287
 288   /**
 289    * Field _normaliseSequenceLogo.
 290    */
 291   private boolean _normaliseSequenceLogo = false;
 292
 293   /**
 294    * keeps track of state for field: _normaliseSequenceLogo
 295    */
 296   private boolean _has_normaliseSequenceLogo;
 297
 298   /**
 299    * Field _ignoreGapsinConsensus.
 300    */
 301   private boolean _ignoreGapsinConsensus = true;
 302
 303   /**
 304    * keeps track of state for field: _ignoreGapsinConsensus
 305    */
 306   private boolean _has_ignoreGapsinConsensus;
 307
 308   /**
 309    * Field _startRes.
 310    */
 311   private int _startRes;
 312
 313   /**
 314    * keeps track of state for field: _startRes
 315    */
 316   private boolean _has_startRes;
 317
 318   /**
 319    * Field _startSeq.
 320    */
 321   private int _startSeq;
 322
 323   /**
 324    * keeps track of state for field: _startSeq
 325    */
 326   private boolean _has_startSeq;
 327
 328   /**
 329    * Field _fontName.
 330    */
 331   private java.lang.String _fontName;
 332
 333   /**
 334    * Field _fontSize.
 335    */
 336   private int _fontSize;
 337
 338   /**
 339    * keeps track of state for field: _fontSize
 340    */
 341   private boolean _has_fontSize;
 342
 343   /**
 344    * Field _fontStyle.
 345    */
 346   private int _fontStyle;
 347
 348   /**
 349    * keeps track of state for field: _fontStyle
 350    */
 351   private boolean _has_fontStyle;
 352
 353   /**
 354    * Field _viewName.
 355    */
 356   private java.lang.String _viewName;
 357
 358   /**
 359    * Field _sequenceSetId.
 360    */
 361   private java.lang.String _sequenceSetId;
 362
 363   /**
 364    * Field _gatheredViews.
 365    */
 366   private boolean _gatheredViews;
 367
 368   /**
 369    * keeps track of state for field: _gatheredViews
 370    */
 371   private boolean _has_gatheredViews;
 372
 373   /**
 374    * Field _textCol1.
 375    */
 376   private int _textCol1;
 377
 378   /**
 379    * keeps track of state for field: _textCol1
 380    */
 381   private boolean _has_textCol1;
 382
 383   /**
 384    * Field _textCol2.
 385    */
 386   private int _textCol2;
 387
 388   /**
 389    * keeps track of state for field: _textCol2
 390    */
 391   private boolean _has_textCol2;
 392
 393   /**
 394    * Field _textColThreshold.
 395    */
 396   private int _textColThreshold;
 397
 398   /**
 399    * keeps track of state for field: _textColThreshold
 400    */
 401   private boolean _has_textColThreshold;
 402
 403   /**
 404    * unique id used by jalview to synchronize between stored and instantiated
 405    * views
 406    *
 407    */
 408   private java.lang.String _id;
 409
 410   /**
 411    * Field _width.
 412    */
 413   private int _width;
 414
 415   /**
 416    * keeps track of state for field: _width
 417    */
 418   private boolean _has_width;
 419
 420   /**
 421    * Field _height.
 422    */
 423   private int _height;
 424
 425   /**
 426    * keeps track of state for field: _height
 427    */
 428   private boolean _has_height;
 429
 430   /**
 431    * Field _xpos.
 432    */
 433   private int _xpos;
 434
 435   /**
 436    * keeps track of state for field: _xpos
 437    */
 438   private boolean _has_xpos;
 439
 440   /**
 441    * Field _ypos.
 442    */
 443   private int _ypos;
 444
 445   /**
 446    * keeps track of state for field: _ypos
 447    */
 448   private boolean _has_ypos;
 449
 450   /**
 451    * Field _annotationColours.
 452    */
 453   private jalview.schemabinding.version2.AnnotationColours _annotationColours;
 454
 455   /**
 456    * Field _hiddenColumnsList.
 457    */
 458   private java.util.Vector _hiddenColumnsList;
 459
 460   /**
 461    * Field _calcIdParamList.
 462    */
 463   private java.util.Vector _calcIdParamList;
 464
 465   // ----------------/
 466   // - Constructors -/
 467   // ----------------/
 468
 469   public Viewport()
 470   {
 471     super();
 472     this._hiddenColumnsList = new java.util.Vector();
 473     this._calcIdParamList = new java.util.Vector();
 474   }
 475
 476   // -----------/
 477   // - Methods -/
 478   // -----------/
 479
 480   /**
 481    *
 482    *
 483    * @param vCalcIdParam
 484    * @throws java.lang.IndexOutOfBoundsException
 485    *           if the index given is outside the bounds of the collection
 486    */
 487   public void addCalcIdParam(
 488           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
 489           throws java.lang.IndexOutOfBoundsException
 490   {
 491     this._calcIdParamList.addElement(vCalcIdParam);
 492   }
 493
 494   /**
 495    *
 496    *
 497    * @param index
 498    * @param vCalcIdParam
 499    * @throws java.lang.IndexOutOfBoundsException
 500    *           if the index given is outside the bounds of the collection
 501    */
 502   public void addCalcIdParam(final int index,
 503           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
 504           throws java.lang.IndexOutOfBoundsException
 505   {
 506     this._calcIdParamList.add(index, vCalcIdParam);
 507   }
 508
 509   /**
 510    *
 511    *
 512    * @param vHiddenColumns
 513    * @throws java.lang.IndexOutOfBoundsException
 514    *           if the index given is outside the bounds of the collection
 515    */
 516   public void addHiddenColumns(
 517           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
 518           throws java.lang.IndexOutOfBoundsException
 519   {
 520     this._hiddenColumnsList.addElement(vHiddenColumns);
 521   }
 522
 523   /**
 524    *
 525    *
 526    * @param index
 527    * @param vHiddenColumns
 528    * @throws java.lang.IndexOutOfBoundsException
 529    *           if the index given is outside the bounds of the collection
 530    */
 531   public void addHiddenColumns(final int index,
 532           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
 533           throws java.lang.IndexOutOfBoundsException
 534   {
 535     this._hiddenColumnsList.add(index, vHiddenColumns);
 536   }
 537
 538   /**
 539      */
 540   public void deleteCentreColumnLabels()
 541   {
 542     this._has_centreColumnLabels = false;
 543   }
 544
 545   /**
 546      */
 547   public void deleteConsThreshold()
 548   {
 549     this._has_consThreshold = false;
 550   }
 551
 552   /**
 553      */
 554   public void deleteConservationSelected()
 555   {
 556     this._has_conservationSelected = false;
 557   }
 558
 559   /**
 560      */
 561   public void deleteFollowHighlight()
 562   {
 563     this._has_followHighlight = false;
 564   }
 565
 566   /**
 567      */
 568   public void deleteFollowSelection()
 569   {
 570     this._has_followSelection = false;
 571   }
 572
 573   /**
 574      */
 575   public void deleteFontSize()
 576   {
 577     this._has_fontSize = false;
 578   }
 579
 580   /**
 581      */
 582   public void deleteFontStyle()
 583   {
 584     this._has_fontStyle = false;
 585   }
 586
 587   /**
 588      */
 589   public void deleteGatheredViews()
 590   {
 591     this._has_gatheredViews = false;
 592   }
 593
 594   /**
 595      */
 596   public void deleteHeight()
 597   {
 598     this._has_height = false;
 599   }
 600
 601   /**
 602      */
 603   public void deleteIgnoreGapsinConsensus()
 604   {
 605     this._has_ignoreGapsinConsensus = false;
 606   }
 607
 608   /**
 609      */
 610   public void deleteNormaliseSequenceLogo()
 611   {
 612     this._has_normaliseSequenceLogo = false;
 613   }
 614
 615   /**
 616      */
 617   public void deletePidSelected()
 618   {
 619     this._has_pidSelected = false;
 620   }
 621
 622   /**
 623      */
 624   public void deletePidThreshold()
 625   {
 626     this._has_pidThreshold = false;
 627   }
 628
 629   /**
 630      */
 631   public void deleteRenderGaps()
 632   {
 633     this._has_renderGaps = false;
 634   }
 635
 636   /**
 637      */
 638   public void deleteRightAlignIds()
 639   {
 640     this._has_rightAlignIds = false;
 641   }
 642
 643   /**
 644      */
 645   public void deleteShowAnnotation()
 646   {
 647     this._has_showAnnotation = false;
 648   }
 649
 650   /**
 651      */
 652   public void deleteShowBoxes()
 653   {
 654     this._has_showBoxes = false;
 655   }
 656
 657   /**
 658      */
 659   public void deleteShowColourText()
 660   {
 661     this._has_showColourText = false;
 662   }
 663
 664   /**
 665      */
 666   public void deleteShowConsensusHistogram()
 667   {
 668     this._has_showConsensusHistogram = false;
 669   }
 670
 671   /**
 672      */
 673   public void deleteShowDbRefTooltip()
 674   {
 675     this._has_showDbRefTooltip = false;
 676   }
 677
 678   /**
 679      */
 680   public void deleteShowFullId()
 681   {
 682     this._has_showFullId = false;
 683   }
 684
 685   /**
 686      */
 687   public void deleteShowGroupConsensus()
 688   {
 689     this._has_showGroupConsensus = false;
 690   }
 691
 692   /**
 693      */
 694   public void deleteShowGroupConservation()
 695   {
 696     this._has_showGroupConservation = false;
 697   }
 698
 699   /**
 700      */
 701   public void deleteShowNPfeatureTooltip()
 702   {
 703     this._has_showNPfeatureTooltip = false;
 704   }
 705
 706   /**
 707      */
 708   public void deleteShowSequenceFeatures()
 709   {
 710     this._has_showSequenceFeatures = false;
 711   }
 712
 713   /**
 714      */
 715   public void deleteShowSequenceLogo()
 716   {
 717     this._has_showSequenceLogo = false;
 718   }
 719
 720   /**
 721      */
 722   public void deleteShowText()
 723   {
 724     this._has_showText = false;
 725   }
 726
 727   /**
 728      */
 729   public void deleteShowUnconserved()
 730   {
 731     this._has_showUnconserved = false;
 732   }
 733
 734   /**
 735      */
 736   public void deleteStartRes()
 737   {
 738     this._has_startRes = false;
 739   }
 740
 741   /**
 742      */
 743   public void deleteStartSeq()
 744   {
 745     this._has_startSeq = false;
 746   }
 747
 748   /**
 749      */
 750   public void deleteTextCol1()
 751   {
 752     this._has_textCol1 = false;
 753   }
 754
 755   /**
 756      */
 757   public void deleteTextCol2()
 758   {
 759     this._has_textCol2 = false;
 760   }
 761
 762   /**
 763      */
 764   public void deleteTextColThreshold()
 765   {
 766     this._has_textColThreshold = false;
 767   }
 768
 769   /**
 770      */
 771   public void deleteWidth()
 772   {
 773     this._has_width = false;
 774   }
 775
 776   /**
 777      */
 778   public void deleteWrapAlignment()
 779   {
 780     this._has_wrapAlignment = false;
 781   }
 782
 783   /**
 784      */
 785   public void deleteXpos()
 786   {
 787     this._has_xpos = false;
 788   }
 789
 790   /**
 791      */
 792   public void deleteYpos()
 793   {
 794     this._has_ypos = false;
 795   }
 796
 797   /**
 798    * Method enumerateCalcIdParam.
 799    *
 800    * @return an Enumeration over all jalview.schemabinding.version2.CalcIdParam
 801    *         elements
 802    */
 803   public java.util.Enumeration enumerateCalcIdParam()
 804   {
 805     return this._calcIdParamList.elements();
 806   }
 807
 808   /**
 809    * Method enumerateHiddenColumns.
 810    *
 811    * @return an Enumeration over all
 812    *         jalview.schemabinding.version2.HiddenColumns elements
 813    */
 814   public java.util.Enumeration enumerateHiddenColumns()
 815   {
 816     return this._hiddenColumnsList.elements();
 817   }
 818
 819   /**
 820    * Returns the value of field 'annotationColours'.
 821    *
 822    * @return the value of field 'AnnotationColours'.
 823    */
 824   public jalview.schemabinding.version2.AnnotationColours getAnnotationColours()
 825   {
 826     return this._annotationColours;
 827   }
 828
 829   /**
 830    * Returns the value of field 'bgColour'.
 831    *
 832    * @return the value of field 'BgColour'.
 833    */
 834   public java.lang.String getBgColour()
 835   {
 836     return this._bgColour;
 837   }
 838
 839   /**
 840    * Method getCalcIdParam.
 841    *
 842    * @param index
 843    * @throws java.lang.IndexOutOfBoundsException
 844    *           if the index given is outside the bounds of the collection
 845    * @return the value of the jalview.schemabinding.version2.CalcIdParam at the
 846    *         given index
 847    */
 848   public jalview.schemabinding.version2.CalcIdParam getCalcIdParam(
 849           final int index) throws java.lang.IndexOutOfBoundsException
 850   {
 851     // check bounds for index
 852     if (index < 0 || index >= this._calcIdParamList.size())
 853     {
 854       throw new IndexOutOfBoundsException("getCalcIdParam: Index value '"
 855               + index + "' not in range [0.."
 856               + (this._calcIdParamList.size() - 1) + "]");
 857     }
 858
 859     return (jalview.schemabinding.version2.CalcIdParam) _calcIdParamList
 860             .get(index);
 861   }
 862
 863   /**
 864    * Method getCalcIdParam.Returns the contents of the collection in an Array.
 865    * <p>
 866    * Note: Just in case the collection contents are changing in another thread,
 867    * we pass a 0-length Array of the correct type into the API call. This way we
 868    * <i>know</i> that the Array returned is of exactly the correct length.
 869    *
 870    * @return this collection as an Array
 871    */
 872   public jalview.schemabinding.version2.CalcIdParam[] getCalcIdParam()
 873   {
 874     jalview.schemabinding.version2.CalcIdParam[] array = new jalview.schemabinding.version2.CalcIdParam[0];
 875     return (jalview.schemabinding.version2.CalcIdParam[]) this._calcIdParamList
 876             .toArray(array);
 877   }
 878
 879   /**
 880    * Method getCalcIdParamCount.
 881    *
 882    * @return the size of this collection
 883    */
 884   public int getCalcIdParamCount()
 885   {
 886     return this._calcIdParamList.size();
 887   }
 888
 889   /**
 890    * Returns the value of field 'centreColumnLabels'.
 891    *
 892    * @return the value of field 'CentreColumnLabels'.
 893    */
 894   public boolean getCentreColumnLabels()
 895   {
 896     return this._centreColumnLabels;
 897   }
 898
 899   /**
 900    * Returns the value of field 'consThreshold'.
 901    *
 902    * @return the value of field 'ConsThreshold'.
 903    */
 904   public int getConsThreshold()
 905   {
 906     return this._consThreshold;
 907   }
 908
 909   /**
 910    * Returns the value of field 'conservationSelected'.
 911    *
 912    * @return the value of field 'ConservationSelected'.
 913    */
 914   public boolean getConservationSelected()
 915   {
 916     return this._conservationSelected;
 917   }
 918
 919   /**
 920    * Returns the value of field 'followHighlight'.
 921    *
 922    * @return the value of field 'FollowHighlight'.
 923    */
 924   public boolean getFollowHighlight()
 925   {
 926     return this._followHighlight;
 927   }
 928
 929   /**
 930    * Returns the value of field 'followSelection'.
 931    *
 932    * @return the value of field 'FollowSelection'.
 933    */
 934   public boolean getFollowSelection()
 935   {
 936     return this._followSelection;
 937   }
 938
 939   /**
 940    * Returns the value of field 'fontName'.
 941    *
 942    * @return the value of field 'FontName'.
 943    */
 944   public java.lang.String getFontName()
 945   {
 946     return this._fontName;
 947   }
 948
 949   /**
 950    * Returns the value of field 'fontSize'.
 951    *
 952    * @return the value of field 'FontSize'.
 953    */
 954   public int getFontSize()
 955   {
 956     return this._fontSize;
 957   }
 958
 959   /**
 960    * Returns the value of field 'fontStyle'.
 961    *
 962    * @return the value of field 'FontStyle'.
 963    */
 964   public int getFontStyle()
 965   {
 966     return this._fontStyle;
 967   }
 968
 969   /**
 970    * Returns the value of field 'gatheredViews'.
 971    *
 972    * @return the value of field 'GatheredViews'.
 973    */
 974   public boolean getGatheredViews()
 975   {
 976     return this._gatheredViews;
 977   }
 978
 979   /**
 980    * Returns the value of field 'height'.
 981    *
 982    * @return the value of field 'Height'.
 983    */
 984   public int getHeight()
 985   {
 986     return this._height;
 987   }
 988
 989   /**
 990    * Method getHiddenColumns.
 991    *
 992    * @param index
 993    * @throws java.lang.IndexOutOfBoundsException
 994    *           if the index given is outside the bounds of the collection
 995    * @return the value of the jalview.schemabinding.version2.HiddenColumns at
 996    *         the given index
 997    */
 998   public jalview.schemabinding.version2.HiddenColumns getHiddenColumns(
 999           final int index) throws java.lang.IndexOutOfBoundsException
1000   {
1001     // check bounds for index
1002     if (index < 0 || index >= this._hiddenColumnsList.size())
1003     {
1004       throw new IndexOutOfBoundsException("getHiddenColumns: Index value '"
1005               + index + "' not in range [0.."
1006               + (this._hiddenColumnsList.size() - 1) + "]");
1007     }
1008
1009     return (jalview.schemabinding.version2.HiddenColumns) _hiddenColumnsList
1010             .get(index);
1011   }
1012
1013   /**
1014    * Method getHiddenColumns.Returns the contents of the collection in an Array.
1015    * <p>
1016    * Note: Just in case the collection contents are changing in another thread,
1017    * we pass a 0-length Array of the correct type into the API call. This way we
1018    * <i>know</i> that the Array returned is of exactly the correct length.
1019    *
1020    * @return this collection as an Array
1021    */
1022   public jalview.schemabinding.version2.HiddenColumns[] getHiddenColumns()
1023   {
1024     jalview.schemabinding.version2.HiddenColumns[] array = new jalview.schemabinding.version2.HiddenColumns[0];
1025     return (jalview.schemabinding.version2.HiddenColumns[]) this._hiddenColumnsList
1026             .toArray(array);
1027   }
1028
1029   /**
1030    * Method getHiddenColumnsCount.
1031    *
1032    * @return the size of this collection
1033    */
1034   public int getHiddenColumnsCount()
1035   {
1036     return this._hiddenColumnsList.size();
1037   }
1038
1039   /**
1040    * Returns the value of field 'id'. The field 'id' has the following
1041    * description: unique id used by jalview to synchronize between stored and
1042    * instantiated views
1043    *
1044    *
1045    * @return the value of field 'Id'.
1046    */
1047   public java.lang.String getId()
1048   {
1049     return this._id;
1050   }
1051
1052   /**
1053    * Returns the value of field 'ignoreGapsinConsensus'.
1054    *
1055    * @return the value of field 'IgnoreGapsinConsensus'.
1056    */
1057   public boolean getIgnoreGapsinConsensus()
1058   {
1059     return this._ignoreGapsinConsensus;
1060   }
1061
1062   /**
1063    * Returns the value of field 'normaliseSequenceLogo'.
1064    *
1065    * @return the value of field 'NormaliseSequenceLogo'.
1066    */
1067   public boolean getNormaliseSequenceLogo()
1068   {
1069     return this._normaliseSequenceLogo;
1070   }
1071
1072   /**
1073    * Returns the value of field 'pidSelected'.
1074    *
1075    * @return the value of field 'PidSelected'.
1076    */
1077   public boolean getPidSelected()
1078   {
1079     return this._pidSelected;
1080   }
1081
1082   /**
1083    * Returns the value of field 'pidThreshold'.
1084    *
1085    * @return the value of field 'PidThreshold'.
1086    */
1087   public int getPidThreshold()
1088   {
1089     return this._pidThreshold;
1090   }
1091
1092   /**
1093    * Returns the value of field 'renderGaps'.
1094    *
1095    * @return the value of field 'RenderGaps'.
1096    */
1097   public boolean getRenderGaps()
1098   {
1099     return this._renderGaps;
1100   }
1101
1102   /**
1103    * Returns the value of field 'rightAlignIds'.
1104    *
1105    * @return the value of field 'RightAlignIds'.
1106    */
1107   public boolean getRightAlignIds()
1108   {
1109     return this._rightAlignIds;
1110   }
1111
1112   /**
1113    * Returns the value of field 'sequenceSetId'.
1114    *
1115    * @return the value of field 'SequenceSetId'.
1116    */
1117   public java.lang.String getSequenceSetId()
1118   {
1119     return this._sequenceSetId;
1120   }
1121
1122   /**
1123    * Returns the value of field 'showAnnotation'.
1124    *
1125    * @return the value of field 'ShowAnnotation'.
1126    */
1127   public boolean getShowAnnotation()
1128   {
1129     return this._showAnnotation;
1130   }
1131
1132   /**
1133    * Returns the value of field 'showBoxes'.
1134    *
1135    * @return the value of field 'ShowBoxes'.
1136    */
1137   public boolean getShowBoxes()
1138   {
1139     return this._showBoxes;
1140   }
1141
1142   /**
1143    * Returns the value of field 'showColourText'.
1144    *
1145    * @return the value of field 'ShowColourText'.
1146    */
1147   public boolean getShowColourText()
1148   {
1149     return this._showColourText;
1150   }
1151
1152   /**
1153    * Returns the value of field 'showConsensusHistogram'.
1154    *
1155    * @return the value of field 'ShowConsensusHistogram'.
1156    */
1157   public boolean getShowConsensusHistogram()
1158   {
1159     return this._showConsensusHistogram;
1160   }
1161
1162   /**
1163    * Returns the value of field 'showDbRefTooltip'.
1164    *
1165    * @return the value of field 'ShowDbRefTooltip'.
1166    */
1167   public boolean getShowDbRefTooltip()
1168   {
1169     return this._showDbRefTooltip;
1170   }
1171
1172   /**
1173    * Returns the value of field 'showFullId'.
1174    *
1175    * @return the value of field 'ShowFullId'.
1176    */
1177   public boolean getShowFullId()
1178   {
1179     return this._showFullId;
1180   }
1181
1182   /**
1183    * Returns the value of field 'showGroupConsensus'.
1184    *
1185    * @return the value of field 'ShowGroupConsensus'.
1186    */
1187   public boolean getShowGroupConsensus()
1188   {
1189     return this._showGroupConsensus;
1190   }
1191
1192   /**
1193    * Returns the value of field 'showGroupConservation'.
1194    *
1195    * @return the value of field 'ShowGroupConservation'.
1196    */
1197   public boolean getShowGroupConservation()
1198   {
1199     return this._showGroupConservation;
1200   }
1201
1202   /**
1203    * Returns the value of field 'showNPfeatureTooltip'.
1204    *
1205    * @return the value of field 'ShowNPfeatureTooltip'.
1206    */
1207   public boolean getShowNPfeatureTooltip()
1208   {
1209     return this._showNPfeatureTooltip;
1210   }
1211
1212   /**
1213    * Returns the value of field 'showSequenceFeatures'.
1214    *
1215    * @return the value of field 'ShowSequenceFeatures'.
1216    */
1217   public boolean getShowSequenceFeatures()
1218   {
1219     return this._showSequenceFeatures;
1220   }
1221
1222   /**
1223    * Returns the value of field 'showSequenceLogo'.
1224    *
1225    * @return the value of field 'ShowSequenceLogo'.
1226    */
1227   public boolean getShowSequenceLogo()
1228   {
1229     return this._showSequenceLogo;
1230   }
1231
1232   /**
1233    * Returns the value of field 'showText'.
1234    *
1235    * @return the value of field 'ShowText'.
1236    */
1237   public boolean getShowText()
1238   {
1239     return this._showText;
1240   }
1241
1242   /**
1243    * Returns the value of field 'showUnconserved'.
1244    *
1245    * @return the value of field 'ShowUnconserved'.
1246    */
1247   public boolean getShowUnconserved()
1248   {
1249     return this._showUnconserved;
1250   }
1251
1252   /**
1253    * Returns the value of field 'startRes'.
1254    *
1255    * @return the value of field 'StartRes'.
1256    */
1257   public int getStartRes()
1258   {
1259     return this._startRes;
1260   }
1261
1262   /**
1263    * Returns the value of field 'startSeq'.
1264    *
1265    * @return the value of field 'StartSeq'.
1266    */
1267   public int getStartSeq()
1268   {
1269     return this._startSeq;
1270   }
1271
1272   /**
1273    * Returns the value of field 'textCol1'.
1274    *
1275    * @return the value of field 'TextCol1'.
1276    */
1277   public int getTextCol1()
1278   {
1279     return this._textCol1;
1280   }
1281
1282   /**
1283    * Returns the value of field 'textCol2'.
1284    *
1285    * @return the value of field 'TextCol2'.
1286    */
1287   public int getTextCol2()
1288   {
1289     return this._textCol2;
1290   }
1291
1292   /**
1293    * Returns the value of field 'textColThreshold'.
1294    *
1295    * @return the value of field 'TextColThreshold'.
1296    */
1297   public int getTextColThreshold()
1298   {
1299     return this._textColThreshold;
1300   }
1301
1302   /**
1303    * Returns the value of field 'title'.
1304    *
1305    * @return the value of field 'Title'.
1306    */
1307   public java.lang.String getTitle()
1308   {
1309     return this._title;
1310   }
1311
1312   /**
1313    * Returns the value of field 'viewName'.
1314    *
1315    * @return the value of field 'ViewName'.
1316    */
1317   public java.lang.String getViewName()
1318   {
1319     return this._viewName;
1320   }
1321
1322   /**
1323    * Returns the value of field 'width'.
1324    *
1325    * @return the value of field 'Width'.
1326    */
1327   public int getWidth()
1328   {
1329     return this._width;
1330   }
1331
1332   /**
1333    * Returns the value of field 'wrapAlignment'.
1334    *
1335    * @return the value of field 'WrapAlignment'.
1336    */
1337   public boolean getWrapAlignment()
1338   {
1339     return this._wrapAlignment;
1340   }
1341
1342   /**
1343    * Returns the value of field 'xpos'.
1344    *
1345    * @return the value of field 'Xpos'.
1346    */
1347   public int getXpos()
1348   {
1349     return this._xpos;
1350   }
1351
1352   /**
1353    * Returns the value of field 'ypos'.
1354    *
1355    * @return the value of field 'Ypos'.
1356    */
1357   public int getYpos()
1358   {
1359     return this._ypos;
1360   }
1361
1362   /**
1363    * Method hasCentreColumnLabels.
1364    *
1365    * @return true if at least one CentreColumnLabels has been adde
1366    */
1367   public boolean hasCentreColumnLabels()
1368   {
1369     return this._has_centreColumnLabels;
1370   }
1371
1372   /**
1373    * Method hasConsThreshold.
1374    *
1375    * @return true if at least one ConsThreshold has been added
1376    */
1377   public boolean hasConsThreshold()
1378   {
1379     return this._has_consThreshold;
1380   }
1381
1382   /**
1383    * Method hasConservationSelected.
1384    *
1385    * @return true if at least one ConservationSelected has been added
1386    */
1387   public boolean hasConservationSelected()
1388   {
1389     return this._has_conservationSelected;
1390   }
1391
1392   /**
1393    * Method hasFollowHighlight.
1394    *
1395    * @return true if at least one FollowHighlight has been added
1396    */
1397   public boolean hasFollowHighlight()
1398   {
1399     return this._has_followHighlight;
1400   }
1401
1402   /**
1403    * Method hasFollowSelection.
1404    *
1405    * @return true if at least one FollowSelection has been added
1406    */
1407   public boolean hasFollowSelection()
1408   {
1409     return this._has_followSelection;
1410   }
1411
1412   /**
1413    * Method hasFontSize.
1414    *
1415    * @return true if at least one FontSize has been added
1416    */
1417   public boolean hasFontSize()
1418   {
1419     return this._has_fontSize;
1420   }
1421
1422   /**
1423    * Method hasFontStyle.
1424    *
1425    * @return true if at least one FontStyle has been added
1426    */
1427   public boolean hasFontStyle()
1428   {
1429     return this._has_fontStyle;
1430   }
1431
1432   /**
1433    * Method hasGatheredViews.
1434    *
1435    * @return true if at least one GatheredViews has been added
1436    */
1437   public boolean hasGatheredViews()
1438   {
1439     return this._has_gatheredViews;
1440   }
1441
1442   /**
1443    * Method hasHeight.
1444    *
1445    * @return true if at least one Height has been added
1446    */
1447   public boolean hasHeight()
1448   {
1449     return this._has_height;
1450   }
1451
1452   /**
1453    * Method hasIgnoreGapsinConsensus.
1454    *
1455    * @return true if at least one IgnoreGapsinConsensus has been added
1456    */
1457   public boolean hasIgnoreGapsinConsensus()
1458   {
1459     return this._has_ignoreGapsinConsensus;
1460   }
1461
1462   /**
1463    * Method hasNormaliseSequenceLogo.
1464    *
1465    * @return true if at least one NormaliseSequenceLogo has been added
1466    */
1467   public boolean hasNormaliseSequenceLogo()
1468   {
1469     return this._has_normaliseSequenceLogo;
1470   }
1471
1472   /**
1473    * Method hasPidSelected.
1474    *
1475    * @return true if at least one PidSelected has been added
1476    */
1477   public boolean hasPidSelected()
1478   {
1479     return this._has_pidSelected;
1480   }
1481
1482   /**
1483    * Method hasPidThreshold.
1484    *
1485    * @return true if at least one PidThreshold has been added
1486    */
1487   public boolean hasPidThreshold()
1488   {
1489     return this._has_pidThreshold;
1490   }
1491
1492   /**
1493    * Method hasRenderGaps.
1494    *
1495    * @return true if at least one RenderGaps has been added
1496    */
1497   public boolean hasRenderGaps()
1498   {
1499     return this._has_renderGaps;
1500   }
1501
1502   /**
1503    * Method hasRightAlignIds.
1504    *
1505    * @return true if at least one RightAlignIds has been added
1506    */
1507   public boolean hasRightAlignIds()
1508   {
1509     return this._has_rightAlignIds;
1510   }
1511
1512   /**
1513    * Method hasShowAnnotation.
1514    *
1515    * @return true if at least one ShowAnnotation has been added
1516    */
1517   public boolean hasShowAnnotation()
1518   {
1519     return this._has_showAnnotation;
1520   }
1521
1522   /**
1523    * Method hasShowBoxes.
1524    *
1525    * @return true if at least one ShowBoxes has been added
1526    */
1527   public boolean hasShowBoxes()
1528   {
1529     return this._has_showBoxes;
1530   }
1531
1532   /**
1533    * Method hasShowColourText.
1534    *
1535    * @return true if at least one ShowColourText has been added
1536    */
1537   public boolean hasShowColourText()
1538   {
1539     return this._has_showColourText;
1540   }
1541
1542   /**
1543    * Method hasShowConsensusHistogram.
1544    *
1545    * @return true if at least one ShowConsensusHistogram has been added
1546    */
1547   public boolean hasShowConsensusHistogram()
1548   {
1549     return this._has_showConsensusHistogram;
1550   }
1551
1552   /**
1553    * Method hasShowDbRefTooltip.
1554    *
1555    * @return true if at least one ShowDbRefTooltip has been added
1556    */
1557   public boolean hasShowDbRefTooltip()
1558   {
1559     return this._has_showDbRefTooltip;
1560   }
1561
1562   /**
1563    * Method hasShowFullId.
1564    *
1565    * @return true if at least one ShowFullId has been added
1566    */
1567   public boolean hasShowFullId()
1568   {
1569     return this._has_showFullId;
1570   }
1571
1572   /**
1573    * Method hasShowGroupConsensus.
1574    *
1575    * @return true if at least one ShowGroupConsensus has been adde
1576    */
1577   public boolean hasShowGroupConsensus()
1578   {
1579     return this._has_showGroupConsensus;
1580   }
1581
1582   /**
1583    * Method hasShowGroupConservation.
1584    *
1585    * @return true if at least one ShowGroupConservation has been added
1586    */
1587   public boolean hasShowGroupConservation()
1588   {
1589     return this._has_showGroupConservation;
1590   }
1591
1592   /**
1593    * Method hasShowNPfeatureTooltip.
1594    *
1595    * @return true if at least one ShowNPfeatureTooltip has been added
1596    */
1597   public boolean hasShowNPfeatureTooltip()
1598   {
1599     return this._has_showNPfeatureTooltip;
1600   }
1601
1602   /**
1603    * Method hasShowSequenceFeatures.
1604    *
1605    * @return true if at least one ShowSequenceFeatures has been added
1606    */
1607   public boolean hasShowSequenceFeatures()
1608   {
1609     return this._has_showSequenceFeatures;
1610   }
1611
1612   /**
1613    * Method hasShowSequenceLogo.
1614    *
1615    * @return true if at least one ShowSequenceLogo has been added
1616    */
1617   public boolean hasShowSequenceLogo()
1618   {
1619     return this._has_showSequenceLogo;
1620   }
1621
1622   /**
1623    * Method hasShowText.
1624    *
1625    * @return true if at least one ShowText has been added
1626    */
1627   public boolean hasShowText()
1628   {
1629     return this._has_showText;
1630   }
1631
1632   /**
1633    * Method hasShowUnconserved.
1634    *
1635    * @return true if at least one ShowUnconserved has been added
1636    */
1637   public boolean hasShowUnconserved()
1638   {
1639     return this._has_showUnconserved;
1640   }
1641
1642   /**
1643    * Method hasStartRes.
1644    *
1645    * @return true if at least one StartRes has been added
1646    */
1647   public boolean hasStartRes()
1648   {
1649     return this._has_startRes;
1650   }
1651
1652   /**
1653    * Method hasStartSeq.
1654    *
1655    * @return true if at least one StartSeq has been added
1656    */
1657   public boolean hasStartSeq()
1658   {
1659     return this._has_startSeq;
1660   }
1661
1662   /**
1663    * Method hasTextCol1.
1664    *
1665    * @return true if at least one TextCol1 has been added
1666    */
1667   public boolean hasTextCol1()
1668   {
1669     return this._has_textCol1;
1670   }
1671
1672   /**
1673    * Method hasTextCol2.
1674    *
1675    * @return true if at least one TextCol2 has been added
1676    */
1677   public boolean hasTextCol2()
1678   {
1679     return this._has_textCol2;
1680   }
1681
1682   /**
1683    * Method hasTextColThreshold.
1684    *
1685    * @return true if at least one TextColThreshold has been added
1686    */
1687   public boolean hasTextColThreshold()
1688   {
1689     return this._has_textColThreshold;
1690   }
1691
1692   /**
1693    * Method hasWidth.
1694    *
1695    * @return true if at least one Width has been added
1696    */
1697   public boolean hasWidth()
1698   {
1699     return this._has_width;
1700   }
1701
1702   /**
1703    * Method hasWrapAlignment.
1704    *
1705    * @return true if at least one WrapAlignment has been added
1706    */
1707   public boolean hasWrapAlignment()
1708   {
1709     return this._has_wrapAlignment;
1710   }
1711
1712   /**
1713    * Method hasXpos.
1714    *
1715    * @return true if at least one Xpos has been added
1716    */
1717   public boolean hasXpos()
1718   {
1719     return this._has_xpos;
1720   }
1721
1722   /**
1723    * Method hasYpos.
1724    *
1725    * @return true if at least one Ypos has been added
1726    */
1727   public boolean hasYpos()
1728   {
1729     return this._has_ypos;
1730   }
1731
1732   /**
1733    * Returns the value of field 'centreColumnLabels'.
1734    *
1735    * @return the value of field 'CentreColumnLabels'.
1736    */
1737   public boolean isCentreColumnLabels()
1738   {
1739     return this._centreColumnLabels;
1740   }
1741
1742   /**
1743    * Returns the value of field 'conservationSelected'.
1744    *
1745    * @return the value of field 'ConservationSelected'.
1746    */
1747   public boolean isConservationSelected()
1748   {
1749     return this._conservationSelected;
1750   }
1751
1752   /**
1753    * Returns the value of field 'followHighlight'.
1754    *
1755    * @return the value of field 'FollowHighlight'.
1756    */
1757   public boolean isFollowHighlight()
1758   {
1759     return this._followHighlight;
1760   }
1761
1762   /**
1763    * Returns the value of field 'followSelection'.
1764    *
1765    * @return the value of field 'FollowSelection'.
1766    */
1767   public boolean isFollowSelection()
1768   {
1769     return this._followSelection;
1770   }
1771
1772   /**
1773    * Returns the value of field 'gatheredViews'.
1774    *
1775    * @return the value of field 'GatheredViews'.
1776    */
1777   public boolean isGatheredViews()
1778   {
1779     return this._gatheredViews;
1780   }
1781
1782   /**
1783    * Returns the value of field 'ignoreGapsinConsensus'.
1784    *
1785    * @return the value of field 'IgnoreGapsinConsensus'.
1786    */
1787   public boolean isIgnoreGapsinConsensus()
1788   {
1789     return this._ignoreGapsinConsensus;
1790   }
1791
1792   /**
1793    * Returns the value of field 'normaliseSequenceLogo'.
1794    *
1795    * @return the value of field 'NormaliseSequenceLogo'.
1796    */
1797   public boolean isNormaliseSequenceLogo()
1798   {
1799     return this._normaliseSequenceLogo;
1800   }
1801
1802   /**
1803    * Returns the value of field 'pidSelected'.
1804    *
1805    * @return the value of field 'PidSelected'.
1806    */
1807   public boolean isPidSelected()
1808   {
1809     return this._pidSelected;
1810   }
1811
1812   /**
1813    * Returns the value of field 'renderGaps'.
1814    *
1815    * @return the value of field 'RenderGaps'.
1816    */
1817   public boolean isRenderGaps()
1818   {
1819     return this._renderGaps;
1820   }
1821
1822   /**
1823    * Returns the value of field 'rightAlignIds'.
1824    *
1825    * @return the value of field 'RightAlignIds'.
1826    */
1827   public boolean isRightAlignIds()
1828   {
1829     return this._rightAlignIds;
1830   }
1831
1832   /**
1833    * Returns the value of field 'showAnnotation'.
1834    *
1835    * @return the value of field 'ShowAnnotation'.
1836    */
1837   public boolean isShowAnnotation()
1838   {
1839     return this._showAnnotation;
1840   }
1841
1842   /**
1843    * Returns the value of field 'showBoxes'.
1844    *
1845    * @return the value of field 'ShowBoxes'.
1846    */
1847   public boolean isShowBoxes()
1848   {
1849     return this._showBoxes;
1850   }
1851
1852   /**
1853    * Returns the value of field 'showColourText'.
1854    *
1855    * @return the value of field 'ShowColourText'.
1856    */
1857   public boolean isShowColourText()
1858   {
1859     return this._showColourText;
1860   }
1861
1862   /**
1863    * Returns the value of field 'showConsensusHistogram'.
1864    *
1865    * @return the value of field 'ShowConsensusHistogram'.
1866    */
1867   public boolean isShowConsensusHistogram()
1868   {
1869     return this._showConsensusHistogram;
1870   }
1871
1872   /**
1873    * Returns the value of field 'showDbRefTooltip'.
1874    *
1875    * @return the value of field 'ShowDbRefTooltip'.
1876    */
1877   public boolean isShowDbRefTooltip()
1878   {
1879     return this._showDbRefTooltip;
1880   }
1881
1882   /**
1883    * Returns the value of field 'showFullId'.
1884    *
1885    * @return the value of field 'ShowFullId'.
1886    */
1887   public boolean isShowFullId()
1888   {
1889     return this._showFullId;
1890   }
1891
1892   /**
1893    * Returns the value of field 'showGroupConsensus'.
1894    *
1895    * @return the value of field 'ShowGroupConsensus'.
1896    */
1897   public boolean isShowGroupConsensus()
1898   {
1899     return this._showGroupConsensus;
1900   }
1901
1902   /**
1903    * Returns the value of field 'showGroupConservation'.
1904    *
1905    * @return the value of field 'ShowGroupConservation'.
1906    */
1907   public boolean isShowGroupConservation()
1908   {
1909     return this._showGroupConservation;
1910   }
1911
1912   /**
1913    * Returns the value of field 'showNPfeatureTooltip'.
1914    *
1915    * @return the value of field 'ShowNPfeatureTooltip'.
1916    */
1917   public boolean isShowNPfeatureTooltip()
1918   {
1919     return this._showNPfeatureTooltip;
1920   }
1921
1922   /**
1923    * Returns the value of field 'showSequenceFeatures'.
1924    *
1925    * @return the value of field 'ShowSequenceFeatures'.
1926    */
1927   public boolean isShowSequenceFeatures()
1928   {
1929     return this._showSequenceFeatures;
1930   }
1931
1932   /**
1933    * Returns the value of field 'showSequenceLogo'.
1934    *
1935    * @return the value of field 'ShowSequenceLogo'.
1936    */
1937   public boolean isShowSequenceLogo()
1938   {
1939     return this._showSequenceLogo;
1940   }
1941
1942   /**
1943    * Returns the value of field 'showText'.
1944    *
1945    * @return the value of field 'ShowText'.
1946    */
1947   public boolean isShowText()
1948   {
1949     return this._showText;
1950   }
1951
1952   /**
1953    * Returns the value of field 'showUnconserved'.
1954    *
1955    * @return the value of field 'ShowUnconserved'.
1956    */
1957   public boolean isShowUnconserved()
1958   {
1959     return this._showUnconserved;
1960   }
1961
1962   /**
1963    * Method isValid.
1964    *
1965    * @return true if this object is valid according to the schema
1966    */
1967   public boolean isValid()
1968   {
1969     try
1970     {
1971       validate();
1972     } catch (org.exolab.castor.xml.ValidationException vex)
1973     {
1974       return false;
1975     }
1976     return true;
1977   }
1978
1979   /**
1980    * Returns the value of field 'wrapAlignment'.
1981    *
1982    * @return the value of field 'WrapAlignment'.
1983    */
1984   public boolean isWrapAlignment()
1985   {
1986     return this._wrapAlignment;
1987   }
1988
1989   /**
1990    *
1991    *
1992    * @param out
1993    * @throws org.exolab.castor.xml.MarshalException
1994    *           if object is null or if any SAXException is thrown during
1995    *           marshaling
1996    * @throws org.exolab.castor.xml.ValidationException
1997    *           if this object is an invalid instance according to the schema
1998    */
1999   public void marshal(final java.io.Writer out)
2000           throws org.exolab.castor.xml.MarshalException,
2001           org.exolab.castor.xml.ValidationException
2002   {
2003     Marshaller.marshal(this, out);
2004   }
2005
2006   /**
2007    *
2008    *
2009    * @param handler
2010    * @throws java.io.IOException
2011    *           if an IOException occurs during marshaling
2012    * @throws org.exolab.castor.xml.ValidationException
2013    *           if this object is an invalid instance according to the schema
2014    * @throws org.exolab.castor.xml.MarshalException
2015    *           if object is null or if any SAXException is thrown during
2016    *           marshaling
2017    */
2018   public void marshal(final org.xml.sax.ContentHandler handler)
2019           throws java.io.IOException,
2020           org.exolab.castor.xml.MarshalException,
2021           org.exolab.castor.xml.ValidationException
2022   {
2023     Marshaller.marshal(this, handler);
2024   }
2025
2026   /**
2027      */
2028   public void removeAllCalcIdParam()
2029   {
2030     this._calcIdParamList.clear();
2031   }
2032
2033   /**
2034      */
2035   public void removeAllHiddenColumns()
2036   {
2037     this._hiddenColumnsList.clear();
2038   }
2039
2040   /**
2041    * Method removeCalcIdParam.
2042    *
2043    * @param vCalcIdParam
2044    * @return true if the object was removed from the collection.
2045    */
2046   public boolean removeCalcIdParam(
2047           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
2048   {
2049     boolean removed = _calcIdParamList.remove(vCalcIdParam);
2050     return removed;
2051   }
2052
2053   /**
2054    * Method removeCalcIdParamAt.
2055    *
2056    * @param index
2057    * @return the element removed from the collection
2058    */
2059   public jalview.schemabinding.version2.CalcIdParam removeCalcIdParamAt(
2060           final int index)
2061   {
2062     java.lang.Object obj = this._calcIdParamList.remove(index);
2063     return (jalview.schemabinding.version2.CalcIdParam) obj;
2064   }
2065
2066   /**
2067    * Method removeHiddenColumns.
2068    *
2069    * @param vHiddenColumns
2070    * @return true if the object was removed from the collection.
2071    */
2072   public boolean removeHiddenColumns(
2073           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
2074   {
2075     boolean removed = _hiddenColumnsList.remove(vHiddenColumns);
2076     return removed;
2077   }
2078
2079   /**
2080    * Method removeHiddenColumnsAt.
2081    *
2082    * @param index
2083    * @return the element removed from the collection
2084    */
2085   public jalview.schemabinding.version2.HiddenColumns removeHiddenColumnsAt(
2086           final int index)
2087   {
2088     java.lang.Object obj = this._hiddenColumnsList.remove(index);
2089     return (jalview.schemabinding.version2.HiddenColumns) obj;
2090   }
2091
2092   /**
2093    * Sets the value of field 'annotationColours'.
2094    *
2095    * @param annotationColours
2096    *          the value of field 'annotationColours'.
2097    */
2098   public void setAnnotationColours(
2099           final jalview.schemabinding.version2.AnnotationColours annotationColours)
2100   {
2101     this._annotationColours = annotationColours;
2102   }
2103
2104   /**
2105    * Sets the value of field 'bgColour'.
2106    *
2107    * @param bgColour
2108    *          the value of field 'bgColour'.
2109    */
2110   public void setBgColour(final java.lang.String bgColour)
2111   {
2112     this._bgColour = bgColour;
2113   }
2114
2115   /**
2116    *
2117    *
2118    * @param index
2119    * @param vCalcIdParam
2120    * @throws java.lang.IndexOutOfBoundsException
2121    *           if the index given is outside the bounds of the collection
2122    */
2123   public void setCalcIdParam(final int index,
2124           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
2125           throws java.lang.IndexOutOfBoundsException
2126   {
2127     // check bounds for index
2128     if (index < 0 || index >= this._calcIdParamList.size())
2129     {
2130       throw new IndexOutOfBoundsException("setCalcIdParam: Index value '"
2131               + index + "' not in range [0.."
2132               + (this._calcIdParamList.size() - 1) + "]");
2133     }
2134
2135     this._calcIdParamList.set(index, vCalcIdParam);
2136   }
2137
2138   /**
2139    *
2140    *
2141    * @param vCalcIdParamArray
2142    */
2143   public void setCalcIdParam(
2144           final jalview.schemabinding.version2.CalcIdParam[] vCalcIdParamArray)
2145   {
2146     // -- copy array
2147     _calcIdParamList.clear();
2148
2149     for (int i = 0; i < vCalcIdParamArray.length; i++)
2150     {
2151       this._calcIdParamList.add(vCalcIdParamArray[i]);
2152     }
2153   }
2154
2155   /**
2156    * Sets the value of field 'centreColumnLabels'.
2157    *
2158    * @param centreColumnLabels
2159    *          the value of field 'centreColumnLabels'.
2160    */
2161   public void setCentreColumnLabels(final boolean centreColumnLabels)
2162   {
2163     this._centreColumnLabels = centreColumnLabels;
2164     this._has_centreColumnLabels = true;
2165   }
2166
2167   /**
2168    * Sets the value of field 'consThreshold'.
2169    *
2170    * @param consThreshold
2171    *          the value of field 'consThreshold'.
2172    */
2173   public void setConsThreshold(final int consThreshold)
2174   {
2175     this._consThreshold = consThreshold;
2176     this._has_consThreshold = true;
2177   }
2178
2179   /**
2180    * Sets the value of field 'conservationSelected'.
2181    *
2182    * @param conservationSelected
2183    *          the value of field 'conservationSelected'.
2184    */
2185   public void setConservationSelected(final boolean conservationSelected)
2186   {
2187     this._conservationSelected = conservationSelected;
2188     this._has_conservationSelected = true;
2189   }
2190
2191   /**
2192    * Sets the value of field 'followHighlight'.
2193    *
2194    * @param followHighlight
2195    *          the value of field 'followHighlight'.
2196    */
2197   public void setFollowHighlight(final boolean followHighlight)
2198   {
2199     this._followHighlight = followHighlight;
2200     this._has_followHighlight = true;
2201   }
2202
2203   /**
2204    * Sets the value of field 'followSelection'.
2205    *
2206    * @param followSelection
2207    *          the value of field 'followSelection'.
2208    */
2209   public void setFollowSelection(final boolean followSelection)
2210   {
2211     this._followSelection = followSelection;
2212     this._has_followSelection = true;
2213   }
2214
2215   /**
2216    * Sets the value of field 'fontName'.
2217    *
2218    * @param fontName
2219    *          the value of field 'fontName'.
2220    */
2221   public void setFontName(final java.lang.String fontName)
2222   {
2223     this._fontName = fontName;
2224   }
2225
2226   /**
2227    * Sets the value of field 'fontSize'.
2228    *
2229    * @param fontSize
2230    *          the value of field 'fontSize'.
2231    */
2232   public void setFontSize(final int fontSize)
2233   {
2234     this._fontSize = fontSize;
2235     this._has_fontSize = true;
2236   }
2237
2238   /**
2239    * Sets the value of field 'fontStyle'.
2240    *
2241    * @param fontStyle
2242    *          the value of field 'fontStyle'.
2243    */
2244   public void setFontStyle(final int fontStyle)
2245   {
2246     this._fontStyle = fontStyle;
2247     this._has_fontStyle = true;
2248   }
2249
2250   /**
2251    * Sets the value of field 'gatheredViews'.
2252    *
2253    * @param gatheredViews
2254    *          the value of field 'gatheredViews'.
2255    */
2256   public void setGatheredViews(final boolean gatheredViews)
2257   {
2258     this._gatheredViews = gatheredViews;
2259     this._has_gatheredViews = true;
2260   }
2261
2262   /**
2263    * Sets the value of field 'height'.
2264    *
2265    * @param height
2266    *          the value of field 'height'.
2267    */
2268   public void setHeight(final int height)
2269   {
2270     this._height = height;
2271     this._has_height = true;
2272   }
2273
2274   /**
2275    *
2276    *
2277    * @param index
2278    * @param vHiddenColumns
2279    * @throws java.lang.IndexOutOfBoundsException
2280    *           if the index given is outside the bounds of the collection
2281    */
2282   public void setHiddenColumns(final int index,
2283           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
2284           throws java.lang.IndexOutOfBoundsException
2285   {
2286     // check bounds for index
2287     if (index < 0 || index >= this._hiddenColumnsList.size())
2288     {
2289       throw new IndexOutOfBoundsException("setHiddenColumns: Index value '"
2290               + index + "' not in range [0.."
2291               + (this._hiddenColumnsList.size() - 1) + "]");
2292     }
2293
2294     this._hiddenColumnsList.set(index, vHiddenColumns);
2295   }
2296
2297   /**
2298    *
2299    *
2300    * @param vHiddenColumnsArray
2301    */
2302   public void setHiddenColumns(
2303           final jalview.schemabinding.version2.HiddenColumns[] vHiddenColumnsArray)
2304   {
2305     // -- copy array
2306     _hiddenColumnsList.clear();
2307
2308     for (int i = 0; i < vHiddenColumnsArray.length; i++)
2309     {
2310       this._hiddenColumnsList.add(vHiddenColumnsArray[i]);
2311     }
2312   }
2313
2314   /**
2315    * Sets the value of field 'id'. The field 'id' has the following description:
2316    * unique id used by jalview to synchronize between stored and instantiated
2317    * views
2318    *
2319    *
2320    * @param id
2321    *          the value of field 'id'.
2322    */
2323   public void setId(final java.lang.String id)
2324   {
2325     this._id = id;
2326   }
2327
2328   /**
2329    * Sets the value of field 'ignoreGapsinConsensus'.
2330    *
2331    * @param ignoreGapsinConsensus
2332    *          the value of field 'ignoreGapsinConsensus'.
2333    */
2334   public void setIgnoreGapsinConsensus(final boolean ignoreGapsinConsensus)
2335   {
2336     this._ignoreGapsinConsensus = ignoreGapsinConsensus;
2337     this._has_ignoreGapsinConsensus = true;
2338   }
2339
2340   /**
2341    * Sets the value of field 'normaliseSequenceLogo'.
2342    *
2343    * @param normaliseSequenceLogo
2344    *          the value of field 'normaliseSequenceLogo'.
2345    */
2346   public void setNormaliseSequenceLogo(final boolean normaliseSequenceLogo)
2347   {
2348     this._normaliseSequenceLogo = normaliseSequenceLogo;
2349     this._has_normaliseSequenceLogo = true;
2350   }
2351
2352   /**
2353    * Sets the value of field 'pidSelected'.
2354    *
2355    * @param pidSelected
2356    *          the value of field 'pidSelected'.
2357    */
2358   public void setPidSelected(final boolean pidSelected)
2359   {
2360     this._pidSelected = pidSelected;
2361     this._has_pidSelected = true;
2362   }
2363
2364   /**
2365    * Sets the value of field 'pidThreshold'.
2366    *
2367    * @param pidThreshold
2368    *          the value of field 'pidThreshold'.
2369    */
2370   public void setPidThreshold(final int pidThreshold)
2371   {
2372     this._pidThreshold = pidThreshold;
2373     this._has_pidThreshold = true;
2374   }
2375
2376   /**
2377    * Sets the value of field 'renderGaps'.
2378    *
2379    * @param renderGaps
2380    *          the value of field 'renderGaps'.
2381    */
2382   public void setRenderGaps(final boolean renderGaps)
2383   {
2384     this._renderGaps = renderGaps;
2385     this._has_renderGaps = true;
2386   }
2387
2388   /**
2389    * Sets the value of field 'rightAlignIds'.
2390    *
2391    * @param rightAlignIds
2392    *          the value of field 'rightAlignIds'.
2393    */
2394   public void setRightAlignIds(final boolean rightAlignIds)
2395   {
2396     this._rightAlignIds = rightAlignIds;
2397     this._has_rightAlignIds = true;
2398   }
2399
2400   /**
2401    * Sets the value of field 'sequenceSetId'.
2402    *
2403    * @param sequenceSetId
2404    *          the value of field 'sequenceSetId'.
2405    */
2406   public void setSequenceSetId(final java.lang.String sequenceSetId)
2407   {
2408     this._sequenceSetId = sequenceSetId;
2409   }
2410
2411   /**
2412    * Sets the value of field 'showAnnotation'.
2413    *
2414    * @param showAnnotation
2415    *          the value of field 'showAnnotation'.
2416    */
2417   public void setShowAnnotation(final boolean showAnnotation)
2418   {
2419     this._showAnnotation = showAnnotation;
2420     this._has_showAnnotation = true;
2421   }
2422
2423   /**
2424    * Sets the value of field 'showBoxes'.
2425    *
2426    * @param showBoxes
2427    *          the value of field 'showBoxes'.
2428    */
2429   public void setShowBoxes(final boolean showBoxes)
2430   {
2431     this._showBoxes = showBoxes;
2432     this._has_showBoxes = true;
2433   }
2434
2435   /**
2436    * Sets the value of field 'showColourText'.
2437    *
2438    * @param showColourText
2439    *          the value of field 'showColourText'.
2440    */
2441   public void setShowColourText(final boolean showColourText)
2442   {
2443     this._showColourText = showColourText;
2444     this._has_showColourText = true;
2445   }
2446
2447   /**
2448    * Sets the value of field 'showConsensusHistogram'.
2449    *
2450    * @param showConsensusHistogram
2451    *          the value of field 'showConsensusHistogram'.
2452    */
2453   public void setShowConsensusHistogram(final boolean showConsensusHistogram)
2454   {
2455     this._showConsensusHistogram = showConsensusHistogram;
2456     this._has_showConsensusHistogram = true;
2457   }
2458
2459   /**
2460    * Sets the value of field 'showDbRefTooltip'.
2461    *
2462    * @param showDbRefTooltip
2463    *          the value of field 'showDbRefTooltip'
2464    */
2465   public void setShowDbRefTooltip(final boolean showDbRefTooltip)
2466   {
2467     this._showDbRefTooltip = showDbRefTooltip;
2468     this._has_showDbRefTooltip = true;
2469   }
2470
2471   /**
2472    * Sets the value of field 'showFullId'.
2473    *
2474    * @param showFullId
2475    *          the value of field 'showFullId'.
2476    */
2477   public void setShowFullId(final boolean showFullId)
2478   {
2479     this._showFullId = showFullId;
2480     this._has_showFullId = true;
2481   }
2482
2483   /**
2484    * Sets the value of field 'showGroupConsensus'.
2485    *
2486    * @param showGroupConsensus
2487    *          the value of field 'showGroupConsensus'.
2488    */
2489   public void setShowGroupConsensus(final boolean showGroupConsensus)
2490   {
2491     this._showGroupConsensus = showGroupConsensus;
2492     this._has_showGroupConsensus = true;
2493   }
2494
2495   /**
2496    * Sets the value of field 'showGroupConservation'.
2497    *
2498    * @param showGroupConservation
2499    *          the value of field 'showGroupConservation'.
2500    */
2501   public void setShowGroupConservation(final boolean showGroupConservation)
2502   {
2503     this._showGroupConservation = showGroupConservation;
2504     this._has_showGroupConservation = true;
2505   }
2506
2507   /**
2508    * Sets the value of field 'showNPfeatureTooltip'.
2509    *
2510    * @param showNPfeatureTooltip
2511    *          the value of field 'showNPfeatureTooltip'.
2512    */
2513   public void setShowNPfeatureTooltip(final boolean showNPfeatureTooltip)
2514   {
2515     this._showNPfeatureTooltip = showNPfeatureTooltip;
2516     this._has_showNPfeatureTooltip = true;
2517   }
2518
2519   /**
2520    * Sets the value of field 'showSequenceFeatures'.
2521    *
2522    * @param showSequenceFeatures
2523    *          the value of field 'showSequenceFeatures'.
2524    */
2525   public void setShowSequenceFeatures(final boolean showSequenceFeatures)
2526   {
2527     this._showSequenceFeatures = showSequenceFeatures;
2528     this._has_showSequenceFeatures = true;
2529   }
2530
2531   /**
2532    * Sets the value of field 'showSequenceLogo'.
2533    *
2534    * @param showSequenceLogo
2535    *          the value of field 'showSequenceLogo'
2536    */
2537   public void setShowSequenceLogo(final boolean showSequenceLogo)
2538   {
2539     this._showSequenceLogo = showSequenceLogo;
2540     this._has_showSequenceLogo = true;
2541   }
2542
2543   /**
2544    * Sets the value of field 'showText'.
2545    *
2546    * @param showText
2547    *          the value of field 'showText'.
2548    */
2549   public void setShowText(final boolean showText)
2550   {
2551     this._showText = showText;
2552     this._has_showText = true;
2553   }
2554
2555   /**
2556    * Sets the value of field 'showUnconserved'.
2557    *
2558    * @param showUnconserved
2559    *          the value of field 'showUnconserved'.
2560    */
2561   public void setShowUnconserved(final boolean showUnconserved)
2562   {
2563     this._showUnconserved = showUnconserved;
2564     this._has_showUnconserved = true;
2565   }
2566
2567   /**
2568    * Sets the value of field 'startRes'.
2569    *
2570    * @param startRes
2571    *          the value of field 'startRes'.
2572    */
2573   public void setStartRes(final int startRes)
2574   {
2575     this._startRes = startRes;
2576     this._has_startRes = true;
2577   }
2578
2579   /**
2580    * Sets the value of field 'startSeq'.
2581    *
2582    * @param startSeq
2583    *          the value of field 'startSeq'.
2584    */
2585   public void setStartSeq(final int startSeq)
2586   {
2587     this._startSeq = startSeq;
2588     this._has_startSeq = true;
2589   }
2590
2591   /**
2592    * Sets the value of field 'textCol1'.
2593    *
2594    * @param textCol1
2595    *          the value of field 'textCol1'.
2596    */
2597   public void setTextCol1(final int textCol1)
2598   {
2599     this._textCol1 = textCol1;
2600     this._has_textCol1 = true;
2601   }
2602
2603   /**
2604    * Sets the value of field 'textCol2'.
2605    *
2606    * @param textCol2
2607    *          the value of field 'textCol2'.
2608    */
2609   public void setTextCol2(final int textCol2)
2610   {
2611     this._textCol2 = textCol2;
2612     this._has_textCol2 = true;
2613   }
2614
2615   /**
2616    * Sets the value of field 'textColThreshold'.
2617    *
2618    * @param textColThreshold
2619    *          the value of field 'textColThreshold'
2620    */
2621   public void setTextColThreshold(final int textColThreshold)
2622   {
2623     this._textColThreshold = textColThreshold;
2624     this._has_textColThreshold = true;
2625   }
2626
2627   /**
2628    * Sets the value of field 'title'.
2629    *
2630    * @param title
2631    *          the value of field 'title'.
2632    */
2633   public void setTitle(final java.lang.String title)
2634   {
2635     this._title = title;
2636   }
2637
2638   /**
2639    * Sets the value of field 'viewName'.
2640    *
2641    * @param viewName
2642    *          the value of field 'viewName'.
2643    */
2644   public void setViewName(final java.lang.String viewName)
2645   {
2646     this._viewName = viewName;
2647   }
2648
2649   /**
2650    * Sets the value of field 'width'.
2651    *
2652    * @param width
2653    *          the value of field 'width'.
2654    */
2655   public void setWidth(final int width)
2656   {
2657     this._width = width;
2658     this._has_width = true;
2659   }
2660
2661   /**
2662    * Sets the value of field 'wrapAlignment'.
2663    *
2664    * @param wrapAlignment
2665    *          the value of field 'wrapAlignment'.
2666    */
2667   public void setWrapAlignment(final boolean wrapAlignment)
2668   {
2669     this._wrapAlignment = wrapAlignment;
2670     this._has_wrapAlignment = true;
2671   }
2672
2673   /**
2674    * Sets the value of field 'xpos'.
2675    *
2676    * @param xpos
2677    *          the value of field 'xpos'.
2678    */
2679   public void setXpos(final int xpos)
2680   {
2681     this._xpos = xpos;
2682     this._has_xpos = true;
2683   }
2684
2685   /**
2686    * Sets the value of field 'ypos'.
2687    *
2688    * @param ypos
2689    *          the value of field 'ypos'.
2690    */
2691   public void setYpos(final int ypos)
2692   {
2693     this._ypos = ypos;
2694     this._has_ypos = true;
2695   }
2696
2697   /**
2698    * Method unmarshal.
2699    *
2700    * @param reader
2701    * @throws org.exolab.castor.xml.MarshalException
2702    *           if object is null or if any SAXException is thrown during
2703    *           marshaling
2704    * @throws org.exolab.castor.xml.ValidationException
2705    *           if this object is an invalid instance according to the schema
2706    * @return the unmarshaled jalview.schemabinding.version2.Viewport
2707    */
2708   public static jalview.schemabinding.version2.Viewport unmarshal(
2709           final java.io.Reader reader)
2710           throws org.exolab.castor.xml.MarshalException,
2711           org.exolab.castor.xml.ValidationException
2712   {
2713     return (jalview.schemabinding.version2.Viewport) Unmarshaller
2714             .unmarshal(jalview.schemabinding.version2.Viewport.class,
2715                     reader);
2716   }
2717
2718   /**
2719    *
2720    *
2721    * @throws org.exolab.castor.xml.ValidationException
2722    *           if this object is an invalid instance according to the schema
2723    */
2724   public void validate() throws org.exolab.castor.xml.ValidationException
2725   {
2726     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
2727     validator.validate(this);
2728   }
2729
2730 }