tools/telemetry/docs/telemetry.page.actions.wait.html - platform/external/chromium_org - Git at Google


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: module telemetry.page.actions.wait</title>
 </head><body bgcolor="#f0f0f8">

 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
 <tr bgcolor="#7799ee">
 <td valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.wait</strong></big></big></font></td
 ><td align=right valign=bottom
 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/actions/wait.py">telemetry/page/actions/wait.py</a></font></td></tr></table>
     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#aa55cc">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br>
 </td><td width="25%" valign=top><a href="re.html">re</a><br>
 </td><td width="25%" valign=top><a href="time.html">time</a><br>
 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br>
 </td></tr></table></td></tr></table><p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ee77aa">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><dl>
 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
 </font></dt><dd>
 <dl>
 <dt><font face="helvetica, arial"><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a>
 </font></dt></dl>
 </dd>
 </dl>
  <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="WaitAction">class <strong>WaitAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>

 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><dl><dt>Method resolution order:</dt>
 <dd><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a></dd>
 <dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd>
 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 </dl>
 <hr>
 Methods defined here:<br>
 <dl><dt><a name="WaitAction-RunAction"><strong>RunAction</strong></a>(self, page, tab)</dt></dl>

 <dl><dt><a name="WaitAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl>

 <hr>
 Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
 <dl><dt><a name="WaitAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let&nbsp;this&nbsp;action&nbsp;determine&nbsp;when&nbsp;measurements&nbsp;should&nbsp;start&nbsp;and&nbsp;stop.<br>
 &nbsp;<br>
 A&nbsp;measurement&nbsp;can&nbsp;call&nbsp;this&nbsp;method&nbsp;to&nbsp;provide&nbsp;the&nbsp;action<br>
 with&nbsp;JavaScript&nbsp;code&nbsp;that&nbsp;starts&nbsp;and&nbsp;stops&nbsp;measurements.&nbsp;The&nbsp;action<br>
 determines&nbsp;when&nbsp;to&nbsp;execute&nbsp;the&nbsp;provided&nbsp;JavaScript&nbsp;code,&nbsp;for&nbsp;more&nbsp;accurate<br>
 timings.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;tab:&nbsp;The&nbsp;tab&nbsp;to&nbsp;do&nbsp;everything&nbsp;on.<br>
 &nbsp;&nbsp;start_js:&nbsp;JavaScript&nbsp;code&nbsp;that&nbsp;starts&nbsp;measurements.<br>
 &nbsp;&nbsp;stop_js:&nbsp;JavaScript&nbsp;code&nbsp;that&nbsp;stops&nbsp;measurements.</tt></dd></dl>

 <dl><dt><a name="WaitAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If&nbsp;this&nbsp;class&nbsp;implements&nbsp;BindMeasurementJavaScript,&nbsp;override&nbsp;CanBeBound<br>
 to&nbsp;return&nbsp;True&nbsp;so&nbsp;that&nbsp;a&nbsp;test&nbsp;knows&nbsp;it&nbsp;can&nbsp;bind&nbsp;measurements.</tt></dd></dl>

 <dl><dt><a name="WaitAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>

 <dl><dt><a name="WaitAction-CustomizeBrowserOptionsForPageSet"><strong>CustomizeBrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;action-specific&nbsp;options&nbsp;to&nbsp;the&nbsp;BrowserOptions<br>
 object.&nbsp;These&nbsp;options&nbsp;will&nbsp;be&nbsp;set&nbsp;for&nbsp;the&nbsp;whole&nbsp;page&nbsp;set.<br>
 &nbsp;<br>
 If&nbsp;the&nbsp;browser&nbsp;is&nbsp;not&nbsp;being&nbsp;restarted&nbsp;for&nbsp;every&nbsp;page&nbsp;in&nbsp;the&nbsp;page&nbsp;set&nbsp;then<br>
 all&nbsp;browser&nbsp;options&nbsp;required&nbsp;for&nbsp;the&nbsp;action&nbsp;must&nbsp;be&nbsp;set&nbsp;here.&nbsp;This,&nbsp;however,<br>
 requires&nbsp;that&nbsp;they&nbsp;do&nbsp;not&nbsp;conflict&nbsp;with&nbsp;options&nbsp;require&nbsp;by&nbsp;other&nbsp;actions<br>
 used&nbsp;up&nbsp;by&nbsp;the&nbsp;page&nbsp;set.</tt></dd></dl>

 <dl><dt><a name="WaitAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOnTimeline</strong></a>(self, timeline)</dt></dl>

 <dl><dt><a name="WaitAction-RunActionAndMaybeWait"><strong>RunActionAndMaybeWait</strong></a>(self, page, tab)</dt></dl>

 <dl><dt><a name="WaitAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override&nbsp;to&nbsp;do&nbsp;action-specific&nbsp;setup&nbsp;before<br>
 Test.WillRunAction&nbsp;is&nbsp;called.</tt></dd></dl>

 <dl><dt><a name="WaitAction-WillWaitAfterRun"><strong>WillWaitAfterRun</strong></a>(self)</dt></dl>

 <hr>
 Static methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
 <dl><dt><a name="WaitAction-ResetNextTimelineMarkerId"><strong>ResetNextTimelineMarkerId</strong></a>()</dt></dl>

 <hr>
 Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table></td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: module telemetry.page.actions.wait</title>
	</head><body bgcolor="#f0f0f8">

	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
	<tr bgcolor="#7799ee">
	<td valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.<a href="telemetry.page.actions.html"><font color="#ffffff">actions</font></a>.wait</strong></big></big></font></td
	><td align=right valign=bottom
	><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/actions/wait.py">telemetry/page/actions/wait.py</a></font></td></tr></table>
	<p><tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.<br>
	# Use of this source code is governed by a BSD-style license that can be<br>
	# found in the LICENSE file.</tt></p>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#aa55cc">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

	<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>
	<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.page.actions.page_action.html">telemetry.page.actions.page_action</a><br>
	</td><td width="25%" valign=top><a href="re.html">re</a><br>
	</td><td width="25%" valign=top><a href="time.html">time</a><br>
	</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br>
	</td></tr></table></td></tr></table><p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ee77aa">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

	<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>
	<td width="100%"><dl>
	<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
	</font></dt><dd>
	<dl>
	<dt><font face="helvetica, arial"><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a>
	</font></dt></dl>
	</dd>
	</dl>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="WaitAction">class <strong>WaitAction</strong></a>(<a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>)</font></td></tr>

	<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>
	<td width="100%"><dl><dt>Method resolution order:</dt>
	<dd><a href="telemetry.page.actions.wait.html#WaitAction">WaitAction</a></dd>
	<dd><a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a></dd>
	<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
	</dl>
	<hr>
	Methods defined here:<br>
	<dl><dt><a name="WaitAction-RunAction"><strong>RunAction</strong></a>(self, page, tab)</dt></dl>

	<dl><dt><a name="WaitAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl>

	<hr>
	Methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
	<dl><dt><a name="WaitAction-BindMeasurementJavaScript"><strong>BindMeasurementJavaScript</strong></a>(self, tab, start_js, stop_js)</dt><dd><tt>Let this action determine when measurements should start and stop.<br>
	<br>
	A measurement can call this method to provide the action<br>
	with JavaScript code that starts and stops measurements. The action<br>
	determines when to execute the provided JavaScript code, for more accurate<br>
	timings.<br>
	<br>
	Args:<br>
	tab: The tab to do everything on.<br>
	start_js: JavaScript code that starts measurements.<br>
	stop_js: JavaScript code that stops measurements.</tt></dd></dl>

	<dl><dt><a name="WaitAction-CanBeBound"><strong>CanBeBound</strong></a>(self)</dt><dd><tt>If this class implements BindMeasurementJavaScript, override CanBeBound<br>
	to return True so that a test knows it can bind measurements.</tt></dd></dl>

	<dl><dt><a name="WaitAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>

	<dl><dt><a name="WaitAction-CustomizeBrowserOptionsForPageSet"><strong>CustomizeBrowserOptionsForPageSet</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br>
	object. These options will be set for the whole page set.<br>
	<br>
	If the browser is not being restarted for every page in the page set then<br>
	all browser options required for the action must be set here. This, however,<br>
	requires that they do not conflict with options require by other actions<br>
	used up by the page set.</tt></dd></dl>

	<dl><dt><a name="WaitAction-GetActiveRangeOnTimeline"><strong>GetActiveRangeOnTimeline</strong></a>(self, timeline)</dt></dl>

	<dl><dt><a name="WaitAction-RunActionAndMaybeWait"><strong>RunActionAndMaybeWait</strong></a>(self, page, tab)</dt></dl>

	<dl><dt><a name="WaitAction-WillRunAction"><strong>WillRunAction</strong></a>(self, page, tab)</dt><dd><tt>Override to do action-specific setup before<br>
	Test.WillRunAction is called.</tt></dd></dl>

	<dl><dt><a name="WaitAction-WillWaitAfterRun"><strong>WillWaitAfterRun</strong></a>(self)</dt></dl>

	<hr>
	Static methods inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
	<dl><dt><a name="WaitAction-ResetNextTimelineMarkerId"><strong>ResetNextTimelineMarkerId</strong></a>()</dt></dl>

	<hr>
	Data descriptors inherited from <a href="telemetry.page.actions.page_action.html#PageAction">telemetry.page.actions.page_action.PageAction</a>:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table></td></tr></table>
	</body></html>