zms.zmscontainerobject.ZMSContainerObject

class documentation

class ZMSContainerObject(zmsobject.ZMSObject, RoleManager, _accessmanager.AccessableContainer, _versionmanager.VersionManagerContainer): (source)

View In Hierarchy

Base container object that manages child-node creation, ordering, and deletion.

Method	`filteredChildNodes`	Returns a node-list that contains all visible children of this node in correct order. If none, this is a empty node-list.
Method	`filteredTreeNodes`	Returns a node-list that contains all visible children of this subtree in correct order. If none, this is a empty node-list.
Method	`firstFilteredChildNode`	Returns the first visible child of this node.
Method	`get_next_page`	Return a page-sized sequence of nodes following the given uid.
Method	`getChildNodes`	Return all child nodes of this object in stable sort order.
Method	`getContentType`	Returns MIME-type (text/html).
Method	`getFirstPage`	Returns the first page of the tree from root (or document-element if root is not given).
Method	`getIndexNavElements`	Return the index-navigation elements for the current content context.
Method	`getLastPage`	Returns the last page of the tree from root (or document-element if root is not given).
Method	`getNavElements`	Return the content-area navigation elements for the current subtree.
Method	`getNavItems`	Returns html-formatted (unordered) list of navigation-items. Uses the following classes
Method	`getNewSortId`	Get new sort-id.
Method	`getNextPage`	Returns the next page of this node from root (or document-element if root is not given).
Method	`getPrevPage`	Returns the previous page of this node from root (or document-element if root is not given).
Method	`manage_addZMSCustom`	Add a custom node of the type designated by meta_id in current context.
Method	`manage_addZMSCustomDefault`	Add default node.
Method	`manage_addZMSModule`	Add module-node.
Method	`manage_addZMSObject`	Add a node of type designated by meta_id in current context.
Method	`manage_ajaxDragDrop`	Move the current object relative to another node using drag-and-drop.
Method	`manage_ajaxZMIActions`	Returns ZMI actions. internal use only
Method	`manage_deleteObjs`	Delete a subordinate object logically: The objects specified in 'ids' get deleted (moved to trashcan).
Method	`manage_eraseObjs`	Delete a subordinate object physically: The objects specified in 'ids' get deleted.
Method	`manage_undoObjs`	Undo a subordinate object: The objects specified in 'ids' get undone (changes are rolled-back).
Method	`moveObjsToTrashcan`	Move subordinate objects to the trashcan and update search state.
Method	`normalizeSortIds`	Normalizes sort-ids for all children with given prefix of this node. Always called on container after new node was added. E.g.: sort_ids:before=[10,15,20,30,40] => sort_ids:after=[10,20,30,40,50]
Constant	`NOREF`	Undocumented
Constant	`NORESOLVEREF`	Undocumented
Constant	`PAGEELEMENTS`	Undocumented
Constant	`PAGES`	Undocumented
Class Variable	`__ac_permissions__`	Undocumented
Class Variable	`__administratorPermissions__`	Undocumented
Class Variable	`manage_container`	Undocumented
Class Variable	`manage_importexport`	Undocumented
Class Variable	`manage_importexportDebugFilter`	Undocumented
Class Variable	`manage_main`	Undocumented
Class Variable	`manage_properties`	Undocumented
Class Variable	`manage_system`	Undocumented
Class Variable	`zmi_manage_main_change`	Undocumented
Class Variable	`zmi_manage_main_grid`	Undocumented

def filteredChildNodes(self, REQUEST=None, meta_types=None): (source) ¶

Returns a node-list that contains all visible children of this node in correct order. If none, this is a empty node-list.

Parameters
REQUEST:`ZPublisher.HTTPRequest=None`	the triggering request
meta_types:`str\|list`	the meta_type(s) (single or list), may also be `ZMSContainerObject.PAGES` or `ZMSContainerObject.PAGEELEMENTS`
Returns
`list<ZMSObject>`	the list of ZMSObjects

def filteredTreeNodes(self, REQUEST, meta_types, order_by=None, order_dir=None, max_len=None, recursive=True): (source) ¶

Returns a node-list that contains all visible children of this subtree in correct order. If none, this is a empty node-list.

Parameters
REQUEST:`ZPublisher.HTTPRequest=None`	the triggering request
meta_types:`str\|list`	the meta_type(s) (single or list), may also be `ZMSContainerObject.PAGES` or `ZMSContainerObject.PAGEELEMENTS`
order_by	Undocumented
order_dir	Undocumented
max_len	Undocumented
recursive	Undocumented
Returns
`list<ZMSObject>`	the list of ZMSObjects

def firstFilteredChildNode(self, REQUEST=None, meta_types=None): (source) ¶

Returns the first visible child of this node.

Parameters
REQUEST:`ZPublisher.HTTPRequest=None`	the triggering request
meta_types:`str\|list`	the meta_type(s) (single or list), may also be `ZMSContainerObject.PAGES` or `ZMSContainerObject.PAGEELEMENTS`
Returns
`ZMSObject`	the first ZMSObject

def get_next_page(self, uid, page_size=100, clients=False): (source) ¶

Return a page-sized sequence of nodes following the given uid.

Parameters
uid:`str`	Start node uid.
page_size:`int`	Maximum number of nodes to return.
clients:`bool`	Traverse portal clients as well.
Returns
`tuple`	Tuple of nodes and next-page marker.

def getChildNodes(self, REQUEST=None, meta_types=None, reid=None): (source) ¶

Return all child nodes of this object in stable sort order.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Optional request used for language and visibility filtering.
meta_types:`str\|list`	Optional meta-type selector.
reid:`str`	Optional regular expression for child ids.
Returns
`list<ZMSObject>`	Matching child nodes.

def getContentType(self, REQUEST): (source) ¶

Returns MIME-type (text/html).

Parameters
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
Returns
`str`	always returns 'text/html'

def getFirstPage(self, REQUEST, incResource=False, root=None): (source) ¶

Returns the first page of the tree from root (or document-element if root is not given).

Parameters
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
incResource	Undocumented
root	Undocumented
Returns
`zmsobject.ZMSObject`	the first page

def getIndexNavElements(self, REQUEST): (source) ¶

Return the index-navigation elements for the current content context.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Current request.
Returns
`list`	Index navigation elements.

def getLastPage(self, REQUEST, incResource=False, root=None): (source) ¶

Returns the last page of the tree from root (or document-element if root is not given).

Parameters
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
incResource	Undocumented
root	Undocumented
Returns
`zmsobject.ZMSObject`	the last page

def getNavElements(self, REQUEST, expand_tree=1, current_child=None, subElements=[]): (source) ¶

Return the content-area navigation elements for the current subtree.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Current request.
expand_tree:`bool`	Include the full subtree when true.
current_child:`zmsobject.ZMSObject`	Current child node if the traversal is recursive.
subElements:`list`	Child navigation elements collected so far.
Returns
`list`	Navigation elements.

def getNavItems(self, current, REQUEST, opt={}, depth=0): (source) ¶

Returns html-formatted (unordered) list of navigation-items. Uses the following classes

current item is current-element
(in-)active items is parent of current-element or current-element
restricted item has restricted access

Parameters
current:`zmsobject.ZMSObject`	the currently displayed page
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
opt	the dictionary of options id (`str=''`) id of base ul-element cssclass (`str=''`) css class of base ul-element add_self (`boolean=False`) add self to list deep (`boolean=True`) process child nodes complete (`boolean=False`) process complete subtree maxdepth (`int=100`) limits node list to a given depth getrestricted (`boolean=True`) get is restricted getchildpages (`boolean=True`) get has child-pages
depth	Undocumented
Returns
`str`	the Html

def getNewSortId(self): (source) ¶

Get new sort-id.

Returns
`int`	the new sort-id.

def getNextPage(self, REQUEST, incResource=False, root=None): (source) ¶

Returns the next page of this node from root (or document-element if root is not given).

Parameters
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
incResource	Undocumented
root	Undocumented
Returns
`zmsobject.ZMSObject`	the next page

def getPrevPage(self, REQUEST, incResource=False, root=None): (source) ¶

Returns the previous page of this node from root (or document-element if root is not given).

Parameters
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
incResource	Undocumented
root	Undocumented
Returns
`zmsobject.ZMSObject`	the previous page

def manage_addZMSCustom(self, meta_id=None, values={}, REQUEST=None): (source) ¶

Add a custom node of the type designated by meta_id in current context.

Parameters
meta_id:`str`	the meta-id / type of the new ZMSObject
values:`dict`	the dictionary of initial attribute values assigned to the new ZMSObject
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
Returns
`zmsobject.ZMSObject`	the new node

def manage_addZMSCustomDefault(self, lang, id_prefix, _sort_id, REQUEST, RESPONSE): (source) ¶

Add default node.

Internal use only.

Parameters
lang:`str`	the language-id.
id_prefix:`str`	the id-prefix.
_sort_id	Undocumented
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the triggering response

def manage_addZMSModule(self, lang, _sort_id, custom, REQUEST, RESPONSE): (source) ¶

Add module-node.

Internal use only.

Parameters
lang:`str`	the language-id.
_sort_id:`int`	sort id
custom:`str`	the meta-id
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the triggering response

def manage_addZMSObject(self, meta_id, values, REQUEST): (source) ¶

Add a node of type designated by meta_id in current context.

Parameters
meta_id:`str`	the meta-id / type of the new ZMSObject
values:`dict`	the dictionary of initial attribute values assigned to the new ZMSObject id_prefix (`str=''`) the id-prefix used to generate the new id id (`str=''`) the new id (fixed) sort_id (`str=''`) the sort-id meta_id (`str=''`) the meta-id active (`str=''`) is active attr_dc_coverage (`str=''`) the coverage
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
Returns
`zmsobject.ZMSObject`	the new node

def manage_ajaxDragDrop(self, lang, target, REQUEST, RESPONSE): (source) ¶

Move the current object relative to another node using drag-and-drop.

Parameters
lang:`str`	Active language.
target:`str`	Drag-and-drop target marker.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
RESPONSE:`ZPublisher.HTTPResponse`	Current response.

def manage_ajaxZMIActions(self, context_id, REQUEST, RESPONSE): (source) ¶

Returns ZMI actions. internal use only

Parameters
context_id	Undocumented
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the response

def manage_deleteObjs(self, lang, ids, REQUEST, RESPONSE=None): (source) ¶

Delete a subordinate object logically: The objects specified in 'ids' get deleted (moved to trashcan).

Parameters
lang:`str`	the language-id.
ids:`list`	the list of object-ids.
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the triggering response

def manage_eraseObjs(self, lang, ids, REQUEST, RESPONSE=None): (source) ¶

Delete a subordinate object physically: The objects specified in 'ids' get deleted.

Parameters
lang:`str`	the language-id.
ids:`list`	the list of object-ids.
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the triggering response

def manage_undoObjs(self, lang, ids, REQUEST, RESPONSE=None): (source) ¶

Undo a subordinate object: The objects specified in 'ids' get undone (changes are rolled-back).

Parameters
lang:`str`	the language-id.
ids:`list`	the list of object-ids.
REQUEST:`ZPublisher.HTTPRequest`	the triggering request
RESPONSE:`ZPublisher.HTTPResponse`	the triggering response

def moveObjsToTrashcan(self, ids, REQUEST): (source) ¶

Move subordinate objects to the trashcan and update search state.

Parameters
ids:`list`	List of object ids.
REQUEST:`ZPublisher.HTTPRequest`	Current request.

def normalizeSortIds(self, id_prefix='e'): (source) ¶

Normalizes sort-ids for all children with given prefix of this node. Always called on container after new node was added. E.g.: sort_ids:before=[10,15,20,30,40] => sort_ids:after=[10,20,30,40,50]