DecorationsManager | aspen-decorations

NOTES FOR CONTRIBUTORS:

A Target is a directory or a file entry
A Target is a DirectTarget when it is explicitly listed in a Decoration's application or negation list
As opposed to DirectTarget, general targets are implicit targets when they simply inherit from their parent's inhertiable DecorationComposite
All general targets "point to" their first parent's inheritable composite see docs for IDecorationMeta.inheritable

Hierarchy

DecorationsManager

Implements

IDisposable

Index

Constructors

constructor

Methods

Constructors

constructor

new DecorationsManager(root: Root): DecorationsManager

- Defined in DecorationManager.ts:33
Parameters
- root: Root
Returns DecorationsManager

Methods

addDecoration

addDecoration(decoration: Decoration): void

- Defined in DecorationManager.ts:66
Adds the given Decoration to the tree

Decorations have no effect unless they are targetted at item(s). Use Decoration#addTarget to have them render in the filetree

Parameters
- decoration: Decoration
Returns void

dispose

dispose(): void

- Defined in DecorationManager.ts:53
Permanently disengages the decoration system from the tree

Returns void

getDecorationData

getDecorationData(item: FileEntry | Directory): IDecorationMeta

- Defined in DecorationManager.ts:148
internal

Parameters
- item: FileEntry | Directory
Returns IDecorationMeta

getDecorations

getDecorations(item: FileEntry | Directory): ClasslistComposite

- Defined in DecorationManager.ts:134
Returns resolved decorations for given item

Resolution includes taking inheritances into consideration, along with any negations that may void some or all of inheritances

Parameters
- item: FileEntry | Directory
Returns ClasslistComposite

removeDecoration

removeDecoration(decoration: Decoration): void

- Defined in DecorationManager.ts:98
Removes a Decoration from the tree

Note that this "removes" entire Decoration from tree but the said Decoration's targets are still left intact.

Calling DecorationManager#addDecoration with the same Decoration will undo the removal if the targets are left unchanged.

Parameters
- decoration: Decoration
Returns void

Generated using TypeDoc