Package nevow :: Module rend :: Class Page
[show private | hide private]
[frames | no frames]

Type Page

FreeformChildMixin --+    
                     |    
      ChildLookupMixin --+
                         |
   ConfigurableFactory --+
                         |
        object --+       |
                 |       |
 ConfigurableMixin --+   |
                     |   |
        object --+   |   |
                 |   |   |
       DataFactory --+   |
                     |   |
        object --+   |   |
                 |   |   |
      MacroFactory --+   |
                     |   |
        object --+   |   |
                 |   |   |
     RenderFactory --+   |
                     |   |
              Fragment --+
                         |
                        Page

Known Subclasses:
AddPage, ConfirmChange, ConfirmDelete, DefaultSkin, EditPage, GetDN, GetDN, LdaptorWebUIGadget, LdaptorWebUIGadget2, LoginPage, MassPasswordChangePage, MovePage, ReallyAddPage, ReallyEditPage, ReallyMassPasswordChangePage, SearchPage

A page is the main Nevow resource and renders a document loaded via the document factory (docFactory).
Method Summary
  child_(self, ctx)
When addSlash is True, a page rendered at a url with no trailing slash and a page rendered at a url with a trailing slash will be identical.
  flattenFactory(self, *args)
  onPostFailure(self, reason, request, ctx, bindingName, redirectAfterPost)
  onPostSuccess(self, result, request, ctx, bindingName, redirectAfterPost)
  rememberStuff(self, ctx)
  renderHTTP(self, ctx)
  renderString(self, ctx)
Render this page outside of the context of a web request, returning a Deferred which will result in a string.
  renderSynchronously(self, ctx)
Render this page synchronously, returning a string result immediately.
  webFormPost(self, request, res, configurable, ctx, bindingName, args)
Accept a web form post, either redisplaying the original form (with errors) if validation fails, or redirecting to the appropriate location after the post succeeds.
  _renderHTTP(self, ctx)
    Inherited from Fragment
  __init__(self, original, docFactory)
  get(self, context)
  remember(self, obj, inter)
Remember an object for an interface on new PageContexts which are constructed around this Page.
  rend(self, context, data)
    Inherited from DataFactory
  child(self, context, n)
    Inherited from RenderFactory
  render_data(self, context, data_)
  render_mapping(self, context, data)
  render_sequence(self, context, data)
  render_string(self, context, data)
  render_xml(self, context, data)
  renderer(self, context, name)
Return a renderer with the given name.
    Inherited from MacroFactory
  macro(self, ctx, name)
Return a macro with the given name.
    Inherited from ConfigurableMixin
  getBinding(self, ctx, name)
Massage bind_* methods and attributes into an IBinding.
  getBindingNames(self, ctx)
Expose bind_* methods and attributes on this class.
  getDefault(self, forBinding)
Get a default value for a given binding.
  postForm(self, ctx, bindingName, args)
Accept a form post to the given bindingName.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)
    Inherited from ConfigurableFactory
  configurable_(self, context)
Configurable factory for use when self is a configurable; aka it implements IConfigurable or one or more TypedInterface subclasses.
  configurable_original(self, ctx)
Configurable factory for use when self.original is a configurable; aka it implements IConfigurable or one or more TypedInterface subclasses.
  locateConfigurable(self, context, name)
formless.webform.renderForms calls locateConfigurable on the IConfigurableFactory instance it retrieves from the context.
    Inherited from ChildLookupMixin
  childFactory(self, ctx, name)
Used by locateChild to return children which are generated dynamically.
  locateChild(self, ctx, segments)
Locate a child page of this one.
  putChild(self, name, child)
    Inherited from FreeformChildMixin
  child_freeform_hand(self, ctx)

Class Variable Summary
Implements __implemented__ = <implementedBy nevow.rend.Page>
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
NoneType addSlash = None                                                                  
NoneType afterRender = None                                                                  
NoneType beforeRender = None                                                                  
bool buffered = False
    Inherited from Fragment
NoneType docFactory = None                                                                  
NoneType original = None                                                                  
    Inherited from DataFactory
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
    Inherited from ChildLookupMixin
NoneType children = None                                                                  

Method Details

child_(self, ctx)

When addSlash is True, a page rendered at a url with no trailing slash and a page rendered at a url with a trailing slash will be identical. addSlash is useful for the root resource of a site or directory-like resources.

renderString(self, ctx=None)

Render this page outside of the context of a web request, returning a Deferred which will result in a string.

If twisted is not installed, this method will return a string result immediately, and this method is equivalent to renderSynchronously.

renderSynchronously(self, ctx=None)

Render this page synchronously, returning a string result immediately. Raise an exception if a Deferred is required to complete the rendering process.

webFormPost(self, request, res, configurable, ctx, bindingName, args)

Accept a web form post, either redisplaying the original form (with errors) if validation fails, or redirecting to the appropriate location after the post succeeds. This hook exists specifically for formless.

New in 0.5, _nevow_carryover_ is only used if an autocallable method returns a result that needs to be carried over.

New in 0.5, autocallables may return a nevow.url.URL or URLOverlay instance rather than setting IRedirectAfterPost on the request.

New in 0.5, autocallables may return a Page instance to have that Page instance rendered at the post target URL with no redirects at all. Useful for multi-step wizards.

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy nevow.rend.Page>                                        

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x40a7d5cc>       

addSlash

Type:
NoneType
Value:
None                                                                  

afterRender

Type:
NoneType
Value:
None                                                                  

beforeRender

Type:
NoneType
Value:
None                                                                  

buffered

Type:
bool
Value:
False                                                                  

Generated by Epydoc 2.1 on Sun Oct 1 10:49:45 2006 http://epydoc.sf.net