Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Plugins.View.PerUser.Arena.Views.AnArenaView Class Reference

A view manager customized to meet the needs of arena. More...

+ Inheritance diagram for Plugins.View.PerUser.Arena.Views.AnArenaView:

Public Member Functions

def __init__
 Constructor. More...
 
def init
 Initializer.
 
def __del__
 
def path
 Return a path for a template.
 
def establishScriptVariables
 Establish script variables for the view. More...
 
def establishSiteVariables
 Establish site variables for the view. More...
 
def establishSessionVariables
 Establish session variables. More...
 
def establishViewVariables
 Establish view variables for the view. More...
 
def establishChannelVariables
 Establish channel variables for the view. More...
 
def postsAuthored
 Determine how many posts have been authored by the specified user.
 
def postsEdited
 Determine how many posts have been edited by the specified user.
 
def iround
 Round the specified value to the nearest integer value.
 
def establishUserVariables
 Establish variables related to the user. More...
 
def establishFilters
 Establish filters for the view; these filters are common across all of the views rendered by arena. More...
 
def establishVariables
 Establish variables for the view; these variables are common across all of the views rendered by arena. More...
 
def fetch
 Fetch the specified view. More...
 
def render
 Render the template. More...
 
def Session
 Retrieve the session to which the view applies. More...
 
def Channel
 Retrieve the channel to which the view applies. More...
 
def name
 Retrieve the name of the view. More...
 
def User
 Retrieve the user for whom the view was constructed.
 
- Public Member Functions inherited from Plugins.View.Jinja2Views.AJinja2View
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

A view manager customized to meet the needs of arena.

Constructor & Destructor Documentation

def Plugins.View.PerUser.Arena.Views.AnArenaView.__init__ (   Self,
  params 
)

Constructor.

In addition to the parameters expected by AJinja2View.__init__(), this routine expects that params will contain the following items:

  • Mediator – A reference to the content mediator that is driving the display of content.

Member Function Documentation

def Plugins.View.PerUser.Arena.Views.AnArenaView.Channel (   Self)

Retrieve the channel to which the view applies.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishChannelVariables (   Self)

Establish channel variables for the view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishFilters (   Self)

Establish filters for the view; these filters are common across all of the views rendered by arena.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishScriptVariables (   Self)

Establish script variables for the view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishSessionVariables (   Self)

Establish session variables.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishSiteVariables (   Self)

Establish site variables for the view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishUserVariables (   Self)

Establish variables related to the user.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishVariables (   Self)

Establish variables for the view; these variables are common across all of the views rendered by arena.

def Plugins.View.PerUser.Arena.Views.AnArenaView.establishViewVariables (   Self)

Establish view variables for the view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.fetch (   Self,
  theseTemplates 
)

Fetch the specified view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.name (   Self)

Retrieve the name of the view.

def Plugins.View.PerUser.Arena.Views.AnArenaView.render (   Self,
  content 
)

Render the template.

def Plugins.View.PerUser.Arena.Views.AnArenaView.Session (   Self)

Retrieve the session to which the view applies.


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