Class TableOfContentsFactory<W, H>`Abstract`

Abstract table of contents model factory for IDocumentWidget.

Type Parameters

W extends IDocumentWidget
H extends TableOfContents.IHeading = TableOfContents.IHeading

Hierarchy

TableOfContentsFactory

Implements

TableOfContents.IFactory<W, H>

Index

Constructors

Properties

Methods

_createNew createNew isApplicable

Constructors

constructor

new TableOfContentsFactory<W, H>(tracker): TableOfContentsFactory<W, H>
Constructor
Type Parameters
- W extends IDocumentWidget<Widget, DocumentRegistry.IModel>
- H extends TableOfContents.IHeading = TableOfContents.IHeading
Parameters
- tracker: IWidgetTracker<W>
  
  Widget tracker
Returns TableOfContentsFactory<W, H>
- Defined in packages/toc/src/factory.ts:31

Properties

`Protected` tracker

tracker: IWidgetTracker<W>

Widget tracker

Methods

`Protected` `Abstract` _createNew

_createNew(widget, configuration?): TableOfContentsModel<H, W>
Abstract table of contents model instantiation to allow override by real implementation to customize it. The public createNew contains the signal connections standards for IDocumentWidget when the model has been instantiated.
Parameters
- widget: W
- Optional configuration: TableOfContents.IConfig
Returns TableOfContentsModel<H, W>
- Defined in packages/toc/src/factory.ts:104

createNew

createNew(widget, configuration?): TableOfContentsModel<H, W>
Create a new table of contents model for the widget
Parameters
- widget: W
  
  widget
- Optional configuration: TableOfContents.IConfig
  
  Table of contents configuration
Returns TableOfContentsModel<H, W>
The table of contents model
Implementation of IFactory.createNew
- Defined in packages/toc/src/factory.ts:54

isApplicable

isApplicable(widget): boolean
Whether the factory can handle the widget or not.
Parameters
- widget: Widget
  
  widget
Returns boolean
boolean indicating a ToC can be generated
Implementation of IFactory.isApplicable
- Defined in packages/toc/src/factory.ts:39

Generated using TypeDoc