Package muntjac :: Package ui :: Package treetable :: Module collapsible :: Class ICollapsible

Class ICollapsible

               object --+        
                        |        
data.container.IContainer --+    
                            |    
 data.container.IHierarchical --+
                                |
               object --+       |
                        |       |
data.container.IContainer --+   |
                            |   |
      data.container.IOrdered --+
                                |
                               ICollapsible

Container needed by large lazy loading hierarchies displayed in TreeTable.

Container of this type gets notified when a subtree is opened/closed in a component displaying its content. This allows container to lazy load subtrees and release memory when a sub-tree is no longer displayed.

Methods from IOrdered (and from IIndexed if implemented) are expected to work as in "preorder" of the currently visible hierarchy. This means for example that the return value of size method changes when subtree is collapsed/expanded. In other words items in collapsed sub trees should be "ignored" by container when the container is accessed with methods introduced in IOrdered or IIndexed. From the accessors point of view, items in collapsed subtrees don't exist.

Instance Methods

[hide private]

setCollapsed(self, itemId, collapsed)
Collapsing the Item indicated by itemId hides all children, and their respective children, from the Container. source code

isCollapsed(self, itemId)
Checks whether the Item, identified by itemId is collapsed or not. source code

Inherited from data.container.IHierarchical: areChildrenAllowed, getChildren, getParent, hasChildren, isRoot, removeItem, rootItemIds, setChildrenAllowed, setParent

Inherited from data.container.IOrdered: addItemAfter, firstItemId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId

Inherited from data.container.IContainer: addContainerProperty, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getType, removeAllItems, removeContainerProperty, size

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

setCollapsed(self, itemId, collapsed)

source code

Collapsing the Item indicated by itemId hides all children, and their respective children, from the Container.

If called on a leaf Item, this method does nothing.

Parameters:

itemId - the identifier of the collapsed Item
collapsed - True if you want to collapse the children below this Item. False if you want to uncollapse the children.

isCollapsed(self, itemId)

source code

Checks whether the Item, identified by itemId is collapsed or not.

If an Item is "collapsed" its children are not included in methods used to list Items in this container.

Parameters:

itemId - The Item's identifier that is to be checked.

Returns:

True iff the Item identified by itemId is currently collapsed, otherwise False.