telemetry.page.actions.page_action
index
telemetry/page/actions/page_action.py

# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

 
Classes
       
__builtin__.object
PageAction
exceptions.Exception(exceptions.BaseException)
PageActionFailed
PageActionNotSupported

 
class PageAction(__builtin__.object)
    Represents an action that a user might try to perform to a page.
 
  Methods defined here:
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
 
A measurement can call this method to provide the action
with JavaScript code that starts and stops measurements. The action
determines when to execute the provided JavaScript code, for more accurate
timings.
 
Args:
  tab: The tab to do everything on.
  start_js: JavaScript code that starts measurements.
  stop_js: JavaScript code that stops measurements.
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
to return True so that a test knows it can bind measurements.
CleanUp(self, page, tab)
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
object.
RunAction(self, page, tab, previous_action)
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
previous action. For example, wait for href change needs to record the old
href before the previous action changes it. Therefore, we allow actions to
run the previous action. An action that does this should override this to
return True in order to prevent the previous action from being run twice.
WillRunAction(self, page, tab)
Override to do action-specific setup before
Test.WillRunAction is called.
__init__(self, attributes=None)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class PageActionFailed(exceptions.Exception)
    
Method resolution order:
PageActionFailed
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class PageActionNotSupported(exceptions.Exception)
    
Method resolution order:
PageActionNotSupported
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message