Package ZenRelations :: Module ZenPropertyManager :: Class ZenPropertyManager
[show private | hide private]
[frames | no frames]

Type ZenPropertyManager

           object --+        
                    |        
                 Base --+    
                        |    
         Node --+       |    
                |       |    
          Element --+   |    
                    |   |    
ElementWithAttributes --+    
                        |    
          PropertyManager --+
                            |
                           ZenPropertyManager

Known Subclasses:
RelationshipManager

ZenPropertyManager adds keyedselection type to PropertyManager. A keyedselection displayes a different name in the popup then the actual value the popup will have.

It also has management for zenProperties which are properties that can be inherited long the acquision chain. All properties are for a branch are defined on a "root node" specified by the function which must be returned by the function getZenRootNode that should be over ridden in a sub class. Prperties can then be added further "down" the aq_chain by calling setZenProperty on any contained node.

ZenProperties all have the same prefix which is defined by iszprop this can be overridden in a subclass.
Method Summary
  deleteZenProperty(self, propname, REQUEST)
Delete device tree properties from the this DeviceClass object.
  getZenRootNode(self)
sub class must implement to use zenProperties.
  isLocal(self, propname)
Check to see if a name is local to our current context.
  manage_editProperties(self, REQUEST)
Edit object properties via the web.
  saveZenProperties(self, pfilt, REQUEST)
Save all ZenProperties found in the REQUEST.form object.
  setZenProperty(self, propname, propvalue, REQUEST)
Add or set the propvalue of the property propname on this node of the device Class tree.
  zenPropertyIds(self, all, pfilt)
Return list of device tree property names.
  zenPropertyItems(self)
Return list of (id, value) tuples of zenProperties.
  zenPropertyMap(self, pfilt)
Return property mapping of device tree properties.
  zenPropertyOptions(self, propname)
Provide a set of default options for a ZProperty
  zenPropertyPath(self, id)
Return the primaryId of where a device tree property is found.
  zenPropertyString(self, id)
Return the value of a device tree property as a string
  zenPropertyType(self, id)
Return the type of this property.
  zenPropIsPassword(self, id)
Is this field a password field.
  _setProperty(self, id, value, type, label, visible, setter)
for selection and multiple selection properties the value argument indicates the select variable of the property
  _setPropValue(self, id, value)
override from PerpertyManager to handle checks and ip creation
Inherited from PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id, _delProperty, _delPropValue, _propertyMap, _updateProperty, _wrapperCheck
Inherited from ElementWithAttributes: getAttribute, getAttributeNode, getAttributes
Inherited from Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName
Inherited from Node: getNodeValue, getOwnerDocument, hasChildNodes
Inherited from Base: __getattribute__, __getnewargs__, __getstate__, __new__, __reduce__, __setstate__
Inherited from object: __init__, __delattr__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__
Inherited from SRE_Pattern: _onlystars

Class Variable Summary
tuple manage_editProperties__roles__ = ('Manager',)
DTMLFile manage_propertiesForm = <App.special_dtml.DTMLFile objec...
tuple manage_propertiesForm__roles__ = ('Manager',)
Inherited from PropertyManager: __ac_permissions__, __implemented__, __propsets__, __provides__, __roles__, getProperty__roles__, getPropertyType__roles__, hasProperty__roles__, manage_addProperty__roles__, manage_changeProperties__roles__, manage_changePropertyTypes__roles__, manage_delProperties__roles__, manage_options, manage_propertyTypeForm, manage_propertyTypeForm__roles__, propdict__roles__, propertyIds__roles__, propertyItems__roles__, propertyLabel__roles__, propertyMap__roles__, propertysheets, propertyValues__roles__, title, valid_property_id__roles__, _properties, _reserved_names
Inherited from Node: __providedBy__

Method Details

deleteZenProperty(self, propname=None, REQUEST=None)

Delete device tree properties from the this DeviceClass object.

getZenRootNode(self)

sub class must implement to use zenProperties.

isLocal(self, propname)

Check to see if a name is local to our current context.

manage_editProperties(self, REQUEST)

Edit object properties via the web. The purpose of this method is to change all property values, even those not listed in REQUEST; otherwise checkboxes that get turned off will be ignored. Use manage_changeProperties() instead for most situations.
Overrides:
OFS.PropertyManager.PropertyManager.manage_editProperties

saveZenProperties(self, pfilt=<built-in method search of _sre.SRE_Pattern object at 0x2..., REQUEST=None)

Save all ZenProperties found in the REQUEST.form object.

setZenProperty(self, propname, propvalue, REQUEST=None)

Add or set the propvalue of the property propname on this node of the device Class tree.

zenPropertyIds(self, all=True, pfilt=<built-in method search of _sre.SRE_Pattern object at 0x2...)

Return list of device tree property names. If all use list from property root node.

zenPropertyItems(self)

Return list of (id, value) tuples of zenProperties.

zenPropertyMap(self, pfilt=<built-in method search of _sre.SRE_Pattern object at 0x2...)

Return property mapping of device tree properties.

zenPropertyOptions(self, propname)

Provide a set of default options for a ZProperty

zenPropertyPath(self, id)

Return the primaryId of where a device tree property is found.

zenPropertyString(self, id)

Return the value of a device tree property as a string

zenPropertyType(self, id)

Return the type of this property.

zenPropIsPassword(self, id)

Is this field a password field.

_setProperty(self, id, value, type='string', label=None, visible=True, setter=None)

for selection and multiple selection properties the value argument indicates the select variable of the property
Overrides:
OFS.PropertyManager.PropertyManager._setProperty

_setPropValue(self, id, value)

override from PerpertyManager to handle checks and ip creation
Overrides:
OFS.PropertyManager.PropertyManager._setPropValue

Class Variable Details

manage_editProperties__roles__

Type:
tuple
Value:
('Manager',)                                                           

manage_propertiesForm

Type:
DTMLFile
Value:
<App.special_dtml.DTMLFile object at 0x2ff3130>                        

manage_propertiesForm__roles__

Type:
tuple
Value:
('Manager',)                                                           

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