Inheritance diagram for WebPage.HelloWorld:

Collaboration diagram for WebPage.HelloWorld:

Public Member Functions
	content (self)
	pageName (self)
	addPage (self, name, page, **attrs)
	addLink (self, name, alias, **attrs)
	addToPageHeader (self, snippet)
	index (self, **args)
	configure (self)
	configureLinks (self)
	override (self)
	header (self, **args)
	navigation (self, **args)
	footer (self, **args)

Public Attributes
dict	pageConfig
	globalConfig = GlobalConfiguration()
bool	isConfigured = False

Static Public Attributes
	exposed

Detailed Description

Definition at line 423 of file WebPage.py.

Member Function Documentation

◆ addLink()

WebPage.WebPage.addLink	(		self,
			name,
			alias,
		**	attrs )

inherited

Add a new link to the page tree. Links share page objects with
   other pages through aliasing. This allows using different links
   with different queries to the same page as if they were separate
   pages. For links, highlighting of the current page is disabled
   (if enabled, all links leading to the same page would be
   highlighted).

Definition at line 309 of file WebPage.py.

    def addLink(self, name, alias, **attrs):
        """Add a new link to the page tree. Links share page objects with
           other pages through aliasing. This allows using different links
           with different queries to the same page as if they were separate
           pages. For links, highlighting of the current page is disabled
           (if enabled, all links leading to the same page would be
           highlighted)."""
        self.globalConfig.pageList.append(name)
        self.globalConfig.pageAttributes[name] = dict(attrs)
        self.globalConfig.pageAttributes[name]['alias'] = alias
       

◆ addPage()

WebPage.WebPage.addPage	(		self,
			name,
			page,
		**	attrs )

inherited

Add a new web page to the page tree. All pages added via addPage
   share the same GlobalConfiguration object.

Definition at line 300 of file WebPage.py.

    def addPage(self, name, page, **attrs):
        """Add a new web page to the page tree. All pages added via addPage
           share the same GlobalConfiguration object."""
        page.globalConfig = self.globalConfig
        page.pageConfig['pageName'] = name
        self.globalConfig.pageList.append(name)
        self.globalConfig.pageAttributes[name] = dict(attrs)
        setattr(self,name,page)   # Link page into page tree (for CherryPy)
 

◆ addToPageHeader()

WebPage.WebPage.addToPageHeader	(		self,
			snippet )

inherited

Add a snippet of code to the page header. Use this e.g. to include JavaScript libraries.

Definition at line 320 of file WebPage.py.

    def addToPageHeader(self, snippet):
        """Add a snippet of code to the page header. Use this e.g. to include JavaScript libraries."""
        self.pageConfig['pageHeaderSnippets'] += snippet
 

◆ configure()

WebPage.WebPage.configure ( self )

inherited

Final configuration of web application after all data is initialized.

Reimplemented in BeamSpotWebPage.BeamSpotWebPage.

Definition at line 347 of file WebPage.py.

    def configure(self):
        """Final configuration of web application after all data is initialized."""
        self.configureLinks()
        self.isConfigured = True
        return
 

◆ configureLinks()

WebPage.WebPage.configureLinks ( self )

inherited

Based on configuration data, for each web page create two link entries in pageConfig:
   The first entry has the form url_PAGENAME and contains the complete URL to link to
   a page. The second entry is named href_PAGENAME and contains style information and a
   href= prefix with proper quotation marks in addition to the URL. These link entries
   should be used to generate links in HTML pages with snippets like <a %(href_PAGENAME)s>
   or <a href="%(url_PAGENAME)>. The link entries can only be generated once all
   configuration data is available, ie configureLinks must be called from configure
   and not from __init__.

Definition at line 353 of file WebPage.py.

    def configureLinks(self):
        """Based on configuration data, for each web page create two link entries in pageConfig:
           The first entry has the form url_PAGENAME and contains the complete URL to link to
           a page. The second entry is named href_PAGENAME and contains style information and a
           href= prefix with proper quotation marks in addition to the URL. These link entries
           should be used to generate links in HTML pages with snippets like <a %(href_PAGENAME)s>
           or <a href="%(url_PAGENAME)>. The link entries can only be generated once all
           configuration data is available, ie configureLinks must be called from configure
           and not from __init__."""
        for p in self.globalConfig.pageList:
            page = self.globalConfig.pageAttributes[p].get('alias',p)
            query = self.globalConfig.pageAttributes[p].get('query','')
            style = self.globalConfig.pageAttributes[p].get('style',None)
            self.pageConfig['url_'+p] = '%s/%s/%s' % (self.globalConfig.baseUrl,page,query)
            if p==self.pageName():
                self.pageConfig['href_'+p] = 'href="%s/%s/%s" class="%s"' % (self.globalConfig.baseUrl,page,query,self.pageConfig['css_currentLink'])
            else:
                if style:
                    self.pageConfig['href_'+p] = 'href="%s/%s/%s" class="%s"' % (self.globalConfig.baseUrl,page,query,style)
                else:
                    self.pageConfig['href_'+p] = 'href="%s/%s/%s"' % (self.globalConfig.baseUrl,page,query)
 

◆ content()

WebPage.HelloWorld.content ( self )

Generate the page content. Default value comes from self.pageConfig['content'].

Reimplemented from WebPage.WebPage.

Definition at line 424 of file WebPage.py.

        def content(self):
            return "Hello, world!"
 
    # For plain CGI

◆ footer()

WebPage.WebPage.footer	(		self,
		**	args )

inherited

Generate the footer. Default value comes from self.pageConfig['footer'].

Definition at line 395 of file WebPage.py.

    def footer(self, **args):
        """Generate the footer. Default value comes from self.pageConfig['footer']."""
        return self.pageConfig['footer'] % self.pageConfig
 
 
# Example configuration file on how to run CherryPy with Apache mod_python:
#
#  <Location "/">
#      PythonPath "sys.path+['/whatever']"
#      SetHandler python-program
#      PythonHandler cherrypy._cpmodpy::handler
#      PythonOption cherrypy.setup WebPage::setup_server
#      PythonDebug On
#  </Location>
#
#import cherrypy
#def setup_server():
#    cherrypy.config.update({'environment': 'production',
#                            'log.screen': False,
#                            'server.socket_host': '127.0.0.1',
#                            'log.error_file': '/tmp/site.log',
#                            'show_tracebacks': False})
#    cherrypy.tree.mount(WebPage())
 
 
# Test code

◆ header()

WebPage.WebPage.header	(		self,
		**	args )

inherited

Generate the page header. Default value comes from self.pageConfig['header'].

Definition at line 383 of file WebPage.py.

    def header(self, **args):
        """Generate the page header. Default value comes from self.pageConfig['header']."""
        return self.pageConfig['header'] % self.pageConfig
 

◆ index()

WebPage.WebPage.index	(		self,
		**	args )

inherited

Return the complete page.

Definition at line 324 of file WebPage.py.

    def index(self, **args):
        """Return the complete page."""
        if not self.isConfigured:
            self.configure()
        s = self.override()
        if not s:
            self.pageConfig['timeStamp'] = time.strftime('%a %b %d %X %Z %Y')
            contents = self.content(**args)  # Make sure contents is run first (so it
                                             # can change any pageConfig entries if desired
            s = startPage % self.pageConfig
            s = s + htmlDiv('header', self.header(**args),
                            keepEmptyDiv=self.pageConfig['keepEmptyHeader'])
            s = s + htmlDiv('navigation', self.navigation(**args),
                            keepEmptyDiv=self.pageConfig['keepEmptyNavigation'])
            s = s + htmlDiv('content', contents,
                            keepEmptyDiv=self.pageConfig['keepEmptyContent'])
            s = s + htmlDiv('footer', self.footer(**args),
                            keepEmptyDiv=self.pageConfig['keepEmptyFooter'])
            s = s + endPage
        return s

◆ navigation()

WebPage.WebPage.navigation	(		self,
		**	args )

inherited

Generate the navigation bar. Default value comes from self.pageConfig['navigation'].

Definition at line 387 of file WebPage.py.

    def navigation(self, **args):
        """Generate the navigation bar. Default value comes from self.pageConfig['navigation']."""
        return self.pageConfig['navigation'] % self.pageConfig
 

◆ override()

WebPage.WebPage.override ( self )

inherited

Override provides a hook where code to generate or redirect to an alternative
   page can be placed by derived classes. If not override of the normal page is
   desired, override should return None. Otherwise it should either raise an
   appropriate exception or return a string containing the complete alternate page
   to display.

Definition at line 375 of file WebPage.py.

    def override(self):
        """Override provides a hook where code to generate or redirect to an alternative
           page can be placed by derived classes. If not override of the normal page is
           desired, override should return None. Otherwise it should either raise an
           appropriate exception or return a string containing the complete alternate page
           to display."""
        return None
 

◆ pageName()

WebPage.WebPage.pageName ( self )

inherited

Short cut to retrieve the name (the last element in the URL)
   of the current page. This works only if the page has been
   added into the page tree using addPage.

Definition at line 294 of file WebPage.py.

    def pageName(self):
        """Short cut to retrieve the name (the last element in the URL)
           of the current page. This works only if the page has been
           added into the page tree using addPage."""
        return self.pageConfig['pageName']
 

Member Data Documentation

◆ exposed

WebPage.WebPage.exposed

staticinherited

Definition at line 345 of file WebPage.py.

◆ globalConfig

WebPage.WebPage.globalConfig = GlobalConfiguration()

inherited

Definition at line 290 of file WebPage.py.

◆ isConfigured

bool WebPage.WebPage.isConfigured = False

inherited

Definition at line 291 of file WebPage.py.

◆ pageConfig

dict WebPage.WebPage.pageConfig

inherited

Initial value:

=  { 'contentType':         '',    # For plain CGI need:  'Content-type: text/html\n\n'
                            'pageName':            '',
                            'pageTitle':           '',
                            'pageHeaderSnippets':  '',
                            'cssName':             'default.css',
                            'css_currentLink':     'acurrentlink',
                            'header':              '',
                            'navigation':          '',
                            'content':             '',
                            'footer':              '',
                            'keepEmptyHeader':     False, # Set to true to anyway generate div if empty
                            'keepEmptyNavigation': False,
                            'keepEmptyContent':    False,
                            'keepEmptyFooter':     False
                            }

Definition at line 273 of file WebPage.py.

The documentation for this class was generated from the following file:

WebPage.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ addLink()

◆ addPage()

◆ addToPageHeader()

◆ configure()

◆ configureLinks()

◆ content()

◆ footer()

◆ header()

◆ index()

◆ navigation()

◆ override()

◆ pageName()

Member Data Documentation

◆ exposed

◆ globalConfig

◆ isConfigured

◆ pageConfig