Package twisted :: Package web :: Package woven :: Module page :: Class Page

[show private | hide private]
[frames | no frames]

## Class Page

                     Model --+
                             |
                   MethodModel --+
                                 |
    Collection --+               |
                 |               |
       Constrained --+           |
                     |           |
      ConfigCollection --+       |
                         |       |
                  Resource --+   |
                             |   |
                    Controller --+
                                 |
                          View --+
                                 |
                                Page

Method Summary
| `__init__(self, *args, **kwargs)`
| `__getstate__(self)` (inherited from `Model`)
| `__setitem__(self, key, value)` (inherited from `View`)
| `addSubview(self, name, subview)` (inherited from `Model`)
| ``addView`(self, view)` Add a view for the model to keep track of. (inherited from `Model`)
| `aggregateInvalid(self, request, input, data)` (inherited from `Controller`)
| `aggregateValid(self, request, input, data)` (inherited from `Controller`)
| `dataWillChange(self)` (inherited from `Model`)
| ``delEntity`(self, name)` Remove a static reference for 'name'. (inherited from `Resource`)
| ``dispatchResult`(self, request, node, result)` Check a given result from handling a node and look up a NodeMutator adapter which will convert the result into a node and insert it into the DOM tree. (inherited from `View`)
| ``dispatchResultCallback`(self, result, request, node)` Deal with a callback from a deferred, dispatching the result and recursing children. (inherited from `View`)
| `domChanged(self, request, widget, node)` (inherited from `Controller`)
| ``entityConstraint`(self, entity)` A method that determines whether an entity may be added to me. (inherited from `ConfigCollection`)
| `gatheredControllers(self, v, d, request)` (inherited from `Controller`)
| ``generate`(self, request, node)` Allow a view to be used like a widget. (inherited from `View`)
| ``getChild`(self, name, request)` Look for a factory method to create the object to handle the next segment of the URL. (inherited from `Controller`)
| ``getChildForRequest`(self, request)` (internal) Get a child of mine dependant on a particular request. (inherited from `Resource`)
| ``getChildWithDefault`(self, path, request)` Retrieve a static or dynamically generated child resource from me. (inherited from `Resource`)
| `getData(self, request)` (inherited from `Model`)
| ``getDynamicChild`(self, name, request)` This method is called when getChild cannot find a matching wchild_* method in the Controller. (inherited from `Controller`)
| ``getDynamicEntity`(self, name, request)` Subclass this to generate an entity on demand. (inherited from `Resource`)
| ``getEntity`(self, name, request)` Retrieve an entity from me. (inherited from `Collection`)
| `getEntityType(self)` (inherited from `ConfigCollection`)
| `getNameType(self)` (inherited from `ConfigCollection`)
| ``getNodeController`(self, request, node, submodel, model)` Get a controller object to handle this node. (inherited from `View`)
| ``getNodeModel`(self, request, node, submodel)` Get the model object associated with this node. (inherited from `View`)
| `getNodeView(self, request, node, submodel, model)` (inherited from `View`)
| ``getStaticEntity`(self, name)` Get an entity that was added to me using putEntity. (inherited from `Resource`)
| `getSubcontroller(self, request, node, model, controllerName)` (inherited from `Controller`)
| ``getSubmodel`(self, request, name)` Get the submodel `name' of this model. (inherited from `MethodModel`)
| ``getSubview`(self, request, node, model, viewName)` Get a sub-view from me. (inherited from `View`)
| ``getTemplate`(self, request)` Override this if you want to have your subclass look up its template using a different method. (inherited from `View`)
| ``handle`(self, request)` By default, we don't do anything (inherited from `Controller`)
| ``handleControllerResults`(self, controllerResult, request, node, controller, view, success)` Handle a deferred from a controller. (inherited from `View`)
| ``handleDocument`(self, request, document)` Handle the root node, and send the page if there are no outstanding callbacks when it returns. (inherited from `View`)
| `handleNewNode(self, request, returnNode)` (inherited from `View`)
| `handleNode(self, request, node)` (inherited from `View`)
| `handleOutstanding(self, request)` (inherited from `View`)
| `importControllerLibrary(self, namespace)` (inherited from `Controller`)
| `importViewLibrary(self, namespace)` (inherited from `View`)
| ``initialize`(self, *args, **kwargs)` Hook for subclasses to initialize themselves without having to mess with the __init__ chain. (inherited from `Model`)
| ``invalidateCache`(self)` Invalidate the cache for this object, so the next time getData is called, it's getter method is called again. (inherited from `Model`)
| ``listDynamicEntities`(self, request)` A list of all name, entity that I can generate on demand. (inherited from `Resource`)
| ``listDynamicNames`(self)` Retrieve a list of the names of entities that I store references to. (inherited from `Resource`)
| `listEntities(self)` (inherited from `Resource`)
| `listNames(self)` (inherited from `Resource`)
| ``listStaticEntities`(self)` Retrieve a list of all name, entity pairs that I store references to. (inherited from `Resource`)
| ``listStaticNames`(self)` Retrieve a list of the names of entities that I store references to. (inherited from `Resource`)
| ``lookupSubmodel`(self, request, submodelName)` Look up a full submodel name. (inherited from `Model`)
| ``lookupTemplate`(self, request)` Use acquisition to look up the template named by self.templateFile, located anywhere above this object in the heirarchy, and use it as the template. (inherited from `View`)
| `makeView(self, model, templateFile, parentCount)` (inherited from `Controller`)
| ``modelChanged`(self, changed)` Dispatch changed messages to any update_* methods which may have been defined, then pass the update notification on to the controller. (inherited from `View`)
| ``nameConstraint`(self, name)` A method that determines whether an entity may be added to me with a given name. (inherited from `Constrained`)
| ``notify`(self, changed)` Notify all views that something was changed on me. (inherited from `Model`)
| ``pageRenderComplete`(self, request)` Override this to recieve notification when the view rendering process is complete. (inherited from `Controller`)
| `process(self, request, **kwargs)` (inherited from `Controller`)
| ``putChild`(self, path, child)` Register a static child. (inherited from `Resource`)
| ``putEntity`(self, name, entity)` Store an entity if it meets both constraints. (inherited from `Constrained`)
| `reallyPutEntity(self, name, entity)` (inherited from `Resource`)
| ``recurseChildren`(self, request, node)` If this node has children, handle them. (inherited from `View`)
| ``removeEntity`(self, name, request)` Remove an entity for 'name', based on the content of 'request'. (inherited from `Collection`)
| ``removeView`(self, view)` Remove a view that the model no longer should keep track of. (inherited from `Model`)
| ``render`(self, request)` Trigger any inputhandlers that were passed in to this Page, then delegate to the View for traversing the DOM. (inherited from `Controller`)
| `renderFailure(self, failure, request)` (inherited from `View`)
| `renderView(self, request)`
| ``sendPage`(self, request)` Check to see if handlers recorded any errors before sending the page (inherited from `View`)
| `setController(self, controller)` (inherited from `View`)
| `setData(self, request, data)` (inherited from `Model`)
| `setGetter(self, getter)` (inherited from `Model`)
| `setNode(self, node)` (inherited from `Controller`)
| `setSetter(self, setter)` (inherited from `Model`)
| `setSubcontrollerFactory(self, name, factory, setup)` (inherited from `Controller`)
| ``setSubmodel`(self, request, name, value)` Set a submodel on this model. (inherited from `Model`)
| `setSubviewFactory(self, name, factory, setup, *args, **kwargs)` (inherited from `View`)
| ``setUp`(self, request, *args)` (inherited from `Controller`)
| `setupAllStacks(self)` (inherited from `View`)
| `setupControllerStack(self)` (inherited from `Controller`)
| `setupViewStack(self)` (inherited from `View`)
| `setView(self, view)` (inherited from `Controller`)
| ``storeEntity`(self, name, request)` Store an entity for 'name', based on the content of 'request'. (inherited from `Collection`)
| ``submodelCheck`(self, request, name)` Allow any submodel for which I have a submodel. (inherited from `MethodModel`)
| ``submodelFactory`(self, request, name)` Call a wmfactory_name method on this model. (inherited from `MethodModel`)
| `unlinkViews(self)` (inherited from `View`)
| ``wchild_index`(self, request)` By default, we return ourself as the index. (inherited from `Controller`)

Class Variable Summary
`tuple` | `__implements__`

Class Variable Details

### __implements__

  Type:
    `tuple`
  Value:

        (<class 'twisted.web.woven.interfaces.IModel'>,
         (<class 'twisted.web.resource.IResource'>,
          <class 'twisted.web.woven.interfaces.IView'>),
         (<class 'twisted.web.woven.interfaces.IController'>,
          <class 'twisted.web.resource.IResource'>))

Generated by Epydoc 1.1 on Thu May 8 13:17:06 2003 | http://epydoc.sf.net