Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Plugins.View.Jinja2Views.AJinja2View Class Reference

This class represents a view, which is a jinja template that formats the output retrieved from a channel. More...

+ Inheritance diagram for Plugins.View.Jinja2Views.AJinja2View:

Public Member Functions

def __init__
 Construct a new instance of the view. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def establishVariables
 Establish variables for the view. More...
 
def establishFilters
 Establish filters for the view. More...
 
def fetch
 Fetch the specified view from a template in the file system. More...
 
def render
 Render the template. More...
 
def Environment
 Retrieve the environment specified for the view. More...
 
def Template
 Retrieve the master template used by the view. More...
 
- Public Member Functions inherited from Library.UI.Views.AView
def __init__
 Constructor.
 
def init
 Initializer.
 
def render
 Render the view and return a string that contains the rendered content. More...
 
- Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject
def __init__
 Constructor. More...
 
def init
 Initializer.
 
def error
 Generate an error event. More...
 
def log
 Log the specified item. More...
 
def Log
 Retrieve the log used by the class.
 
- Public Member Functions inherited from Library.Base.Events.AnEventfulObject
def __init__
 Constructor. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def parseParams
 Parse the specified parameters, looking for named events and setting event handlers as appropriate. More...
 
def generate
 Generate the named event.
 
def update
 Update the events generated by the object.
 
def error
 Generate an error event. More...
 
def toString
 Construct a string representation of the object. More...
 
def on
 Set the handler for the specified event. More...
 
def onMultiple
 Set handlers for multiple events. More...
 
def handlerFor
 Retrieve the handler for the specified event. More...
 
def generates
 Determine whether or not the object generates the named event. More...
 
def __getitem__
 Retrieve the value of the named property.
 
def __setitem__
 Set the value of the named property.
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.String.Utilities.IsPrintable
def toString
 Return a string representation of the class conveniently. More...
 
def __str__
 Return a string representation of the class. More...
 
def printTo
 Print a string representation of the class to the specified stream. More...
 

Detailed Description

This class represents a view, which is a jinja template that formats the output retrieved from a channel.

Constructor & Destructor Documentation

def Plugins.View.Jinja2Views.AJinja2View.__init__ (   Self,
  params 
)

Construct a new instance of the view.

In addition to the parameters expected by AView.__init__(), this routine will accept the following items in params:

  • paths – If provided, this is a list of template search paths, which will be used when the view is fetched.
  • cache – If specified, and if the value does not evaluate to an empty string, then templates will be cached to the specified directory. This can potentially improve page load times.

Member Function Documentation

def Plugins.View.Jinja2Views.AJinja2View.Environment (   Self)

Retrieve the environment specified for the view.

def Plugins.View.Jinja2Views.AJinja2View.establishFilters (   Self)

Establish filters for the view.

This routine generates the establishFilters event.

This method should be implemented by descendant classes.

def Plugins.View.Jinja2Views.AJinja2View.establishVariables (   Self)

Establish variables for the view.

This routine generates the establishVariables event.

This method should be implemented by descendant classes.

def Plugins.View.Jinja2Views.AJinja2View.fetch (   Self,
  theseTemplates 
)

Fetch the specified view from a template in the file system.

This routine generates the fetch event.

def Plugins.View.Jinja2Views.AJinja2View.render (   Self,
  content 
)

Render the template.

def Plugins.View.Jinja2Views.AJinja2View.Template (   Self)

Retrieve the master template used by the view.


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