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

Class GridManager

source code

object --+
         |
        GridManager
Known Subclasses:

Manage the grids of a given Xgrid controller.

Instance Methods [hide private]
 
__init__(self, connection=None, update=0)
A class to manage a set of Xgrid grids.
source code
 
_updateGrids(self)
Updates the _gridIDs and _grids instance variables.
source code
 
grids(self, update=1)
Returns a list of initialized Grid objects.
source code
 
grid(self, gridID=u'0', update=1)
Returns the Grid object with grid identifier gridID.
source code
 
gridIDs(self, update=1)
Returns a tuple of grid identifiers for all avialable grids.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

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 (Connection) - Instance of Connection class. If empty a default Connection object is used.
  • update (boolean) - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.
Overrides: object.__init__

grids(self, update=1)

source code 

Returns a list of initialized Grid objects.

Parameters:
  • update (boolean) - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.

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

source code 

Returns the Grid object with grid identifier gridID.

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

gridIDs(self, update=1)

source code 

Returns a tuple of grid identifiers for all avialable grids.

Parameters:
  • update (boolean) - A boolean flag that determines whether or not the internal state is updated upon creation. This involves a call to the Xgrid controller.