jars/gss-lib-2.2/javadoc/com/pras/SpreadSheet.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.5.0_22) on Tue May 10 10:28:01 IST 2011 -->\r
   6 <TITLE>\r
   7 SpreadSheet\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.pras.SpreadSheet class">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     parent.document.title="SpreadSheet";\r
  18 }\r
  19 </SCRIPT>\r
  20 <NOSCRIPT>\r
  21 </NOSCRIPT>\r
  22 \r
  23 </HEAD>\r
  24 \r
  25 <BODY BGCOLOR="white" onload="windowTitle();">\r
  26 \r
  27 \r
  28 <!-- ========= START OF TOP NAVBAR ======= -->\r
  29 <A NAME="navbar_top"><!-- --></A>\r
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  32 <TR>\r
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  34 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  36   <TR ALIGN="center" VALIGN="top">\r
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpreadSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  45   </TR>\r
  46 </TABLE>\r
  47 </TD>\r
  48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  49 </EM>\r
  50 </TD>\r
  51 </TR>\r
  52 \r
  53 <TR>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55 &nbsp;<A HREF="../../com/pras/Log.html" title="class in com.pras"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../index.html?com/pras/SpreadSheet.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="SpreadSheet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  60 &nbsp;<SCRIPT type="text/javascript">\r
  61   <!--\r
  62   if(window==top) {\r
  63     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  64   }\r
  65   //-->\r
  66 </SCRIPT>\r
  67 <NOSCRIPT>\r
  68   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
  69 </NOSCRIPT>\r
  70 \r
  71 \r
  72 </FONT></TD>\r
  73 </TR>\r
  74 <TR>\r
  75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  79 </TR>\r
  80 </TABLE>\r
  81 <A NAME="skip-navbar_top"></A>\r
  82 <!-- ========= END OF TOP NAVBAR ========= -->\r
  83 \r
  84 <HR>\r
  85 <!-- ======== START OF CLASS DATA ======== -->\r
  86 <H2>\r
  87 <FONT SIZE="-1">\r
  88 com.pras</FONT>\r
  89 <BR>\r
  90 Class SpreadSheet</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>com.pras.SpreadSheet</B>\r
  94 </PRE>\r
  95 <HR>\r
  96 <DL>\r
  97 <DT><PRE>public class <B>SpreadSheet</B><DT>extends java.lang.Object</DL>\r
  98 </PRE>\r
  99 \r
 100 <P>\r
 101 This class represents a given Spreadsheet. You can add multiple WorkSheets into a Spreadsheet.
 102  It provides methods to Add/Retrieve/Delete WorkSheet and Share SpreadSheet.
 103
 104  <br/>API Ref:<br/>
 105  <a href="http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html">http://code.google.com/apis/spreadsheets/data/3.0/developers_guide.html</a>
 106  <br/>
 107  Feed Ref:
 108  <br/>
 109  <a href="http://code.google.com/apis/documents/docs/3.0/reference.html">http://code.google.com/apis/documents/docs/3.0/reference.html</a>
 110  <br/>
 111  <br/>
 112  <b>NOTE:</b>
 113  <i>Resource ID is required to delete a SpreadSheet</i>\r
 114 <P>\r
 115 \r
 116 <P>\r
 117 <DL>\r
 118 <DT><B>Author:</B></DT>\r
 119   <DD>Prasanta Paul</DD>\r
 120 </DL>\r
 121 <HR>\r
 122 \r
 123 <P>\r
 124 \r
 125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 126 \r
 127 <A NAME="constructor_summary"><!-- --></A>\r
 128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 131 <B>Constructor Summary</B></FONT></TH>\r
 132 </TR>\r
 133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 134 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#SpreadSheet(com.pras.sp.Entry)">SpreadSheet</A></B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A>&nbsp;entry)</CODE>\r
 135 \r
 136 <BR>\r
 137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 138 </TR>\r
 139 </TABLE>\r
 140 &nbsp;\r
 141 <!-- ========== METHOD SUMMARY =========== -->\r
 142 \r
 143 <A NAME="method_summary"><!-- --></A>\r
 144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 146 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 147 <B>Method Summary</B></FONT></TH>\r
 148 </TR>\r
 149 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 151 <CODE>&nbsp;void</CODE></FONT></TD>\r
 152 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#addCollaborator(com.pras.Collaborator)">addCollaborator</A></B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c)</CODE>\r
 153 \r
 154 <BR>\r
 155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a Collaborator</TD>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 159 <CODE>&nbsp;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A></CODE></FONT></TD>\r
 160 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#addListWorkSheet(java.lang.String, int, java.lang.String[])">addListWorkSheet</A></B>(java.lang.String&nbsp;name,\r
 161                  int&nbsp;rowCount,\r
 162                  java.lang.String[]&nbsp;cols)</CODE>\r
 163 \r
 164 <BR>\r
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create List feed based WorkSheet</TD>\r
 166 </TR>\r
 167 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 169 <CODE>&nbsp;void</CODE></FONT></TD>\r
 170 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#addWorkSheet(java.lang.String)">addWorkSheet</A></B>(java.lang.String&nbsp;name)</CODE>\r
 171 \r
 172 <BR>\r
 173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will create an WorkSheet without Table.</TD>\r
 174 </TR>\r
 175 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 177 <CODE>&nbsp;void</CODE></FONT></TD>\r
 178 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#addWorkSheet(java.lang.String, java.lang.String[])">addWorkSheet</A></B>(java.lang.String&nbsp;name,\r
 179              java.lang.String[]&nbsp;cols)</CODE>\r
 180 \r
 181 <BR>\r
 182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add WorkSheet
 183  This will create an Internal Table and manage WorkSheet data in that Table.</TD>\r
 184 </TR>\r
 185 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 187 <CODE>&nbsp;void</CODE></FONT></TD>\r
 188 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#addWorkSheet(java.lang.String, java.lang.String, int, java.lang.String[])">addWorkSheet</A></B>(java.lang.String&nbsp;name,\r
 189              java.lang.String&nbsp;description,\r
 190              int&nbsp;row,\r
 191              java.lang.String[]&nbsp;cols)</CODE>\r
 192 \r
 193 <BR>\r
 194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add WorkSheet <br/>
 195  It will create a Table for this WorkSheet.</TD>\r
 196 </TR>\r
 197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 199 <CODE>&nbsp;void</CODE></FONT></TD>\r
 200 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#clearCollaboratorList()">clearCollaboratorList</A></B>()</CODE>\r
 201 \r
 202 <BR>\r
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clear existing list of Collaborators</TD>\r
 204 </TR>\r
 205 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 207 <CODE>&nbsp;void</CODE></FONT></TD>\r
 208 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#deleteWorkSheet(com.pras.WorkSheet)">deleteWorkSheet</A></B>(<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&nbsp;wk)</CODE>\r
 209 \r
 210 <BR>\r
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete this WorkSheet</TD>\r
 212 </TR>\r
 213 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 215 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 216 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>\r
 217 \r
 218 <BR>\r
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 220 </TR>\r
 221 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 223 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt;</CODE></FONT></TD>\r
 224 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getAllWorkSheets()">getAllWorkSheets</A></B>()</CODE>\r
 225 \r
 226 <BR>\r
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;It will retrieve all WorkSheets of this SpreadSheet from Server</TD>\r
 228 </TR>\r
 229 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 231 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt;</CODE></FONT></TD>\r
 232 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getAllWorkSheets(boolean)">getAllWorkSheets</A></B>(boolean&nbsp;doRefresh)</CODE>\r
 233 \r
 234 <BR>\r
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;It will retrieve all WorkSheets of this SpreadSheet either from Server or from Local Cache</TD>\r
 236 </TR>\r
 237 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 239 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt;</CODE></FONT></TD>\r
 240 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getAllWorkSheets(boolean, java.lang.String, boolean)">getAllWorkSheets</A></B>(boolean&nbsp;doRefresh,\r
 241                  java.lang.String&nbsp;title,\r
 242                  boolean&nbsp;isTitleExact)</CODE>\r
 243 \r
 244 <BR>\r
 245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;It will retrieve WorkSheets with matching title either from Server or from Local Cache</TD>\r
 246 </TR>\r
 247 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 249 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt;</CODE></FONT></TD>\r
 250 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getCollaborators()">getCollaborators</A></B>()</CODE>\r
 251 \r
 252 <BR>\r
 253 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the list of all Collaborator details (users/groups and their access rights) for a given SpreadSheet</TD>\r
 254 </TR>\r
 255 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 257 <CODE>&nbsp;<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A></CODE></FONT></TD>\r
 258 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getEntry()">getEntry</A></B>()</CODE>\r
 259 \r
 260 <BR>\r
 261 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get Entry Object of SpreadSheet Feed.</TD>\r
 262 </TR>\r
 263 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 265 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 266 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getKey()">getKey</A></B>()</CODE>\r
 267 \r
 268 <BR>\r
 269 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get SpreadSheet Feed Key</TD>\r
 270 </TR>\r
 271 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 273 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 274 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getResourceID()">getResourceID</A></B>()</CODE>\r
 275 \r
 276 <BR>\r
 277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get SpreadSheet Resource ID.</TD>\r
 278 </TR>\r
 279 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 281 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 282 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getTitle()">getTitle</A></B>()</CODE>\r
 283 \r
 284 <BR>\r
 285 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get SpreadSheet Title</TD>\r
 286 </TR>\r
 287 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 289 <CODE>&nbsp;java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt;</CODE></FONT></TD>\r
 290 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#getWorkSheet(java.lang.String, boolean)">getWorkSheet</A></B>(java.lang.String&nbsp;title,\r
 291              boolean&nbsp;isTitleExact)</CODE>\r
 292 \r
 293 <BR>\r
 294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;It will retrieve WorkSheets with matching title from Server</TD>\r
 295 </TR>\r
 296 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 297 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 298 <CODE>&nbsp;int</CODE></FONT></TD>\r
 299 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#hashCode()">hashCode</A></B>()</CODE>\r
 300 \r
 301 <BR>\r
 302 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 303 </TR>\r
 304 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 305 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 306 <CODE>&nbsp;void</CODE></FONT></TD>\r
 307 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#setCollaborators(java.util.ArrayList)">setCollaborators</A></B>(java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt;&nbsp;collaborators)</CODE>\r
 308 \r
 309 <BR>\r
 310 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a list of Collaborators</TD>\r
 311 </TR>\r
 312 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 313 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 314 <CODE>&nbsp;void</CODE></FONT></TD>\r
 315 <TD><CODE><B><A HREF="../../com/pras/SpreadSheet.html#setEntry(com.pras.sp.Entry)">setEntry</A></B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A>&nbsp;entry)</CODE>\r
 316 \r
 317 <BR>\r
 318 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set Entry Object of SpreadSheet Feed.</TD>\r
 319 </TR>\r
 320 </TABLE>\r
 321 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 322 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 323 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 324 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 325 </TR>\r
 326 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 327 <TD><CODE>getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 328 </TR>\r
 329 </TABLE>\r
 330 &nbsp;\r
 331 <P>\r
 332 \r
 333 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 334 \r
 335 <A NAME="constructor_detail"><!-- --></A>\r
 336 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 337 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 338 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 339 <B>Constructor Detail</B></FONT></TH>\r
 340 </TR>\r
 341 </TABLE>\r
 342 \r
 343 <A NAME="SpreadSheet(com.pras.sp.Entry)"><!-- --></A><H3>\r
 344 SpreadSheet</H3>\r
 345 <PRE>\r
 346 public <B>SpreadSheet</B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A>&nbsp;entry)</PRE>\r
 347 <DL>\r
 348 </DL>\r
 349 \r
 350 <!-- ============ METHOD DETAIL ========== -->\r
 351 \r
 352 <A NAME="method_detail"><!-- --></A>\r
 353 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 354 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 355 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 356 <B>Method Detail</B></FONT></TH>\r
 357 </TR>\r
 358 </TABLE>\r
 359 \r
 360 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 361 equals</H3>\r
 362 <PRE>\r
 363 public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>\r
 364 <DL>\r
 365 <DD><DL>\r
 366 <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
 367 </DD>\r
 368 <DD><DL>\r
 369 </DL>\r
 370 </DD>\r
 371 </DL>\r
 372 <HR>\r
 373 \r
 374 <A NAME="hashCode()"><!-- --></A><H3>\r
 375 hashCode</H3>\r
 376 <PRE>\r
 377 public int <B>hashCode</B>()</PRE>\r
 378 <DL>\r
 379 <DD><DL>\r
 380 <DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
 381 </DD>\r
 382 <DD><DL>\r
 383 </DL>\r
 384 </DD>\r
 385 </DL>\r
 386 <HR>\r
 387 \r
 388 <A NAME="getEntry()"><!-- --></A><H3>\r
 389 getEntry</H3>\r
 390 <PRE>\r
 391 public <A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A> <B>getEntry</B>()</PRE>\r
 392 <DL>\r
 393 <DD>Get Entry Object of SpreadSheet Feed. Entry holds all SpreadSheet Feed details\r
 394 <P>\r
 395 <DD><DL>\r
 396 \r
 397 <DT><B>Returns:</B><DD></DL>\r
 398 </DD>\r
 399 </DL>\r
 400 <HR>\r
 401 \r
 402 <A NAME="setEntry(com.pras.sp.Entry)"><!-- --></A><H3>\r
 403 setEntry</H3>\r
 404 <PRE>\r
 405 public void <B>setEntry</B>(<A HREF="../../com/pras/sp/Entry.html" title="class in com.pras.sp">Entry</A>&nbsp;entry)</PRE>\r
 406 <DL>\r
 407 <DD>Set Entry Object of SpreadSheet Feed.\r
 408 <P>\r
 409 <DD><DL>\r
 410 <DT><B>Parameters:</B><DD><CODE>entry</CODE> - </DL>\r
 411 </DD>\r
 412 </DL>\r
 413 <HR>\r
 414 \r
 415 <A NAME="getTitle()"><!-- --></A><H3>\r
 416 getTitle</H3>\r
 417 <PRE>\r
 418 public java.lang.String <B>getTitle</B>()</PRE>\r
 419 <DL>\r
 420 <DD>Get SpreadSheet Title\r
 421 <P>\r
 422 <DD><DL>\r
 423 \r
 424 <DT><B>Returns:</B><DD></DL>\r
 425 </DD>\r
 426 </DL>\r
 427 <HR>\r
 428 \r
 429 <A NAME="getResourceID()"><!-- --></A><H3>\r
 430 getResourceID</H3>\r
 431 <PRE>\r
 432 public java.lang.String <B>getResourceID</B>()</PRE>\r
 433 <DL>\r
 434 <DD>Get SpreadSheet Resource ID. Each SpreadSheet has an unique Resource ID.
 435  This ID is required to Delete this SpreadSheet.\r
 436 <P>\r
 437 <DD><DL>\r
 438 \r
 439 <DT><B>Returns:</B><DD></DL>\r
 440 </DD>\r
 441 </DL>\r
 442 <HR>\r
 443 \r
 444 <A NAME="getKey()"><!-- --></A><H3>\r
 445 getKey</H3>\r
 446 <PRE>\r
 447 public java.lang.String <B>getKey</B>()</PRE>\r
 448 <DL>\r
 449 <DD>Get SpreadSheet Feed Key\r
 450 <P>\r
 451 <DD><DL>\r
 452 \r
 453 <DT><B>Returns:</B><DD></DL>\r
 454 </DD>\r
 455 </DL>\r
 456 <HR>\r
 457 \r
 458 <A NAME="getCollaborators()"><!-- --></A><H3>\r
 459 getCollaborators</H3>\r
 460 <PRE>\r
 461 public java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt; <B>getCollaborators</B>()</PRE>\r
 462 <DL>\r
 463 <DD>Get the list of all Collaborator details (users/groups and their access rights) for a given SpreadSheet\r
 464 <P>\r
 465 <DD><DL>\r
 466 \r
 467 <DT><B>Returns:</B><DD></DL>\r
 468 </DD>\r
 469 </DL>\r
 470 <HR>\r
 471 \r
 472 <A NAME="addCollaborator(com.pras.Collaborator)"><!-- --></A><H3>\r
 473 addCollaborator</H3>\r
 474 <PRE>\r
 475 public void <B>addCollaborator</B>(<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&nbsp;c)</PRE>\r
 476 <DL>\r
 477 <DD>Add a Collaborator\r
 478 <P>\r
 479 <DD><DL>\r
 480 <DT><B>Parameters:</B><DD><CODE>c</CODE> - </DL>\r
 481 </DD>\r
 482 </DL>\r
 483 <HR>\r
 484 \r
 485 <A NAME="clearCollaboratorList()"><!-- --></A><H3>\r
 486 clearCollaboratorList</H3>\r
 487 <PRE>\r
 488 public void <B>clearCollaboratorList</B>()</PRE>\r
 489 <DL>\r
 490 <DD>Clear existing list of Collaborators\r
 491 <P>\r
 492 <DD><DL>\r
 493 </DL>\r
 494 </DD>\r
 495 </DL>\r
 496 <HR>\r
 497 \r
 498 <A NAME="setCollaborators(java.util.ArrayList)"><!-- --></A><H3>\r
 499 setCollaborators</H3>\r
 500 <PRE>\r
 501 public void <B>setCollaborators</B>(java.util.ArrayList&lt;<A HREF="../../com/pras/Collaborator.html" title="class in com.pras">Collaborator</A>&gt;&nbsp;collaborators)</PRE>\r
 502 <DL>\r
 503 <DD>Set a list of Collaborators\r
 504 <P>\r
 505 <DD><DL>\r
 506 <DT><B>Parameters:</B><DD><CODE>collaborators</CODE> - </DL>\r
 507 </DD>\r
 508 </DL>\r
 509 <HR>\r
 510 \r
 511 <A NAME="addWorkSheet(java.lang.String)"><!-- --></A><H3>\r
 512 addWorkSheet</H3>\r
 513 <PRE>\r
 514 public void <B>addWorkSheet</B>(java.lang.String&nbsp;name)</PRE>\r
 515 <DL>\r
 516 <DD>This will create an WorkSheet without Table. It will create WorkSheet with 1 Column and 1 Row. It can
 517  be accessed/modified by Web Interface.
 518
 519  <b>IMPORTANT:</b>
 520  This Library supports Record Handling only through Table. If you use this method, it will not
 521  create Table internally and thus unable to add/edit/delete record from this WorkSheet. Instead,
 522  use addWorkSheet(String name, String[] cols)\r
 523 <P>\r
 524 <DD><DL>\r
 525 <DT><B>Parameters:</B><DD><CODE>name</CODE> - WorkSheet name</DL>\r
 526 </DD>\r
 527 </DL>\r
 528 <HR>\r
 529 \r
 530 <A NAME="addWorkSheet(java.lang.String, java.lang.String[])"><!-- --></A><H3>\r
 531 addWorkSheet</H3>\r
 532 <PRE>\r
 533 public void <B>addWorkSheet</B>(java.lang.String&nbsp;name,\r
 534                          java.lang.String[]&nbsp;cols)</PRE>\r
 535 <DL>\r
 536 <DD>Add WorkSheet
 537  This will create an Internal Table and manage WorkSheet data in that Table.
 538  This Lib supports only Table based record Add/Edit/Delete\r
 539 <P>\r
 540 <DD><DL>\r
 541 <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of WorkSheet<DD><CODE>cols</CODE> - name of Columns</DL>\r
 542 </DD>\r
 543 </DL>\r
 544 <HR>\r
 545 \r
 546 <A NAME="addWorkSheet(java.lang.String, java.lang.String, int, java.lang.String[])"><!-- --></A><H3>\r
 547 addWorkSheet</H3>\r
 548 <PRE>\r
 549 public void <B>addWorkSheet</B>(java.lang.String&nbsp;name,\r
 550                          java.lang.String&nbsp;description,\r
 551                          int&nbsp;row,\r
 552                          java.lang.String[]&nbsp;cols)</PRE>\r
 553 <DL>\r
 554 <DD>Add WorkSheet <br/>
 555  It will create a Table for this WorkSheet. WorkSheet and Table Name will be the same
 556  The Table will be used for Add/Edit/Delete Records
 557  <br/>\r
 558 <P>\r
 559 <DD><DL>\r
 560 <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the WorkSheet<DD><CODE>description</CODE> - Description of the WorkSheet<DD><CODE>row</CODE> - Number of Rows<DD><CODE>cols</CODE> - Name of Columns</DL>\r
 561 </DD>\r
 562 </DL>\r
 563 <HR>\r
 564 \r
 565 <A NAME="addListWorkSheet(java.lang.String, int, java.lang.String[])"><!-- --></A><H3>\r
 566 addListWorkSheet</H3>\r
 567 <PRE>\r
 568 public <A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A> <B>addListWorkSheet</B>(java.lang.String&nbsp;name,\r
 569                                   int&nbsp;rowCount,\r
 570                                   java.lang.String[]&nbsp;cols)</PRE>\r
 571 <DL>\r
 572 <DD>Create List feed based WorkSheet\r
 573 <P>\r
 574 <DD><DL>\r
 575 <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the WorkSheet<DD><CODE>rowCount</CODE> - Number of row. This doesn't limit future row addition.<DD><CODE>cols</CODE> - Array of column name. First row of the WorkSheet is header row.\r
 576 <DT><B>Returns:</B><DD></DL>\r
 577 </DD>\r
 578 </DL>\r
 579 <HR>\r
 580 \r
 581 <A NAME="getAllWorkSheets()"><!-- --></A><H3>\r
 582 getAllWorkSheets</H3>\r
 583 <PRE>\r
 584 public java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt; <B>getAllWorkSheets</B>()</PRE>\r
 585 <DL>\r
 586 <DD>It will retrieve all WorkSheets of this SpreadSheet from Server\r
 587 <P>\r
 588 <DD><DL>\r
 589 \r
 590 <DT><B>Returns:</B><DD></DL>\r
 591 </DD>\r
 592 </DL>\r
 593 <HR>\r
 594 \r
 595 <A NAME="getAllWorkSheets(boolean)"><!-- --></A><H3>\r
 596 getAllWorkSheets</H3>\r
 597 <PRE>\r
 598 public java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt; <B>getAllWorkSheets</B>(boolean&nbsp;doRefresh)</PRE>\r
 599 <DL>\r
 600 <DD>It will retrieve all WorkSheets of this SpreadSheet either from Server or from Local Cache\r
 601 <P>\r
 602 <DD><DL>\r
 603 <DT><B>Parameters:</B><DD><CODE>doRefresh</CODE> - Do you want to Synch with Server ?\r
 604 <DT><B>Returns:</B><DD>list of available WorkSheets</DL>\r
 605 </DD>\r
 606 </DL>\r
 607 <HR>\r
 608 \r
 609 <A NAME="getWorkSheet(java.lang.String, boolean)"><!-- --></A><H3>\r
 610 getWorkSheet</H3>\r
 611 <PRE>\r
 612 public java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt; <B>getWorkSheet</B>(java.lang.String&nbsp;title,\r
 613                                                    boolean&nbsp;isTitleExact)</PRE>\r
 614 <DL>\r
 615 <DD>It will retrieve WorkSheets with matching title from Server\r
 616 <P>\r
 617 <DD><DL>\r
 618 <DT><B>Parameters:</B><DD><CODE>title</CODE> - SpreadSheet title. <b>null</b> means all SpreadSheets. No need to do URL encode.<DD><CODE>isTitleExact</CODE> - whether title string should be an exact match\r
 619 <DT><B>Returns:</B><DD></DL>\r
 620 </DD>\r
 621 </DL>\r
 622 <HR>\r
 623 \r
 624 <A NAME="getAllWorkSheets(boolean, java.lang.String, boolean)"><!-- --></A><H3>\r
 625 getAllWorkSheets</H3>\r
 626 <PRE>\r
 627 public java.util.ArrayList&lt;<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&gt; <B>getAllWorkSheets</B>(boolean&nbsp;doRefresh,\r
 628                                                        java.lang.String&nbsp;title,\r
 629                                                        boolean&nbsp;isTitleExact)</PRE>\r
 630 <DL>\r
 631 <DD>It will retrieve WorkSheets with matching title either from Server or from Local Cache\r
 632 <P>\r
 633 <DD><DL>\r
 634 <DT><B>Parameters:</B><DD><CODE>doRefresh</CODE> - Do you want to Synch with Server ?<DD><CODE>title</CODE> - SpreadSheet title. <b>null</b> means all SpreadSheets. No need to do URL encode.<DD><CODE>isTitleExact</CODE> - Whether title string should be an exact match\r
 635 <DT><B>Returns:</B><DD>list of available WorkSheets</DL>\r
 636 </DD>\r
 637 </DL>\r
 638 <HR>\r
 639 \r
 640 <A NAME="deleteWorkSheet(com.pras.WorkSheet)"><!-- --></A><H3>\r
 641 deleteWorkSheet</H3>\r
 642 <PRE>\r
 643 public void <B>deleteWorkSheet</B>(<A HREF="../../com/pras/WorkSheet.html" title="class in com.pras">WorkSheet</A>&nbsp;wk)</PRE>\r
 644 <DL>\r
 645 <DD>Delete this WorkSheet\r
 646 <P>\r
 647 <DD><DL>\r
 648 <DT><B>Parameters:</B><DD><CODE>wk</CODE> - WorkSheet to be deleted</DL>\r
 649 </DD>\r
 650 </DL>\r
 651 <!-- ========= END OF CLASS DATA ========= -->\r
 652 <HR>\r
 653 \r
 654 \r
 655 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 656 <A NAME="navbar_bottom"><!-- --></A>\r
 657 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 658 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 659 <TR>\r
 660 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 661 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 662 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 663   <TR ALIGN="center" VALIGN="top">\r
 664   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 665   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 666   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 667   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpreadSheet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 668   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 669   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 670   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 671   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 672   </TR>\r
 673 </TABLE>\r
 674 </TD>\r
 675 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 676 </EM>\r
 677 </TD>\r
 678 </TR>\r
 679 \r
 680 <TR>\r
 681 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 682 &nbsp;<A HREF="../../com/pras/Log.html" title="class in com.pras"><B>PREV CLASS</B></A>&nbsp;\r
 683 &nbsp;<A HREF="../../com/pras/SpreadSheetFactory.html" title="class in com.pras"><B>NEXT CLASS</B></A></FONT></TD>\r
 684 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 685   <A HREF="../../index.html?com/pras/SpreadSheet.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 686 &nbsp;<A HREF="SpreadSheet.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 687 &nbsp;<SCRIPT type="text/javascript">\r
 688   <!--\r
 689   if(window==top) {\r
 690     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 691   }\r
 692   //-->\r
 693 </SCRIPT>\r
 694 <NOSCRIPT>\r
 695   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 696 </NOSCRIPT>\r
 697 \r
 698 \r
 699 </FONT></TD>\r
 700 </TR>\r
 701 <TR>\r
 702 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 703   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 704 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 705 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 706 </TR>\r
 707 </TABLE>\r
 708 <A NAME="skip-navbar_bottom"></A>\r
 709 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 710 \r
 711 <HR>\r
 712 \r
 713 </BODY>\r
 714 </HTML>\r