Package qm :: Package test :: Package web :: Module web :: Class QMTestPage
[hide private]
[frames] | no frames]

Class QMTestPage
source code

web.DtmlPage --+    
               |    
 DefaultDtmlPage --+
                   |
                  QMTestPage
Known Subclasses:
ContextPage, DirPage, LoadContextPage, LoadExpectationsPage, LoadResultsPage, NewItemPage, NewSuitePage, ResultPage, SetExpectationPage, ShowItemPage, ShowSuitePage, TestResultsPage

A 'QMTestPage' is a 'DtmlPage' for pages generated by QMTest.

A 'QMTestPage' automatically looks for DTML templates in the directory that contains QMTest DTML templates.

Nested Classes [hide private]

Inherited from web.DtmlPage: default_class


Instance Methods [hide private]
  __init__(self, dtml_template, server)
Construct a new 'QMTestPage'.
  GenerateStartBody(self, decorations=1)
Return markup to start the body of the HTML document.
  IsFinished(self)
Return true iff no more results are forthcoming.
  GetRefreshDelay(self)
Returns the number of seconds to wait before refreshing the page.
  GenerateHtmlHeader(self, description, headers="")
Return the header for an HTML document.
  GetExpectationUrl(self, id, expectation)
Return the URL for setting the expectation associated with 'id'.

Inherited from DefaultDtmlPage: FormatId, GetDatabase, GetMainPageUrl, GetName, GetOutcomePercentages, GetResultsByOutcome, HasModifiableExpectations, IsLabelInDirectory, MakeListingUrl

Inherited from web.DtmlPage: GenerateEndBody, GenerateEndScript, GenerateStartScript, GenerateXMLHeader, GetProgramName, MakeButton, MakeImageUrl, MakeLoginForm, MakeRule, MakeSpacer, UserIsInGroup, WebRequest, __call__


Class Variables [hide private]

Inherited from DefaultDtmlPage: EXPECTATION_KINDS, EXPECTED, NEGATIVE_UNEXPECTED, POSITIVE_UNEXPECTED, html_generator, outcomes

Inherited from web.DtmlPage: common_javascript, html_stylesheet, qm_bug_system_url, web


Method Details [hide private]

__init__(self, dtml_template, server)
(Constructor)

source code 

Construct a new 'QMTestPage'.

'dtml_template' -- The file name of the DTML template, relative to the directory that contains QMTest DTML templates. (Usually, this is just a basename.)

'server' -- The 'QMTestServer' creating this page.
Overrides: DefaultDtmlPage.__init__

GenerateStartBody(self, decorations=1)

source code 
Return markup to start the body of the HTML document.
Overrides: web.DtmlPage.GenerateStartBody
(inherited documentation)

IsFinished(self)

source code 

Return true iff no more results are forthcoming.

returns -- True if no more tests are running.

GetRefreshDelay(self)

source code 

Returns the number of seconds to wait before refreshing the page.

returns -- The number of seconds to wait before refreshing this page. A value of zero means that te page should never be refreshed. This function is only called if 'IsFinished' returns true.

GenerateHtmlHeader(self, description, headers="")

source code 

Return the header for an HTML document.

'description' -- A string describing this page.

'headers' -- Any additional HTML headers to place in the '<head>' section of the HTML document.
Overrides: web.DtmlPage.GenerateHtmlHeader

GetExpectationUrl(self, id, expectation)

source code 

Return the URL for setting the expectation associated with 'id'.

'id' -- The name of a test.

'expectation' -- The current expectation associated with the test, or 'None' if there is no associated expectation.