Package ZenWidgets :: Module ZenTableManager :: Class ZenTableManager
[show private | hide private]
[frames | no frames]

Type ZenTableManager

             object --+        
                      |        
                   Base --+    
                          |    
           Node --+       |    
                  |       |    
            Element --+   |    
                      |   |    
  ElementWithAttributes --+    
                          |    
            PropertyManager --+
                              |
         object --+           |
                  |           |
               Base --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
         CopySource --+       |
                      |       |
           Node --+   |       |
                  |   |       |
            Element --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
              Owned --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
EtagSupport --+   |   |       |
              |   |   |       |
   LockableItem --+   |       |
                  |   |       |
           Resource --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
               Tabs --+       |
                      |       |
        Traversable --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
        UndoSupport --+       |
                      |       |
                   Item --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
         object --+   |   |   |
                  |   |   |   |
         Persistent --+   |   |
                      |   |   |
             Persistent --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
        RoleManager --+   |   |
                      |   |   |
            RoleManager --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
               Acquirer --+   |
                          |   |
                 SimpleItem --+
                              |
                             ZenTableManager


ZenTableManager manages display of tabular data
Method Summary
  __init__(self, id)
  filterObjects(self, objects, regex, filterFields)
filter objects base on a regex in regex and list of fields in filterFields.
  getBatch(self, tableName, objects, **keys)
Filter, sort and batch objects and pass return set.
  getBatchForm(self, objects, request)
Create batch based on objects no sorting for filter applied.
  getDefaultBatchSize(self)
  getNavData(self, objects, batchSize, sortedHeader)
  getReqTableState(self, tableName, attrname)
Return attrname from request if present if not return from tableState.
  getTableHeader(self, tableName, fieldName, fieldTitle, sortRule, style, attributes)
generate a <th></th> tag that allows column sorting
  getTableHeaderHref(self, tableName, fieldName, sortRule, params)
build the href attribute for the table table headers
  getTableHeaderStyle(self, tableName, fieldName, style)
apends "selected" onto the CSS style if this field is selected
  getTableState(self, tableName, attrname, default, **keys)
return an existing table state or a single value from the state
  getTableStates(self)
  initTableManagerSkins(self)
setup the skins that come with ZenTableManager
  setReqTableState(self, tableName, attrname, default, reset)
set the a value in the table state from the request
  setTableState(self, tableName, attrname, value)
Set the value of a table state attribute and return it.
  setupTableState(self, tableName, **keys)
initialize or setup the session variable to track table state
  sortObjects(self, objects, request)
Sort objects.
  tableStatesHasTable(self, tableName)
  _buildTextLabel(self, item, sortedHeader)
Inherited from Item: __len__, __repr__, getId, manage, manage_afterAdd, manage_afterClone, manage_beforeDelete, manage_editedDialog, manage_FTPlist, manage_FTPstat, objectIds, objectItems, objectValues, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL, tpValues
Inherited from Resource: COPY, dav__init, dav__simpleifhandler, dav__validate, DELETE, HEAD, listDAVObjects, LOCK, manage_DAVget, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, PUT, TRACE, UNLOCK
Inherited from LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockmapping, wl_lockTokens, wl_lockValues, wl_setLock
Inherited from EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag
Inherited from CopySource: cb_isCopyable, cb_isMoveable, cb_userHasCopyOrMovePermission, _canCopy, _getCopy, _notifyOfCopyTo, _postCopy, _setId
Inherited from Tabs: class_manage_path, filtered_manage_options, manage_workspace, tabs_path_default, tabs_path_info
Inherited from Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path
Inherited from Element: getAttribute, getAttributeNode, getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName
Inherited from Node: getAttributes, getNodeValue, getOwnerDocument, hasChildNodes
Inherited from Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_fixupOwnershipAfterAdd, owner_info, userCanTakeOwnership, _deleteOwnershipAfterAdd, manage_changeOwnershipType, manage_takeOwnership
Inherited from UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions
Inherited from Persistent: __class_init__, __getattribute__, bobobase_modification_time, locked_in_version, modified_in_version
Inherited from Persistent: __delattr__, __getstate__, __new__, __reduce__, __setattr__, __setstate__, _p_activate, _p_deactivate, _p_delattr, _p_getattr, _p_invalidate, _p_setattr
Inherited from Acquirer: __of__
Inherited from RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_defined_roles, manage_editRoles, manage_role, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, valid_roles, validate_roles, validRoles, _addRole, _delRoles, _has_user_defined_role, _setRoles, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_delLocalRoles, manage_permission, manage_setLocalRoles
Inherited from RoleManager: manage_getPermissionMapping, _isBeingAccessedAsZClassDefinedInstanceMethod, _isBeingUsedAsAMethod, manage_setPermissionMapping
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, manage_editProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id, _delProperty, _delPropValue, _propertyMap, _setProperty, _setPropValue, _updateProperty, _wrapperCheck
Inherited from Base: __getnewargs__
Inherited from object: __hash__, __reduce_ex__, __str__

Class Variable Summary
tuple manage_options = ({'action': 'manage_propertiesForm', 'h...
str meta_type = 'ZenTableManager'
str portal_type = 'ZenTableManager'
tuple _properties = ({'type': 'int', 'id': 'defaultBatchSize',...
Inherited from SimpleItem: __ac_permissions__, __implemented__, __provides__
Inherited from Item: __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isPrincipiaFolderish, isTopLevelPrincipiaApplicationObject, manage__roles__, manage_afterAdd__roles__, manage_afterClone__roles__, manage_beforeDelete__roles__, manage_editedDialog__roles__, manage_FTPlist__roles__, manage_FTPstat__roles__, REQUEST, title, _manage_editedDialog
Inherited from Resource: __dav_resource__, __http_methods__, COPY__roles__, DELETE__roles__, HEAD__roles__, listDAVObjects__roles__, LOCK__roles__, manage_DAVget__roles__, MOVE__roles__, OPTIONS__roles__, PROPFIND__roles__, PROPPATCH__roles__, TRACE__roles__, UNLOCK__roles__
Inherited from LockableItem: wl_clearLocks__roles__, wl_delLock__roles__, wl_getLock__roles__, wl_isLocked__roles__, wl_isLockedByUser__roles__, wl_lockItems__roles__, wl_lockmapping__roles__, wl_lockTokens__roles__, wl_lockValues__roles__, wl_setLock__roles__
Inherited from EtagSupport: __implements__, __providedBy__
Inherited from Tabs: class_manage_path__roles__, filtered_manage_options__roles__, manage_tabs, manage_tabs__roles__, manage_workspace__roles__
Inherited from Traversable: absolute_url__roles__, absolute_url_path__roles__, getPhysicalPath__roles__, getPhysicalRoot, getPhysicalRoot__roles__, restrictedTraverse__roles__, unrestrictedTraverse__roles__, virtual_url_path__roles__
Inherited from Owned: changeOwnership__roles__, getOwner__roles__, getOwnerTuple__roles__, getWrappedOwner__roles__, manage_changeOwnershipType__roles__, manage_fixupOwnershipAfterAdd__roles__, manage_owner, manage_owner__roles__, manage_takeOwnership__roles__, owner_info__roles__
Inherited from UndoSupport: manage_undo_transactions__roles__, manage_UndoForm, manage_UndoForm__roles__, undoable_transactions__roles__
Inherited from Persistent: _p_changed, _p_jar, _p_mtime, _p_oid, _p_serial, _p_state
Inherited from RoleManager: __ac_local_roles__, __ac_roles__, ac_inherited_permissions__roles__, access_debug_info__roles__, aclAChecked, aclEChecked, aclPChecked, acquiredRolesAreUsedBy__roles__, manage_access__roles__, manage_acquiredForm, manage_acquiredForm__roles__, manage_acquiredPermissions__roles__, manage_addLocalRoles__roles__, manage_changePermissions__roles__, manage_defined_roles__roles__, manage_delLocalRoles__roles__, manage_editLocalRoles, manage_editLocalRoles__roles__, manage_editRoles__roles__, manage_listLocalRoles, manage_listLocalRoles__roles__, manage_permission__roles__, manage_permissionForm, manage_permissionForm__roles__, manage_role__roles__, manage_roleForm, manage_roleForm__roles__, manage_setLocalRoles__roles__, permission_settings__roles__, permissionMappingPossibleValues, permissionsOfRole__roles__, rolesOfPermission__roles__, selectedRoles, smallRolesWidget, userdefined_roles__roles__, _method_manage_access, _normal_manage_access
Inherited from RoleManager: manage_getPermissionMapping__roles__, manage_setPermissionMapping__roles__
Inherited from PropertyManager: __roles__, getProperty__roles__, getPropertyType__roles__, hasProperty__roles__, manage_addProperty__roles__, manage_changeProperties__roles__, manage_changePropertyTypes__roles__, manage_delProperties__roles__, manage_editProperties__roles__, manage_propertiesForm, manage_propertiesForm__roles__, manage_propertyTypeForm, manage_propertyTypeForm__roles__, propdict__roles__, propertyIds__roles__, propertyItems__roles__, propertyLabel__roles__, propertyMap__roles__, propertysheets, propertyValues__roles__, valid_property_id__roles__, _reserved_names

Method Details

filterObjects(self, objects, regex, filterFields)

filter objects base on a regex in regex and list of fields in filterFields.

getBatch(self, tableName, objects, **keys)

Filter, sort and batch objects and pass return set.

getBatchForm(self, objects, request)

Create batch based on objects no sorting for filter applied.

getReqTableState(self, tableName, attrname)

Return attrname from request if present if not return from tableState.

getTableHeader(self, tableName, fieldName, fieldTitle, sortRule='cmp', style='tableheader', attributes='')

generate a <th></th> tag that allows column sorting

getTableHeaderHref(self, tableName, fieldName, sortRule='cmp', params='')

build the href attribute for the table table headers

getTableHeaderStyle(self, tableName, fieldName, style)

apends "selected" onto the CSS style if this field is selected

getTableState(self, tableName, attrname=None, default=None, **keys)

return an existing table state or a single value from the state

initTableManagerSkins(self)

setup the skins that come with ZenTableManager

setReqTableState(self, tableName, attrname, default=None, reset=False)

set the a value in the table state from the request

setTableState(self, tableName, attrname, value)

Set the value of a table state attribute and return it.

setupTableState(self, tableName, **keys)

initialize or setup the session variable to track table state

sortObjects(self, objects, request)

Sort objects.

Class Variable Details

manage_options

Type:
tuple
Value:
({'action': 'manage_propertiesForm',
  'help': ('OFSP', 'Properties.stx'),
  'label': 'Properties'},
 {'action': 'manage_UndoForm', 'help': ('OFSP', 'Undo.stx'), 'label': \
'Undo'},
 {'action': 'manage_owner',
  'filter': <function ownableFilter at 0x13a77f0>,
  'help': ('OFSP', 'Ownership.stx'),
...                                                                    

meta_type

Type:
str
Value:
'ZenTableManager'                                                      

portal_type

Type:
str
Value:
'ZenTableManager'                                                      

_properties

Type:
tuple
Value:
({'type': 'int', 'id': 'defaultBatchSize', 'mode': 'w'},
 {'type': 'int', 'id': 'abbrStartLabel', 'mode': 'w'},
 {'type': 'int', 'id': 'abbrEndLabel', 'mode': 'w'},
 {'type': 'int', 'id': 'abbrPadding', 'mode': 'w'},
 {'type': 'string', 'id': 'abbrSeparator', 'mode': 'w'})               

Generated by Epydoc 2.1 on Thu Aug 16 09:55:10 2007 http://epydoc.sf.net