205 lines
14 KiB
HTML
205 lines
14 KiB
HTML
|
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head><title>Python: module telemetry.page.actions.page_action</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>.page_action</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/page_action.py">telemetry/page/actions/page_action.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="#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="__builtin__.html#object">__builtin__.object</a>
|
||
|
|
</font></dt><dd>
|
||
|
|
<dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageAction">PageAction</a>
|
||
|
|
</font></dt></dl>
|
||
|
|
</dd>
|
||
|
|
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
|
||
|
|
</font></dt><dd>
|
||
|
|
<dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageActionFailed">PageActionFailed</a>
|
||
|
|
</font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.actions.page_action.html#PageActionNotSupported">PageActionNotSupported</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="PageAction">class <strong>PageAction</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||
|
|
|
||
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
|
|
<td colspan=2><tt>Represents an action that a user might try to perform to a page.<br> </tt></td></tr>
|
||
|
|
<tr><td> </td>
|
||
|
|
<td width="100%">Methods defined here:<br>
|
||
|
|
<dl><dt><a name="PageAction-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="PageAction-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="PageAction-CleanUp"><strong>CleanUp</strong></a>(self, page, tab)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageAction-CustomizeBrowserOptions"><strong>CustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Override to add action-specific options to the BrowserOptions<br>
|
||
|
|
<a href="__builtin__.html#object">object</a>.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageAction-RunAction"><strong>RunAction</strong></a>(self, page, tab, previous_action)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageAction-RunsPreviousAction"><strong>RunsPreviousAction</strong></a>(self)</dt><dd><tt>Some actions require some initialization to be performed before the<br>
|
||
|
|
previous action. For example, wait for href change needs to record the old<br>
|
||
|
|
href before the previous action changes it. Therefore, we allow actions to<br>
|
||
|
|
run the previous action. An action that does this should override this to<br>
|
||
|
|
return True in order to prevent the previous action from being run twice.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageAction-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="PageAction-__init__"><strong>__init__</strong></a>(self, attributes<font color="#909090">=None</font>)</dt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors defined here:<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> <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="PageActionFailed">class <strong>PageActionFailed</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</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.page_action.html#PageActionFailed">PageActionFailed</a></dd>
|
||
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
||
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
Data descriptors defined here:<br>
|
||
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
||
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||
|
|
<dl><dt><a name="PageActionFailed-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionFailed-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><a name="PageActionFailed-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||
|
|
<br>
|
||
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionFailed-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionFailed-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><strong>__dict__</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>args</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>message</strong></dt>
|
||
|
|
</dl>
|
||
|
|
</td></tr></table> <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="PageActionNotSupported">class <strong>PageActionNotSupported</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</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.page_action.html#PageActionNotSupported">PageActionNotSupported</a></dd>
|
||
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
||
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
Data descriptors defined here:<br>
|
||
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
||
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#PageActionNotSupported-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||
|
|
<br>
|
||
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#PageActionNotSupported-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="PageActionNotSupported-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><strong>__dict__</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>args</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>message</strong></dt>
|
||
|
|
</dl>
|
||
|
|
</td></tr></table></td></tr></table>
|
||
|
|
</body></html>
|