src/jalview/schemabinding/version2/Viewport.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.schemabinding.version2;
  22
  23 //---------------------------------/
  24 //- Imported classes and packages -/
  25 //---------------------------------/
  26
  27 import jalview.util.MessageManager;
  28
  29 import org.exolab.castor.xml.Marshaller;
  30 import org.exolab.castor.xml.Unmarshaller;
  31
  32 /**
  33  * Class Viewport.
  34  *
  35  * @version $Revision$ $Date$
  36  */
  37 public class Viewport implements java.io.Serializable
  38 {
  39
  40   // --------------------------/
  41   // - Class/Member Variables -/
  42   // --------------------------/
  43
  44   /**
  45    * Field _conservationSelected.
  46    */
  47   private boolean _conservationSelected;
  48
  49   /**
  50    * keeps track of state for field: _conservationSelected
  51    */
  52   private boolean _has_conservationSelected;
  53
  54   /**
  55    * Field _pidSelected.
  56    */
  57   private boolean _pidSelected;
  58
  59   /**
  60    * keeps track of state for field: _pidSelected
  61    */
  62   private boolean _has_pidSelected;
  63
  64   /**
  65    * Field _bgColour.
  66    */
  67   private java.lang.String _bgColour;
  68
  69   /**
  70    * Field _consThreshold.
  71    */
  72   private int _consThreshold;
  73
  74   /**
  75    * keeps track of state for field: _consThreshold
  76    */
  77   private boolean _has_consThreshold;
  78
  79   /**
  80    * Field _pidThreshold.
  81    */
  82   private int _pidThreshold;
  83
  84   /**
  85    * keeps track of state for field: _pidThreshold
  86    */
  87   private boolean _has_pidThreshold;
  88
  89   /**
  90    * Field _title.
  91    */
  92   private java.lang.String _title;
  93
  94   /**
  95    * Field _showFullId.
  96    */
  97   private boolean _showFullId;
  98
  99   /**
 100    * keeps track of state for field: _showFullId
 101    */
 102   private boolean _has_showFullId;
 103
 104   /**
 105    * Field _rightAlignIds.
 106    */
 107   private boolean _rightAlignIds;
 108
 109   /**
 110    * keeps track of state for field: _rightAlignIds
 111    */
 112   private boolean _has_rightAlignIds;
 113
 114   /**
 115    * Field _showText.
 116    */
 117   private boolean _showText;
 118
 119   /**
 120    * keeps track of state for field: _showText
 121    */
 122   private boolean _has_showText;
 123
 124   /**
 125    * Field _showColourText.
 126    */
 127   private boolean _showColourText;
 128
 129   /**
 130    * keeps track of state for field: _showColourText
 131    */
 132   private boolean _has_showColourText;
 133
 134   /**
 135    * Field _showUnconserved.
 136    */
 137   private boolean _showUnconserved = false;
 138
 139   /**
 140    * keeps track of state for field: _showUnconserved
 141    */
 142   private boolean _has_showUnconserved;
 143
 144   /**
 145    * Field _showBoxes.
 146    */
 147   private boolean _showBoxes;
 148
 149   /**
 150    * keeps track of state for field: _showBoxes
 151    */
 152   private boolean _has_showBoxes;
 153
 154   /**
 155    * Field _wrapAlignment.
 156    */
 157   private boolean _wrapAlignment;
 158
 159   /**
 160    * keeps track of state for field: _wrapAlignment
 161    */
 162   private boolean _has_wrapAlignment;
 163
 164   /**
 165    * Field _renderGaps.
 166    */
 167   private boolean _renderGaps;
 168
 169   /**
 170    * keeps track of state for field: _renderGaps
 171    */
 172   private boolean _has_renderGaps;
 173
 174   /**
 175    * Field _showSequenceFeatures.
 176    */
 177   private boolean _showSequenceFeatures;
 178
 179   /**
 180    * keeps track of state for field: _showSequenceFeatures
 181    */
 182   private boolean _has_showSequenceFeatures;
 183
 184   /**
 185    * Field _showNPfeatureTooltip.
 186    */
 187   private boolean _showNPfeatureTooltip;
 188
 189   /**
 190    * keeps track of state for field: _showNPfeatureTooltip
 191    */
 192   private boolean _has_showNPfeatureTooltip;
 193
 194   /**
 195    * Field _showDbRefTooltip.
 196    */
 197   private boolean _showDbRefTooltip;
 198
 199   /**
 200    * keeps track of state for field: _showDbRefTooltip
 201    */
 202   private boolean _has_showDbRefTooltip;
 203
 204   /**
 205    * Field _followHighlight.
 206    */
 207   private boolean _followHighlight = true;
 208
 209   /**
 210    * keeps track of state for field: _followHighlight
 211    */
 212   private boolean _has_followHighlight;
 213
 214   /**
 215    * Field _followSelection.
 216    */
 217   private boolean _followSelection = true;
 218
 219   /**
 220    * keeps track of state for field: _followSelection
 221    */
 222   private boolean _has_followSelection;
 223
 224   /**
 225    * Field _showAnnotation.
 226    */
 227   private boolean _showAnnotation;
 228
 229   /**
 230    * keeps track of state for field: _showAnnotation
 231    */
 232   private boolean _has_showAnnotation;
 233
 234   /**
 235    * Field _centreColumnLabels.
 236    */
 237   private boolean _centreColumnLabels = false;
 238
 239   /**
 240    * keeps track of state for field: _centreColumnLabels
 241    */
 242   private boolean _has_centreColumnLabels;
 243
 244   /**
 245    * Field _showGroupConservation.
 246    */
 247   private boolean _showGroupConservation = false;
 248
 249   /**
 250    * keeps track of state for field: _showGroupConservation
 251    */
 252   private boolean _has_showGroupConservation;
 253
 254   /**
 255    * Field _showGroupConsensus.
 256    */
 257   private boolean _showGroupConsensus = false;
 258
 259   /**
 260    * keeps track of state for field: _showGroupConsensus
 261    */
 262   private boolean _has_showGroupConsensus;
 263
 264   /**
 265    * Field _showConsensusHistogram.
 266    */
 267   private boolean _showConsensusHistogram = true;
 268
 269   /**
 270    * keeps track of state for field: _showConsensusHistogram
 271    */
 272   private boolean _has_showConsensusHistogram;
 273
 274   /**
 275    * Field _showSequenceLogo.
 276    */
 277   private boolean _showSequenceLogo = false;
 278
 279   /**
 280    * keeps track of state for field: _showSequenceLogo
 281    */
 282   private boolean _has_showSequenceLogo;
 283
 284   /**
 285    * Field _normaliseSequenceLogo.
 286    */
 287   private boolean _normaliseSequenceLogo = false;
 288
 289   /**
 290    * keeps track of state for field: _normaliseSequenceLogo
 291    */
 292   private boolean _has_normaliseSequenceLogo;
 293
 294   /**
 295    * Field _ignoreGapsinConsensus.
 296    */
 297   private boolean _ignoreGapsinConsensus = true;
 298
 299   /**
 300    * keeps track of state for field: _ignoreGapsinConsensus
 301    */
 302   private boolean _has_ignoreGapsinConsensus;
 303
 304   /**
 305    * Field _startRes.
 306    */
 307   private int _startRes;
 308
 309   /**
 310    * keeps track of state for field: _startRes
 311    */
 312   private boolean _has_startRes;
 313
 314   /**
 315    * Field _startSeq.
 316    */
 317   private int _startSeq;
 318
 319   /**
 320    * keeps track of state for field: _startSeq
 321    */
 322   private boolean _has_startSeq;
 323
 324   /**
 325    * Field _fontName.
 326    */
 327   private java.lang.String _fontName;
 328
 329   /**
 330    * Field _fontSize.
 331    */
 332   private int _fontSize;
 333
 334   /**
 335    * keeps track of state for field: _fontSize
 336    */
 337   private boolean _has_fontSize;
 338
 339   /**
 340    * Field _fontStyle.
 341    */
 342   private int _fontStyle;
 343
 344   /**
 345    * keeps track of state for field: _fontStyle
 346    */
 347   private boolean _has_fontStyle;
 348
 349   /**
 350    * Field _viewName.
 351    */
 352   private java.lang.String _viewName;
 353
 354   /**
 355    * Field _sequenceSetId.
 356    */
 357   private java.lang.String _sequenceSetId;
 358
 359   /**
 360    * Field _gatheredViews.
 361    */
 362   private boolean _gatheredViews;
 363
 364   /**
 365    * keeps track of state for field: _gatheredViews
 366    */
 367   private boolean _has_gatheredViews;
 368
 369   /**
 370    * Field _textCol1.
 371    */
 372   private int _textCol1;
 373
 374   /**
 375    * keeps track of state for field: _textCol1
 376    */
 377   private boolean _has_textCol1;
 378
 379   /**
 380    * Field _textCol2.
 381    */
 382   private int _textCol2;
 383
 384   /**
 385    * keeps track of state for field: _textCol2
 386    */
 387   private boolean _has_textCol2;
 388
 389   /**
 390    * Field _textColThreshold.
 391    */
 392   private int _textColThreshold;
 393
 394   /**
 395    * keeps track of state for field: _textColThreshold
 396    */
 397   private boolean _has_textColThreshold;
 398
 399   /**
 400    * unique id used by jalview to synchronize between stored and instantiated
 401    * views
 402    *
 403    */
 404   private java.lang.String _id;
 405
 406   /**
 407    * Field _width.
 408    */
 409   private int _width;
 410
 411   /**
 412    * keeps track of state for field: _width
 413    */
 414   private boolean _has_width;
 415
 416   /**
 417    * Field _height.
 418    */
 419   private int _height;
 420
 421   /**
 422    * keeps track of state for field: _height
 423    */
 424   private boolean _has_height;
 425
 426   /**
 427    * Field _xpos.
 428    */
 429   private int _xpos;
 430
 431   /**
 432    * keeps track of state for field: _xpos
 433    */
 434   private boolean _has_xpos;
 435
 436   /**
 437    * Field _ypos.
 438    */
 439   private int _ypos;
 440
 441   /**
 442    * keeps track of state for field: _ypos
 443    */
 444   private boolean _has_ypos;
 445
 446   /**
 447    * Field _annotationColours.
 448    */
 449   private jalview.schemabinding.version2.AnnotationColours _annotationColours;
 450
 451   /**
 452    * Field _hiddenColumnsList.
 453    */
 454   private java.util.Vector _hiddenColumnsList;
 455
 456   /**
 457    * Field _calcIdParamList.
 458    */
 459   private java.util.Vector _calcIdParamList;
 460
 461   // ----------------/
 462   // - Constructors -/
 463   // ----------------/
 464
 465   public Viewport()
 466   {
 467     super();
 468     this._hiddenColumnsList = new java.util.Vector();
 469     this._calcIdParamList = new java.util.Vector();
 470   }
 471
 472   // -----------/
 473   // - Methods -/
 474   // -----------/
 475
 476   /**
 477    *
 478    *
 479    * @param vCalcIdParam
 480    * @throws java.lang.IndexOutOfBoundsException
 481    *           if the index given is outside the bounds of the collection
 482    */
 483   public void addCalcIdParam(
 484           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
 485           throws java.lang.IndexOutOfBoundsException
 486   {
 487     this._calcIdParamList.addElement(vCalcIdParam);
 488   }
 489
 490   /**
 491    *
 492    *
 493    * @param index
 494    * @param vCalcIdParam
 495    * @throws java.lang.IndexOutOfBoundsException
 496    *           if the index given is outside the bounds of the collection
 497    */
 498   public void addCalcIdParam(final int index,
 499           final jalview.schemabinding.version2.CalcIdParam vCalcIdParam)
 500           throws java.lang.IndexOutOfBoundsException
 501   {
 502     this._calcIdParamList.add(index, vCalcIdParam);
 503   }
 504
 505   /**
 506    *
 507    *
 508    * @param vHiddenColumns
 509    * @throws java.lang.IndexOutOfBoundsException
 510    *           if the index given is outside the bounds of the collection
 511    */
 512   public void addHiddenColumns(
 513           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
 514           throws java.lang.IndexOutOfBoundsException
 515   {
 516     this._hiddenColumnsList.addElement(vHiddenColumns);
 517   }
 518
 519   /**
 520    *
 521    *
 522    * @param index
 523    * @param vHiddenColumns
 524    * @throws java.lang.IndexOutOfBoundsException
 525    *           if the index given is outside the bounds of the collection
 526    */
 527   public void addHiddenColumns(final int index,
 528           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
 529           throws java.lang.IndexOutOfBoundsException
 530   {
 531     this._hiddenColumnsList.add(index, vHiddenColumns);
 532   }
 533
 534   /**
 535      */
 536   public void deleteCentreColumnLabels()
 537   {
 538     this._has_centreColumnLabels = false;
 539   }
 540
 541   /**
 542      */
 543   public void deleteConsThreshold()
 544   {
 545     this._has_consThreshold = false;
 546   }
 547
 548   /**
 549      */
 550   public void deleteConservationSelected()
 551   {
 552     this._has_conservationSelected = false;
 553   }
 554
 555   /**
 556      */
 557   public void deleteFollowHighlight()
 558   {
 559     this._has_followHighlight = false;
 560   }
 561
 562   /**
 563      */
 564   public void deleteFollowSelection()
 565   {
 566     this._has_followSelection = false;
 567   }
 568
 569   /**
 570      */
 571   public void deleteFontSize()
 572   {
 573     this._has_fontSize = false;
 574   }
 575
 576   /**
 577      */
 578   public void deleteFontStyle()
 579   {
 580     this._has_fontStyle = false;
 581   }
 582
 583   /**
 584      */
 585   public void deleteGatheredViews()
 586   {
 587     this._has_gatheredViews = false;
 588   }
 589
 590   /**
 591      */
 592   public void deleteHeight()
 593   {
 594     this._has_height = false;
 595   }
 596
 597   /**
 598      */
 599   public void deleteIgnoreGapsinConsensus()
 600   {
 601     this._has_ignoreGapsinConsensus = false;
 602   }
 603
 604   /**
 605      */
 606   public void deleteNormaliseSequenceLogo()
 607   {
 608     this._has_normaliseSequenceLogo = false;
 609   }
 610
 611   /**
 612      */
 613   public void deletePidSelected()
 614   {
 615     this._has_pidSelected = false;
 616   }
 617
 618   /**
 619      */
 620   public void deletePidThreshold()
 621   {
 622     this._has_pidThreshold = false;
 623   }
 624
 625   /**
 626      */
 627   public void deleteRenderGaps()
 628   {
 629     this._has_renderGaps = false;
 630   }
 631
 632   /**
 633      */
 634   public void deleteRightAlignIds()
 635   {
 636     this._has_rightAlignIds = false;
 637   }
 638
 639   /**
 640      */
 641   public void deleteShowAnnotation()
 642   {
 643     this._has_showAnnotation = false;
 644   }
 645
 646   /**
 647      */
 648   public void deleteShowBoxes()
 649   {
 650     this._has_showBoxes = false;
 651   }
 652
 653   /**
 654      */
 655   public void deleteShowColourText()
 656   {
 657     this._has_showColourText = false;
 658   }
 659
 660   /**
 661      */
 662   public void deleteShowConsensusHistogram()
 663   {
 664     this._has_showConsensusHistogram = false;
 665   }
 666
 667   /**
 668      */
 669   public void deleteShowDbRefTooltip()
 670   {
 671     this._has_showDbRefTooltip = false;
 672   }
 673
 674   /**
 675      */
 676   public void deleteShowFullId()
 677   {
 678     this._has_showFullId = false;
 679   }
 680
 681   /**
 682      */
 683   public void deleteShowGroupConsensus()
 684   {
 685     this._has_showGroupConsensus = false;
 686   }
 687
 688   /**
 689      */
 690   public void deleteShowGroupConservation()
 691   {
 692     this._has_showGroupConservation = false;
 693   }
 694
 695   /**
 696      */
 697   public void deleteShowNPfeatureTooltip()
 698   {
 699     this._has_showNPfeatureTooltip = false;
 700   }
 701
 702   /**
 703      */
 704   public void deleteShowSequenceFeatures()
 705   {
 706     this._has_showSequenceFeatures = false;
 707   }
 708
 709   /**
 710      */
 711   public void deleteShowSequenceLogo()
 712   {
 713     this._has_showSequenceLogo = false;
 714   }
 715
 716   /**
 717      */
 718   public void deleteShowText()
 719   {
 720     this._has_showText = false;
 721   }
 722
 723   /**
 724      */
 725   public void deleteShowUnconserved()
 726   {
 727     this._has_showUnconserved = false;
 728   }
 729
 730   /**
 731      */
 732   public void deleteStartRes()
 733   {
 734     this._has_startRes = false;
 735   }
 736
 737   /**
 738      */
 739   public void deleteStartSeq()
 740   {
 741     this._has_startSeq = false;
 742   }
 743
 744   /**
 745      */
 746   public void deleteTextCol1()
 747   {
 748     this._has_textCol1 = false;
 749   }
 750
 751   /**
 752      */
 753   public void deleteTextCol2()
 754   {
 755     this._has_textCol2 = false;
 756   }
 757
 758   /**
 759      */
 760   public void deleteTextColThreshold()
 761   {
 762     this._has_textColThreshold = false;
 763   }
 764
 765   /**
 766      */
 767   public void deleteWidth()
 768   {
 769     this._has_width = false;
 770   }
 771
 772   /**
 773      */
 774   public void deleteWrapAlignment()
 775   {
 776     this._has_wrapAlignment = false;
 777   }
 778
 779   /**
 780      */
 781   public void deleteXpos()
 782   {
 783     this._has_xpos = false;
 784   }
 785
 786   /**
 787      */
 788   public void deleteYpos()
 789   {
 790     this._has_ypos = false;
 791   }
 792
 793   /**
 794    * Method enumerateCalcIdParam.
 795    *
 796    * @return an Enumeration over all jalview.schemabinding.version2.CalcIdParam
 797    *         elements
 798    */
 799   public java.util.Enumeration enumerateCalcIdParam()
 800   {
 801     return this._calcIdParamList.elements();
 802   }
 803
 804   /**
 805    * Method enumerateHiddenColumns.
 806    *
 807    * @return an Enumeration over all
 808    *         jalview.schemabinding.version2.HiddenColumns elements
 809    */
 810   public java.util.Enumeration enumerateHiddenColumns()
 811   {
 812     return this._hiddenColumnsList.elements();
 813   }
 814
 815   /**
 816    * Returns the value of field 'annotationColours'.
 817    *
 818    * @return the value of field 'AnnotationColours'.
 819    */
 820   public jalview.schemabinding.version2.AnnotationColours getAnnotationColours()
 821   {
 822     return this._annotationColours;
 823   }
 824
 825   /**
 826    * Returns the value of field 'bgColour'.
 827    *
 828    * @return the value of field 'BgColour'.
 829    */
 830   public java.lang.String getBgColour()
 831   {
 832     return this._bgColour;
 833   }
 834
 835   /**
 836    * Method getCalcIdParam.
 837    *
 838    * @param index
 839    * @throws java.lang.IndexOutOfBoundsException
 840    *           if the index given is outside the bounds of the collection
 841    * @return the value of the jalview.schemabinding.version2.CalcIdParam at the
 842    *         given index
 843    */
 844   public jalview.schemabinding.version2.CalcIdParam getCalcIdParam(
 845           final int index) throws java.lang.IndexOutOfBoundsException
 846   {
 847     // check bounds for index
 848     if (index < 0 || index >= this._calcIdParamList.size())
 849     {
 850         throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
 851                           "getCalcIdParam",
 852                           Integer.valueOf(index).toString(),
 853                           Integer.valueOf((this._calcIdParamList.size() - 1)).toString()
 854           }));
 855     }
 856
 857     return (jalview.schemabinding.version2.CalcIdParam) _calcIdParamList
 858             .get(index);
 859   }
 860
 861   /**
 862    * Method getCalcIdParam.Returns the contents of the collection in an Array.
 863    * <p>
 864    * Note: Just in case the collection contents are changing in another thread,
 865    * we pass a 0-length Array of the correct type into the API call. This way we
 866    * <i>know</i> that the Array returned is of exactly the correct length.
 867    *
 868    * @return this collection as an Array
 869    */
 870   public jalview.schemabinding.version2.CalcIdParam[] getCalcIdParam()
 871   {
 872     jalview.schemabinding.version2.CalcIdParam[] array = new jalview.schemabinding.version2.CalcIdParam[0];
 873     return (jalview.schemabinding.version2.CalcIdParam[]) this._calcIdParamList
 874             .toArray(array);
 875   }
 876
 877   /**
 878    * Method getCalcIdParamCount.
 879    *
 880    * @return the size of this collection
 881    */
 882   public int getCalcIdParamCount()
 883   {
 884     return this._calcIdParamList.size();
 885   }
 886
 887   /**
 888    * Returns the value of field 'centreColumnLabels'.
 889    *
 890    * @return the value of field 'CentreColumnLabels'.
 891    */
 892   public boolean getCentreColumnLabels()
 893   {
 894     return this._centreColumnLabels;
 895   }
 896
 897   /**
 898    * Returns the value of field 'consThreshold'.
 899    *
 900    * @return the value of field 'ConsThreshold'.
 901    */
 902   public int getConsThreshold()
 903   {
 904     return this._consThreshold;
 905   }
 906
 907   /**
 908    * Returns the value of field 'conservationSelected'.
 909    *
 910    * @return the value of field 'ConservationSelected'.
 911    */
 912   public boolean getConservationSelected()
 913   {
 914     return this._conservationSelected;
 915   }
 916
 917   /**
 918    * Returns the value of field 'followHighlight'.
 919    *
 920    * @return the value of field 'FollowHighlight'.
 921    */
 922   public boolean getFollowHighlight()
 923   {
 924     return this._followHighlight;
 925   }
 926
 927   /**
 928    * Returns the value of field 'followSelection'.
 929    *
 930    * @return the value of field 'FollowSelection'.
 931    */
 932   public boolean getFollowSelection()
 933   {
 934     return this._followSelection;
 935   }
 936
 937   /**
 938    * Returns the value of field 'fontName'.
 939    *
 940    * @return the value of field 'FontName'.
 941    */
 942   public java.lang.String getFontName()
 943   {
 944     return this._fontName;
 945   }
 946
 947   /**
 948    * Returns the value of field 'fontSize'.
 949    *
 950    * @return the value of field 'FontSize'.
 951    */
 952   public int getFontSize()
 953   {
 954     return this._fontSize;
 955   }
 956
 957   /**
 958    * Returns the value of field 'fontStyle'.
 959    *
 960    * @return the value of field 'FontStyle'.
 961    */
 962   public int getFontStyle()
 963   {
 964     return this._fontStyle;
 965   }
 966
 967   /**
 968    * Returns the value of field 'gatheredViews'.
 969    *
 970    * @return the value of field 'GatheredViews'.
 971    */
 972   public boolean getGatheredViews()
 973   {
 974     return this._gatheredViews;
 975   }
 976
 977   /**
 978    * Returns the value of field 'height'.
 979    *
 980    * @return the value of field 'Height'.
 981    */
 982   public int getHeight()
 983   {
 984     return this._height;
 985   }
 986
 987   /**
 988    * Method getHiddenColumns.
 989    *
 990    * @param index
 991    * @throws java.lang.IndexOutOfBoundsException
 992    *           if the index given is outside the bounds of the collection
 993    * @return the value of the jalview.schemabinding.version2.HiddenColumns at
 994    *         the given index
 995    */
 996   public jalview.schemabinding.version2.HiddenColumns getHiddenColumns(
 997           final int index) throws java.lang.IndexOutOfBoundsException
 998   {
 999     // check bounds for index
1000     if (index < 0 || index >= this._hiddenColumnsList.size())
1001     {
1002         throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
1003                   "getHiddenColumns",
1004                   Integer.valueOf(index).toString(),
1005                   Integer.valueOf((this._hiddenColumnsList.size() - 1)).toString()
1006         }));
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(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
2131                           "setCalcIdParam",
2132                           Integer.valueOf(index).toString(),
2133                           Integer.valueOf((this._calcIdParamList.size() - 1)).toString()
2134           }));
2135     }
2136
2137     this._calcIdParamList.set(index, vCalcIdParam);
2138   }
2139
2140   /**
2141    *
2142    *
2143    * @param vCalcIdParamArray
2144    */
2145   public void setCalcIdParam(
2146           final jalview.schemabinding.version2.CalcIdParam[] vCalcIdParamArray)
2147   {
2148     // -- copy array
2149     _calcIdParamList.clear();
2150
2151     for (int i = 0; i < vCalcIdParamArray.length; i++)
2152     {
2153       this._calcIdParamList.add(vCalcIdParamArray[i]);
2154     }
2155   }
2156
2157   /**
2158    * Sets the value of field 'centreColumnLabels'.
2159    *
2160    * @param centreColumnLabels
2161    *          the value of field 'centreColumnLabels'.
2162    */
2163   public void setCentreColumnLabels(final boolean centreColumnLabels)
2164   {
2165     this._centreColumnLabels = centreColumnLabels;
2166     this._has_centreColumnLabels = true;
2167   }
2168
2169   /**
2170    * Sets the value of field 'consThreshold'.
2171    *
2172    * @param consThreshold
2173    *          the value of field 'consThreshold'.
2174    */
2175   public void setConsThreshold(final int consThreshold)
2176   {
2177     this._consThreshold = consThreshold;
2178     this._has_consThreshold = true;
2179   }
2180
2181   /**
2182    * Sets the value of field 'conservationSelected'.
2183    *
2184    * @param conservationSelected
2185    *          the value of field 'conservationSelected'.
2186    */
2187   public void setConservationSelected(final boolean conservationSelected)
2188   {
2189     this._conservationSelected = conservationSelected;
2190     this._has_conservationSelected = true;
2191   }
2192
2193   /**
2194    * Sets the value of field 'followHighlight'.
2195    *
2196    * @param followHighlight
2197    *          the value of field 'followHighlight'.
2198    */
2199   public void setFollowHighlight(final boolean followHighlight)
2200   {
2201     this._followHighlight = followHighlight;
2202     this._has_followHighlight = true;
2203   }
2204
2205   /**
2206    * Sets the value of field 'followSelection'.
2207    *
2208    * @param followSelection
2209    *          the value of field 'followSelection'.
2210    */
2211   public void setFollowSelection(final boolean followSelection)
2212   {
2213     this._followSelection = followSelection;
2214     this._has_followSelection = true;
2215   }
2216
2217   /**
2218    * Sets the value of field 'fontName'.
2219    *
2220    * @param fontName
2221    *          the value of field 'fontName'.
2222    */
2223   public void setFontName(final java.lang.String fontName)
2224   {
2225     this._fontName = fontName;
2226   }
2227
2228   /**
2229    * Sets the value of field 'fontSize'.
2230    *
2231    * @param fontSize
2232    *          the value of field 'fontSize'.
2233    */
2234   public void setFontSize(final int fontSize)
2235   {
2236     this._fontSize = fontSize;
2237     this._has_fontSize = true;
2238   }
2239
2240   /**
2241    * Sets the value of field 'fontStyle'.
2242    *
2243    * @param fontStyle
2244    *          the value of field 'fontStyle'.
2245    */
2246   public void setFontStyle(final int fontStyle)
2247   {
2248     this._fontStyle = fontStyle;
2249     this._has_fontStyle = true;
2250   }
2251
2252   /**
2253    * Sets the value of field 'gatheredViews'.
2254    *
2255    * @param gatheredViews
2256    *          the value of field 'gatheredViews'.
2257    */
2258   public void setGatheredViews(final boolean gatheredViews)
2259   {
2260     this._gatheredViews = gatheredViews;
2261     this._has_gatheredViews = true;
2262   }
2263
2264   /**
2265    * Sets the value of field 'height'.
2266    *
2267    * @param height
2268    *          the value of field 'height'.
2269    */
2270   public void setHeight(final int height)
2271   {
2272     this._height = height;
2273     this._has_height = true;
2274   }
2275
2276   /**
2277    *
2278    *
2279    * @param index
2280    * @param vHiddenColumns
2281    * @throws java.lang.IndexOutOfBoundsException
2282    *           if the index given is outside the bounds of the collection
2283    */
2284   public void setHiddenColumns(final int index,
2285           final jalview.schemabinding.version2.HiddenColumns vHiddenColumns)
2286           throws java.lang.IndexOutOfBoundsException
2287   {
2288     // check bounds for index
2289     if (index < 0 || index >= this._hiddenColumnsList.size())
2290     {
2291         throw new IndexOutOfBoundsException(MessageManager.formatMessage("exception.index_value_not_in_range", new String[]{
2292                   "setHiddenColumns",
2293                   Integer.valueOf(index).toString(),
2294                   Integer.valueOf((this._hiddenColumnsList.size() - 1)).toString()
2295         }));
2296     }
2297
2298     this._hiddenColumnsList.set(index, vHiddenColumns);
2299   }
2300
2301   /**
2302    *
2303    *
2304    * @param vHiddenColumnsArray
2305    */
2306   public void setHiddenColumns(
2307           final jalview.schemabinding.version2.HiddenColumns[] vHiddenColumnsArray)
2308   {
2309     // -- copy array
2310     _hiddenColumnsList.clear();
2311
2312     for (int i = 0; i < vHiddenColumnsArray.length; i++)
2313     {
2314       this._hiddenColumnsList.add(vHiddenColumnsArray[i]);
2315     }
2316   }
2317
2318   /**
2319    * Sets the value of field 'id'. The field 'id' has the following description:
2320    * unique id used by jalview to synchronize between stored and instantiated
2321    * views
2322    *
2323    *
2324    * @param id
2325    *          the value of field 'id'.
2326    */
2327   public void setId(final java.lang.String id)
2328   {
2329     this._id = id;
2330   }
2331
2332   /**
2333    * Sets the value of field 'ignoreGapsinConsensus'.
2334    *
2335    * @param ignoreGapsinConsensus
2336    *          the value of field 'ignoreGapsinConsensus'.
2337    */
2338   public void setIgnoreGapsinConsensus(final boolean ignoreGapsinConsensus)
2339   {
2340     this._ignoreGapsinConsensus = ignoreGapsinConsensus;
2341     this._has_ignoreGapsinConsensus = true;
2342   }
2343
2344   /**
2345    * Sets the value of field 'normaliseSequenceLogo'.
2346    *
2347    * @param normaliseSequenceLogo
2348    *          the value of field 'normaliseSequenceLogo'.
2349    */
2350   public void setNormaliseSequenceLogo(final boolean normaliseSequenceLogo)
2351   {
2352     this._normaliseSequenceLogo = normaliseSequenceLogo;
2353     this._has_normaliseSequenceLogo = true;
2354   }
2355
2356   /**
2357    * Sets the value of field 'pidSelected'.
2358    *
2359    * @param pidSelected
2360    *          the value of field 'pidSelected'.
2361    */
2362   public void setPidSelected(final boolean pidSelected)
2363   {
2364     this._pidSelected = pidSelected;
2365     this._has_pidSelected = true;
2366   }
2367
2368   /**
2369    * Sets the value of field 'pidThreshold'.
2370    *
2371    * @param pidThreshold
2372    *          the value of field 'pidThreshold'.
2373    */
2374   public void setPidThreshold(final int pidThreshold)
2375   {
2376     this._pidThreshold = pidThreshold;
2377     this._has_pidThreshold = true;
2378   }
2379
2380   /**
2381    * Sets the value of field 'renderGaps'.
2382    *
2383    * @param renderGaps
2384    *          the value of field 'renderGaps'.
2385    */
2386   public void setRenderGaps(final boolean renderGaps)
2387   {
2388     this._renderGaps = renderGaps;
2389     this._has_renderGaps = true;
2390   }
2391
2392   /**
2393    * Sets the value of field 'rightAlignIds'.
2394    *
2395    * @param rightAlignIds
2396    *          the value of field 'rightAlignIds'.
2397    */
2398   public void setRightAlignIds(final boolean rightAlignIds)
2399   {
2400     this._rightAlignIds = rightAlignIds;
2401     this._has_rightAlignIds = true;
2402   }
2403
2404   /**
2405    * Sets the value of field 'sequenceSetId'.
2406    *
2407    * @param sequenceSetId
2408    *          the value of field 'sequenceSetId'.
2409    */
2410   public void setSequenceSetId(final java.lang.String sequenceSetId)
2411   {
2412     this._sequenceSetId = sequenceSetId;
2413   }
2414
2415   /**
2416    * Sets the value of field 'showAnnotation'.
2417    *
2418    * @param showAnnotation
2419    *          the value of field 'showAnnotation'.
2420    */
2421   public void setShowAnnotation(final boolean showAnnotation)
2422   {
2423     this._showAnnotation = showAnnotation;
2424     this._has_showAnnotation = true;
2425   }
2426
2427   /**
2428    * Sets the value of field 'showBoxes'.
2429    *
2430    * @param showBoxes
2431    *          the value of field 'showBoxes'.
2432    */
2433   public void setShowBoxes(final boolean showBoxes)
2434   {
2435     this._showBoxes = showBoxes;
2436     this._has_showBoxes = true;
2437   }
2438
2439   /**
2440    * Sets the value of field 'showColourText'.
2441    *
2442    * @param showColourText
2443    *          the value of field 'showColourText'.
2444    */
2445   public void setShowColourText(final boolean showColourText)
2446   {
2447     this._showColourText = showColourText;
2448     this._has_showColourText = true;
2449   }
2450
2451   /**
2452    * Sets the value of field 'showConsensusHistogram'.
2453    *
2454    * @param showConsensusHistogram
2455    *          the value of field 'showConsensusHistogram'.
2456    */
2457   public void setShowConsensusHistogram(final boolean showConsensusHistogram)
2458   {
2459     this._showConsensusHistogram = showConsensusHistogram;
2460     this._has_showConsensusHistogram = true;
2461   }
2462
2463   /**
2464    * Sets the value of field 'showDbRefTooltip'.
2465    *
2466    * @param showDbRefTooltip
2467    *          the value of field 'showDbRefTooltip'
2468    */
2469   public void setShowDbRefTooltip(final boolean showDbRefTooltip)
2470   {
2471     this._showDbRefTooltip = showDbRefTooltip;
2472     this._has_showDbRefTooltip = true;
2473   }
2474
2475   /**
2476    * Sets the value of field 'showFullId'.
2477    *
2478    * @param showFullId
2479    *          the value of field 'showFullId'.
2480    */
2481   public void setShowFullId(final boolean showFullId)
2482   {
2483     this._showFullId = showFullId;
2484     this._has_showFullId = true;
2485   }
2486
2487   /**
2488    * Sets the value of field 'showGroupConsensus'.
2489    *
2490    * @param showGroupConsensus
2491    *          the value of field 'showGroupConsensus'.
2492    */
2493   public void setShowGroupConsensus(final boolean showGroupConsensus)
2494   {
2495     this._showGroupConsensus = showGroupConsensus;
2496     this._has_showGroupConsensus = true;
2497   }
2498
2499   /**
2500    * Sets the value of field 'showGroupConservation'.
2501    *
2502    * @param showGroupConservation
2503    *          the value of field 'showGroupConservation'.
2504    */
2505   public void setShowGroupConservation(final boolean showGroupConservation)
2506   {
2507     this._showGroupConservation = showGroupConservation;
2508     this._has_showGroupConservation = true;
2509   }
2510
2511   /**
2512    * Sets the value of field 'showNPfeatureTooltip'.
2513    *
2514    * @param showNPfeatureTooltip
2515    *          the value of field 'showNPfeatureTooltip'.
2516    */
2517   public void setShowNPfeatureTooltip(final boolean showNPfeatureTooltip)
2518   {
2519     this._showNPfeatureTooltip = showNPfeatureTooltip;
2520     this._has_showNPfeatureTooltip = true;
2521   }
2522
2523   /**
2524    * Sets the value of field 'showSequenceFeatures'.
2525    *
2526    * @param showSequenceFeatures
2527    *          the value of field 'showSequenceFeatures'.
2528    */
2529   public void setShowSequenceFeatures(final boolean showSequenceFeatures)
2530   {
2531     this._showSequenceFeatures = showSequenceFeatures;
2532     this._has_showSequenceFeatures = true;
2533   }
2534
2535   /**
2536    * Sets the value of field 'showSequenceLogo'.
2537    *
2538    * @param showSequenceLogo
2539    *          the value of field 'showSequenceLogo'
2540    */
2541   public void setShowSequenceLogo(final boolean showSequenceLogo)
2542   {
2543     this._showSequenceLogo = showSequenceLogo;
2544     this._has_showSequenceLogo = true;
2545   }
2546
2547   /**
2548    * Sets the value of field 'showText'.
2549    *
2550    * @param showText
2551    *          the value of field 'showText'.
2552    */
2553   public void setShowText(final boolean showText)
2554   {
2555     this._showText = showText;
2556     this._has_showText = true;
2557   }
2558
2559   /**
2560    * Sets the value of field 'showUnconserved'.
2561    *
2562    * @param showUnconserved
2563    *          the value of field 'showUnconserved'.
2564    */
2565   public void setShowUnconserved(final boolean showUnconserved)
2566   {
2567     this._showUnconserved = showUnconserved;
2568     this._has_showUnconserved = true;
2569   }
2570
2571   /**
2572    * Sets the value of field 'startRes'.
2573    *
2574    * @param startRes
2575    *          the value of field 'startRes'.
2576    */
2577   public void setStartRes(final int startRes)
2578   {
2579     this._startRes = startRes;
2580     this._has_startRes = true;
2581   }
2582
2583   /**
2584    * Sets the value of field 'startSeq'.
2585    *
2586    * @param startSeq
2587    *          the value of field 'startSeq'.
2588    */
2589   public void setStartSeq(final int startSeq)
2590   {
2591     this._startSeq = startSeq;
2592     this._has_startSeq = true;
2593   }
2594
2595   /**
2596    * Sets the value of field 'textCol1'.
2597    *
2598    * @param textCol1
2599    *          the value of field 'textCol1'.
2600    */
2601   public void setTextCol1(final int textCol1)
2602   {
2603     this._textCol1 = textCol1;
2604     this._has_textCol1 = true;
2605   }
2606
2607   /**
2608    * Sets the value of field 'textCol2'.
2609    *
2610    * @param textCol2
2611    *          the value of field 'textCol2'.
2612    */
2613   public void setTextCol2(final int textCol2)
2614   {
2615     this._textCol2 = textCol2;
2616     this._has_textCol2 = true;
2617   }
2618
2619   /**
2620    * Sets the value of field 'textColThreshold'.
2621    *
2622    * @param textColThreshold
2623    *          the value of field 'textColThreshold'
2624    */
2625   public void setTextColThreshold(final int textColThreshold)
2626   {
2627     this._textColThreshold = textColThreshold;
2628     this._has_textColThreshold = true;
2629   }
2630
2631   /**
2632    * Sets the value of field 'title'.
2633    *
2634    * @param title
2635    *          the value of field 'title'.
2636    */
2637   public void setTitle(final java.lang.String title)
2638   {
2639     this._title = title;
2640   }
2641
2642   /**
2643    * Sets the value of field 'viewName'.
2644    *
2645    * @param viewName
2646    *          the value of field 'viewName'.
2647    */
2648   public void setViewName(final java.lang.String viewName)
2649   {
2650     this._viewName = viewName;
2651   }
2652
2653   /**
2654    * Sets the value of field 'width'.
2655    *
2656    * @param width
2657    *          the value of field 'width'.
2658    */
2659   public void setWidth(final int width)
2660   {
2661     this._width = width;
2662     this._has_width = true;
2663   }
2664
2665   /**
2666    * Sets the value of field 'wrapAlignment'.
2667    *
2668    * @param wrapAlignment
2669    *          the value of field 'wrapAlignment'.
2670    */
2671   public void setWrapAlignment(final boolean wrapAlignment)
2672   {
2673     this._wrapAlignment = wrapAlignment;
2674     this._has_wrapAlignment = true;
2675   }
2676
2677   /**
2678    * Sets the value of field 'xpos'.
2679    *
2680    * @param xpos
2681    *          the value of field 'xpos'.
2682    */
2683   public void setXpos(final int xpos)
2684   {
2685     this._xpos = xpos;
2686     this._has_xpos = true;
2687   }
2688
2689   /**
2690    * Sets the value of field 'ypos'.
2691    *
2692    * @param ypos
2693    *          the value of field 'ypos'.
2694    */
2695   public void setYpos(final int ypos)
2696   {
2697     this._ypos = ypos;
2698     this._has_ypos = true;
2699   }
2700
2701   /**
2702    * Method unmarshal.
2703    *
2704    * @param reader
2705    * @throws org.exolab.castor.xml.MarshalException
2706    *           if object is null or if any SAXException is thrown during
2707    *           marshaling
2708    * @throws org.exolab.castor.xml.ValidationException
2709    *           if this object is an invalid instance according to the schema
2710    * @return the unmarshaled jalview.schemabinding.version2.Viewport
2711    */
2712   public static jalview.schemabinding.version2.Viewport unmarshal(
2713           final java.io.Reader reader)
2714           throws org.exolab.castor.xml.MarshalException,
2715           org.exolab.castor.xml.ValidationException
2716   {
2717     return (jalview.schemabinding.version2.Viewport) Unmarshaller
2718             .unmarshal(jalview.schemabinding.version2.Viewport.class,
2719                     reader);
2720   }
2721
2722   /**
2723    *
2724    *
2725    * @throws org.exolab.castor.xml.ValidationException
2726    *           if this object is an invalid instance according to the schema
2727    */
2728   public void validate() throws org.exolab.castor.xml.ValidationException
2729   {
2730     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
2731     validator.validate(this);
2732   }
2733
2734 }