Package twisted :: Package web :: Package woven :: Module controller :: Class LiveController
[frames | no frames]

Class LiveController

Collection --+                
             |                
   Constrained --+            
                 |            
  ConfigCollection --+        
                     |        
              Resource --+    
                         |    
                Controller --+
                             |
                            LiveController

Known Subclasses:
LivePage

A Controller that encapsulates logic that makes it possible for this page to be "Live". A live page can have it's content updated after the page has been sent to the browser, and can translate client-side javascript events into server-side events.
Method Summary
  clientToServerEvent(self, request, eventName, eventTarget, eventArgs)
The client sent an asynchronous event to the server.
  domChanged(self, request, widget, node)
  gatheredControllers(self, v, d, request)
  render(self, request)
First, check to see if this request is attempting to hook up the output conduit.
  wchild_FlashConduit_swf(self, request)
  wchild_input_html(self, request)
  wchild_WebConduit2_js(self, request)
    Inherited from Controller
  __init__(self, m, inputhandlers, view, controllers, templateDirectory)
  aggregateInvalid(self, request, input, data)
  aggregateValid(self, request, input, data)
  exit(self, request)
We are done handling the node to which this controller was attached.
  getChild(self, name, request)
Look for a factory method to create the object to handle the next segment of the URL.
  getDynamicChild(self, name, request)
This method is called when getChild cannot find a matching wchild_* method in the Controller.
  getSubcontroller(self, request, node, model, controllerName)
  handle(self, request)
By default, we don't do anything
  importControllerLibrary(self, namespace)
  makeView(self, model, templateFile, parentCount)
  pageRenderComplete(self, request)
Override this to recieve notification when the view rendering process is complete.
  process(self, request, **kwargs)
  renderView(self, request)
  setNode(self, node)
  setSubcontrollerFactory(self, name, factory, setup)
  setSubmodel(self, submodel)
  setUp(self, request, *args)
  setupControllerStack(self)
  setView(self, view)
  wchild_index(self, request)
By default, we return ourself as the index.
    Inherited from Resource
  delEntity(self, name)
Remove a static reference for 'name'.
  getChildForRequest(self, request)
(internal) Get a child of mine dependant on a particular request.
  getChildWithDefault(self, path, request)
Retrieve a static or dynamically generated child resource from me.
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self)
  listNames(self)
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  putChild(self, path, child)
Register a static child.
  reallyPutEntity(self, name, entity)
    Inherited from ConfigCollection
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  getEntityType(self)
  getNameType(self)
    Inherited from Constrained
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
    Inherited from Collection
  getEntity(self, name, request)
Retrieve an entity from me.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
NoneType pageSession = None                                                                  
    Inherited from Controller
tuple __implements__ = (<class twisted.web.woven.interfaces.IC...
int addSlash = 1                                                                     
list controllerLibraries = []
int setupStacks = 1                                                                     
str templateDirectory = ''
NoneType viewFactory = None                                                                  
    Inherited from Resource
int isLeaf = 0                                                                     
NoneType server = None                                                                  

Method Details

clientToServerEvent(self, request, eventName, eventTarget, eventArgs)

The client sent an asynchronous event to the server. Locate the View object targeted by this event and attempt to call onEvent on it.

render(self, request)

First, check to see if this request is attempting to hook up the output conduit. If so, do it. Otherwise, unlink the current session's View from the MVC notification infrastructure, then render the page normally.
Overrides:
twisted.web.woven.controller.Controller.render

Class Variable Details

pageSession

Type:
NoneType
Value:
None                                                                  

Generated by Epydoc 2.0 on Sat Sep 13 04:20:40 2003 http://epydoc.sf.net