added help and documentation for annotation editing.
[jalview.git] / src / jalview / binding / JalviewModelSequence2Item.java
1 /*\r
2  * This class was automatically generated with\r
3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package jalview.binding;\r
9 \r
10 //---------------------------------/\r
11 //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import java.util.*;\r
15 \r
16 /**\r
17  * Class JalviewModelSequence2Item.\r
18  *\r
19  * @version $Revision$ $Date$\r
20  */\r
21 public class JalviewModelSequence2Item\r
22     implements java.io.Serializable\r
23 {\r
24 \r
25   //--------------------------/\r
26   //- Class/Member Variables -/\r
27   //--------------------------/\r
28 \r
29   /**\r
30    * Field _userColourSchemeList\r
31    */\r
32   private java.util.Vector _userColourSchemeList;\r
33 \r
34   //----------------/\r
35   //- Constructors -/\r
36   //----------------/\r
37 \r
38   public JalviewModelSequence2Item()\r
39   {\r
40     super();\r
41     _userColourSchemeList = new Vector();\r
42   } //-- jalview.binding.JalviewModelSequence2Item()\r
43 \r
44   //-----------/\r
45   //- Methods -/\r
46   //-----------/\r
47 \r
48   /**\r
49    * Method addUserColourScheme\r
50    *\r
51    *\r
52    *\r
53    * @param vUserColourScheme\r
54    */\r
55   public void addUserColourScheme(jalview.binding.UserColourScheme\r
56                                   vUserColourScheme)\r
57       throws java.lang.IndexOutOfBoundsException\r
58   {\r
59     _userColourSchemeList.addElement(vUserColourScheme);\r
60   } //-- void addUserColourScheme(jalview.binding.UserColourScheme)\r
61 \r
62   /**\r
63    * Method addUserColourScheme\r
64    *\r
65    *\r
66    *\r
67    * @param index\r
68    * @param vUserColourScheme\r
69    */\r
70   public void addUserColourScheme(int index,\r
71                                   jalview.binding.UserColourScheme\r
72                                   vUserColourScheme)\r
73       throws java.lang.IndexOutOfBoundsException\r
74   {\r
75     _userColourSchemeList.insertElementAt(vUserColourScheme, index);\r
76   } //-- void addUserColourScheme(int, jalview.binding.UserColourScheme)\r
77 \r
78   /**\r
79    * Method enumerateUserColourScheme\r
80    *\r
81    *\r
82    *\r
83    * @return Enumeration\r
84    */\r
85   public java.util.Enumeration enumerateUserColourScheme()\r
86   {\r
87     return _userColourSchemeList.elements();\r
88   } //-- java.util.Enumeration enumerateUserColourScheme()\r
89 \r
90   /**\r
91    * Method getUserColourScheme\r
92    *\r
93    *\r
94    *\r
95    * @param index\r
96    * @return UserColourScheme\r
97    */\r
98   public jalview.binding.UserColourScheme getUserColourScheme(int index)\r
99       throws java.lang.IndexOutOfBoundsException\r
100   {\r
101     //-- check bounds for index\r
102     if ( (index < 0) || (index > _userColourSchemeList.size()))\r
103     {\r
104       throw new IndexOutOfBoundsException();\r
105     }\r
106 \r
107     return (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(\r
108         index);\r
109   } //-- jalview.binding.UserColourScheme getUserColourScheme(int)\r
110 \r
111   /**\r
112    * Method getUserColourScheme\r
113    *\r
114    *\r
115    *\r
116    * @return UserColourScheme\r
117    */\r
118   public jalview.binding.UserColourScheme[] getUserColourScheme()\r
119   {\r
120     int size = _userColourSchemeList.size();\r
121     jalview.binding.UserColourScheme[] mArray = new jalview.binding.\r
122         UserColourScheme[size];\r
123     for (int index = 0; index < size; index++)\r
124     {\r
125       mArray[index] = (jalview.binding.UserColourScheme) _userColourSchemeList.\r
126           elementAt(index);\r
127     }\r
128     return mArray;\r
129   } //-- jalview.binding.UserColourScheme[] getUserColourScheme()\r
130 \r
131   /**\r
132    * Method getUserColourSchemeCount\r
133    *\r
134    *\r
135    *\r
136    * @return int\r
137    */\r
138   public int getUserColourSchemeCount()\r
139   {\r
140     return _userColourSchemeList.size();\r
141   } //-- int getUserColourSchemeCount()\r
142 \r
143   /**\r
144    * Method removeAllUserColourScheme\r
145    *\r
146    */\r
147   public void removeAllUserColourScheme()\r
148   {\r
149     _userColourSchemeList.removeAllElements();\r
150   } //-- void removeAllUserColourScheme()\r
151 \r
152   /**\r
153    * Method removeUserColourScheme\r
154    *\r
155    *\r
156    *\r
157    * @param index\r
158    * @return UserColourScheme\r
159    */\r
160   public jalview.binding.UserColourScheme removeUserColourScheme(int index)\r
161   {\r
162     java.lang.Object obj = _userColourSchemeList.elementAt(index);\r
163     _userColourSchemeList.removeElementAt(index);\r
164     return (jalview.binding.UserColourScheme) obj;\r
165   } //-- jalview.binding.UserColourScheme removeUserColourScheme(int)\r
166 \r
167   /**\r
168    * Method setUserColourScheme\r
169    *\r
170    *\r
171    *\r
172    * @param index\r
173    * @param vUserColourScheme\r
174    */\r
175   public void setUserColourScheme(int index,\r
176                                   jalview.binding.UserColourScheme\r
177                                   vUserColourScheme)\r
178       throws java.lang.IndexOutOfBoundsException\r
179   {\r
180     //-- check bounds for index\r
181     if ( (index < 0) || (index > _userColourSchemeList.size()))\r
182     {\r
183       throw new IndexOutOfBoundsException();\r
184     }\r
185     _userColourSchemeList.setElementAt(vUserColourScheme, index);\r
186   } //-- void setUserColourScheme(int, jalview.binding.UserColourScheme)\r
187 \r
188   /**\r
189    * Method setUserColourScheme\r
190    *\r
191    *\r
192    *\r
193    * @param userColourSchemeArray\r
194    */\r
195   public void setUserColourScheme(jalview.binding.UserColourScheme[]\r
196                                   userColourSchemeArray)\r
197   {\r
198     //-- copy array\r
199     _userColourSchemeList.removeAllElements();\r
200     for (int i = 0; i < userColourSchemeArray.length; i++)\r
201     {\r
202       _userColourSchemeList.addElement(userColourSchemeArray[i]);\r
203     }\r
204   } //-- void setUserColourScheme(jalview.binding.UserColourScheme)\r
205 \r
206 }\r