Class LaTeXTableOfContentsFactory

Table of content model factory for LaTeX files.

Hierarchy (view full)

EditorTableOfContentsFactory
- LaTeXTableOfContentsFactory

Index

Constructors

Properties

Methods

_createNew createNew isApplicable

Constructors

constructor

new LaTeXTableOfContentsFactory(tracker): LaTeXTableOfContentsFactory
Constructor
Parameters
- tracker: IWidgetTracker<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>
  Widget tracker
Returns LaTeXTableOfContentsFactory
Inherited from EditorTableOfContentsFactory.constructor
- Defined in packages/toc/lib/factory.d.ts:16

Properties

`Protected` tracker

tracker: IWidgetTracker<IDocumentWidget<FileEditor, DocumentRegistry.IModel>>

Widget tracker

Methods

`Protected` _createNew

_createNew(widget, configuration?): LaTeXTableOfContentsModel
Create a new table of contents model for the widget
Parameters
- widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  widget
- Optional configuration: TableOfContents.IConfig
  Table of contents configuration
Returns LaTeXTableOfContentsModel
The table of contents model
Overrides EditorTableOfContentsFactory._createNew
- Defined in packages/fileeditor/src/toc/latex.ts:139

createNew

createNew(widget, configuration?): TableOfContentsModel<IEditorHeading, IDocumentWidget<FileEditor, DocumentRegistry.IModel>>
Create a new table of contents model for the widget
Parameters
- widget: IDocumentWidget<FileEditor, DocumentRegistry.IModel>
  widget
- Optional configuration: TableOfContents.IConfig
  Table of contents configuration
Returns TableOfContentsModel<IEditorHeading, IDocumentWidget<FileEditor, DocumentRegistry.IModel>>
The table of contents model
Inherited from EditorTableOfContentsFactory.createNew
- Defined in packages/fileeditor/src/toc/factory.ts:36

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
Overrides EditorTableOfContentsFactory.isApplicable
- Defined in packages/fileeditor/src/toc/latex.ts:122