mygpo/web/tests/selenium/selenium-server-1.0.1/javadoc/org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_07) on Tue Jun 09 11:50:57 CDT 2009 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 CaptureScreenshotToStringCommand (Selenium RC Server (Coreless) 1.0.1 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2009-06-09">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     if (location.href.indexOf('is-external=true') == -1) {
  19         parent.document.title="CaptureScreenshotToStringCommand (Selenium RC Server (Coreless) 1.0.1 API)";
  20     }
  21 }
  22 </SCRIPT>
  23 <NOSCRIPT>
  24 </NOSCRIPT>
  25
  26 </HEAD>
  27
  28 <BODY BGCOLOR="white" onload="windowTitle();">
  29 <HR>
  30
  31
  32 <!-- ========= START OF TOP NAVBAR ======= -->
  33 <A NAME="navbar_top"><!-- --></A>
  34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36 <TR>
  37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38 <A NAME="navbar_top_firstrow"><!-- --></A>
  39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40   <TR ALIGN="center" VALIGN="top">
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CaptureScreenshotToStringCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  48   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  49   </TR>
  50 </TABLE>
  51 </TD>
  52 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  53 </EM>
  54 </TD>
  55 </TR>
  56
  57 <TR>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59 &nbsp;<A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotCommand.html" title="class in org.openqa.selenium.server.commands"><B>PREV CLASS</B></A>&nbsp;
  60 &nbsp;<A HREF="../../../../../org/openqa/selenium/server/commands/Command.html" title="class in org.openqa.selenium.server.commands"><B>NEXT CLASS</B></A></FONT></TD>
  61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62   <A HREF="../../../../../index.html?org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63 &nbsp;<A HREF="CaptureScreenshotToStringCommand.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64 &nbsp;<SCRIPT type="text/javascript">
  65   <!--
  66   if(window==top) {
  67     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  68   }
  69   //-->
  70 </SCRIPT>
  71 <NOSCRIPT>
  72   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  73 </NOSCRIPT>
  74
  75
  76 </FONT></TD>
  77 </TR>
  78 <TR>
  79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  82 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  83 </TR>
  84 </TABLE>
  85 <A NAME="skip-navbar_top"></A>
  86 <!-- ========= END OF TOP NAVBAR ========= -->
  87
  88 <HR>
  89 <!-- ======== START OF CLASS DATA ======== -->
  90 <H2>
  91 <FONT SIZE="-1">
  92 org.openqa.selenium.server.commands</FONT>
  93 <BR>
  94 Class CaptureScreenshotToStringCommand</H2>
  95 <PRE>
  96 java.lang.Object
  97   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.openqa.selenium.server.commands.CaptureScreenshotToStringCommand</B>
  98 </PRE>
  99 <HR>
 100 <DL>
 101 <DT><PRE>public class <B>CaptureScreenshotToStringCommand</B><DT>extends java.lang.Object</DL>
 102 </PRE>
 103
 104 <P>
 105 Captures a full screen shot of the current screen using the java.awt.Robot class.
 106  and returns it as a base 64 encoded PNG image.
 107 <P>
 108
 109 <P>
 110 <HR>
 111
 112 <P>
 113 <!-- =========== FIELD SUMMARY =========== -->
 114
 115 <A NAME="field_summary"><!-- --></A>
 116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 118 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 119 <B>Field Summary</B></FONT></TH>
 120 </TR>
 121 <TR BGCOLOR="white" CLASS="TableRowColor">
 122 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 123 <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
 124 <TD><CODE><B><A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html#ID">ID</A></B></CODE>
 125
 126 <BR>
 127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 128 </TR>
 129 </TABLE>
 130 &nbsp;
 131 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 132
 133 <A NAME="constructor_summary"><!-- --></A>
 134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 136 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 137 <B>Constructor Summary</B></FONT></TH>
 138 </TR>
 139 <TR BGCOLOR="white" CLASS="TableRowColor">
 140 <TD><CODE><B><A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html#CaptureScreenshotToStringCommand()">CaptureScreenshotToStringCommand</A></B>()</CODE>
 141
 142 <BR>
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 144 </TR>
 145 </TABLE>
 146 &nbsp;
 147 <!-- ========== METHOD SUMMARY =========== -->
 148
 149 <A NAME="method_summary"><!-- --></A>
 150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 152 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 153 <B>Method Summary</B></FONT></TH>
 154 </TR>
 155 <TR BGCOLOR="white" CLASS="TableRowColor">
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 157 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 158 <TD><CODE><B><A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html#captureAndEncodeSystemScreenshot()">captureAndEncodeSystemScreenshot</A></B>()</CODE>
 159
 160 <BR>
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 166 <TD><CODE><B><A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html#execute()">execute</A></B>()</CODE>
 167
 168 <BR>
 169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 170 </TR>
 171 </TABLE>
 172 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 174 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 175 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 176 </TR>
 177 <TR BGCOLOR="white" CLASS="TableRowColor">
 178 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 179 </TR>
 180 </TABLE>
 181 &nbsp;
 182 <P>
 183
 184 <!-- ============ FIELD DETAIL =========== -->
 185
 186 <A NAME="field_detail"><!-- --></A>
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 189 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 190 <B>Field Detail</B></FONT></TH>
 191 </TR>
 192 </TABLE>
 193
 194 <A NAME="ID"><!-- --></A><H3>
 195 ID</H3>
 196 <PRE>
 197 public static final java.lang.String <B>ID</B></PRE>
 198 <DL>
 199 <DL>
 200 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.openqa.selenium.server.commands.CaptureScreenshotToStringCommand.ID">Constant Field Values</A></DL>
 201 </DL>
 202
 203 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 204
 205 <A NAME="constructor_detail"><!-- --></A>
 206 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 207 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 208 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 209 <B>Constructor Detail</B></FONT></TH>
 210 </TR>
 211 </TABLE>
 212
 213 <A NAME="CaptureScreenshotToStringCommand()"><!-- --></A><H3>
 214 CaptureScreenshotToStringCommand</H3>
 215 <PRE>
 216 public <B>CaptureScreenshotToStringCommand</B>()</PRE>
 217 <DL>
 218 </DL>
 219
 220 <!-- ============ METHOD DETAIL ========== -->
 221
 222 <A NAME="method_detail"><!-- --></A>
 223 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 224 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 225 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 226 <B>Method Detail</B></FONT></TH>
 227 </TR>
 228 </TABLE>
 229
 230 <A NAME="execute()"><!-- --></A><H3>
 231 execute</H3>
 232 <PRE>
 233 public java.lang.String <B>execute</B>()</PRE>
 234 <DL>
 235 <DD><DL>
 236 </DL>
 237 </DD>
 238 </DL>
 239 <HR>
 240
 241 <A NAME="captureAndEncodeSystemScreenshot()"><!-- --></A><H3>
 242 captureAndEncodeSystemScreenshot</H3>
 243 <PRE>
 244 public java.lang.String <B>captureAndEncodeSystemScreenshot</B>()
 245                                                   throws java.lang.InterruptedException,
 246                                                          java.util.concurrent.ExecutionException,
 247                                                          java.util.concurrent.TimeoutException,
 248                                                          java.io.IOException</PRE>
 249 <DL>
 250 <DD><DL>
 251
 252 <DT><B>Throws:</B>
 253 <DD><CODE>java.lang.InterruptedException</CODE>
 254 <DD><CODE>java.util.concurrent.ExecutionException</CODE>
 255 <DD><CODE>java.util.concurrent.TimeoutException</CODE>
 256 <DD><CODE>java.io.IOException</CODE></DL>
 257 </DD>
 258 </DL>
 259 <!-- ========= END OF CLASS DATA ========= -->
 260 <HR>
 261
 262
 263 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 264 <A NAME="navbar_bottom"><!-- --></A>
 265 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 266 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 267 <TR>
 268 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 269 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 270 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 271   <TR ALIGN="center" VALIGN="top">
 272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 273   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 274   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 275   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CaptureScreenshotToStringCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 276   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 277   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 278   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 279   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 280   </TR>
 281 </TABLE>
 282 </TD>
 283 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 284 </EM>
 285 </TD>
 286 </TR>
 287
 288 <TR>
 289 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 290 &nbsp;<A HREF="../../../../../org/openqa/selenium/server/commands/CaptureScreenshotCommand.html" title="class in org.openqa.selenium.server.commands"><B>PREV CLASS</B></A>&nbsp;
 291 &nbsp;<A HREF="../../../../../org/openqa/selenium/server/commands/Command.html" title="class in org.openqa.selenium.server.commands"><B>NEXT CLASS</B></A></FONT></TD>
 292 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 293   <A HREF="../../../../../index.html?org/openqa/selenium/server/commands/CaptureScreenshotToStringCommand.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 294 &nbsp;<A HREF="CaptureScreenshotToStringCommand.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 295 &nbsp;<SCRIPT type="text/javascript">
 296   <!--
 297   if(window==top) {
 298     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 299   }
 300   //-->
 301 </SCRIPT>
 302 <NOSCRIPT>
 303   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 304 </NOSCRIPT>
 305
 306
 307 </FONT></TD>
 308 </TR>
 309 <TR>
 310 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 311   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 312 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 313 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 314 </TR>
 315 </TABLE>
 316 <A NAME="skip-navbar_bottom"></A>
 317 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 318
 319 <HR>
 320 Copyright &#169; 2009. All Rights Reserved.
 321 </BODY>
 322 </HTML>