pydoctor.templatewriter.pages.sidebar.ExpandableItem

class documentation

class ExpandableItem(LinkOnlyItem): (source)

View In Hierarchy

Sidebar expandable item: link to an object and have a triangle that expand/collapse it's contents

Used by ContentItem.expandableItem

Note
ExpandableItem can be created with do_not_expand flag. This will generate a expandable item with a special notExpandable CSS class. It differs from LinkOnlyItem, wich do not show the expand button, here we show it but we make it unusable by assinging an empty CSS ID.
Method __init__ Undocumented
Method contents Undocumented
Method expandableItemId Undocumented
Method labelClass Undocumented
Method labelForExpandableItemId Undocumented
Class Variable last_ExpandableItem_id Undocumented
Instance Variable _contents Undocumented
Instance Variable _do_not_expand Undocumented
Instance Variable _id Undocumented

Inherited from LinkOnlyItem:

Method name Undocumented
Instance Variable child Undocumented
Instance Variable documented_ob Undocumented
def __init__(self, loader, child, documented_ob, contents, do_not_expand=False): (source)
overrides pydoctor.templatewriter.pages.sidebar.LinkOnlyItem.__init__

Undocumented

Parameters
loader:ITemplateLoaderUndocumented
child:DocumentableUndocumented
documented_ob:DocumentableUndocumented
contents:ObjContentUndocumented
do_not_expand:boolUndocumented
@renderer
def contents(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
ObjContentUndocumented
@renderer
def expandableItemId(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
strUndocumented
@renderer
def labelClass(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
strUndocumented
@renderer
def labelForExpandableItemId(self, request, tag): (source)

Undocumented

Parameters
request:IRequestUndocumented
tag:TagUndocumented
Returns
strUndocumented
last_ExpandableItem_id: int = (source)

Undocumented

_contents = (source)

Undocumented

_do_not_expand = (source)

Undocumented

_id = (source)

Undocumented