Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.UI.ContentProviders.AContentProvider Class Reference

A content provider. More...

+ Inheritance diagram for Library.UI.ContentProviders.AContentProvider:

Public Member Functions

def __init__
 Constructor. More...
 
def init
 Initializer.
 
def content
 Retrieve the content from the content provider. More...
 
def Mediator
 Retrieve the mediator responsible for constructing the content provider. 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 content provider.

A content provider is one of the three major classes that make up arena. A content provider is responsible for loading content from a source and returning an iterable object that will allow a view to format and display that content to the client.

Constructor & Destructor Documentation

def Library.UI.ContentProviders.AContentProvider.__init__ (   Self,
  params 
)

Constructor.

The constructor expects that params will contain the following items:

  • Mediator – A reference to the content mediator that has constructed the content provider instance.

Member Function Documentation

def Library.UI.ContentProviders.AContentProvider.content (   Self)

Retrieve the content from the content provider.

This method should be implemented by descendant classes. It should return an iterable object that contains content which will be passed to a view for display. If there is no content to display, an empty iterable object should be returned.

This method generates the fetchContent event.

def Library.UI.ContentProviders.AContentProvider.Mediator (   Self)

Retrieve the mediator responsible for constructing the content provider.


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