Module xg :: Class GridManager
[show private | hide private]
[frames | no frames]

Class GridManager

Known Subclasses:
Controller

Manage the grids of a given Xgrid controller.
Method Summary
  __init__(self, connection, update)
A class to manage a set of Xgrid grids.
  grid(self, gridID, update)
Returns the Grid object with grid identifier gridID.
  gridIDs(self, update)
Returns a tuple of grid identifiers for all avialable grids.
  grids(self, update)
Returns a list of initialized Grid objects.

Method Details

__init__(self, connection=None, update=0)
(Constructor)

A class to manage a set of Xgrid grids.

This class is meant to be a base class for the Controller class. It provides basic capabilities for listing the available grids.
Parameters:
connection - Instance of Connection class. If empty a default Connection object is used.
           (type=Connection)
update - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.
           (type=boolean)

grid(self, gridID=u'0', update=1)

Returns the Grid object with grid identifier gridID.
Parameters:
gridID - The unicode string identifier of the grid. If no gridID is given, the default grid u'0' is used.
           (type=unicode, int or str)
update - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.
           (type=boolean)

gridIDs(self, update=1)

Returns a tuple of grid identifiers for all avialable grids.
Parameters:
update - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.
           (type=boolean)

grids(self, update=1)

Returns a list of initialized Grid objects.
Parameters:
update - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.
           (type=boolean)

Generated by Epydoc 2.1 on Thu Dec 22 15:15:21 2005 http://epydoc.sf.net