Decoration | aspen-decorations

Hierarchy

Decoration

Index

Constructors

constructor

Properties

cssClasslist

Accessors

Methods

Constructors

constructor

new Decoration(): Decoration
new Decoration(...cssClasslist: string[]): Decoration

- Defined in Decoration.ts:18
Returns Decoration
- Defined in Decoration.ts:20
Parameters
- Rest ...cssClasslist: string[]
Returns Decoration

Properties

cssClasslist

cssClasslist: Set<string>

Do not mutate directly, use Decoration#addCSSClass() / Decoration#removeCSSClass instead

Accessors

appliedTargets

appliedTargets:

disabled

disabled:

negatedTargets

negatedTargets:

Methods

addCSSClass

addCSSClass(classname: string): void

- Defined in Decoration.ts:51
Parameters
- classname: string
Returns void

addTarget

addTarget(directory: Directory, flags: TargetMatchMode): void
addTarget(file: FileEntry): void

- Defined in Decoration.ts:63
Parameters
- directory: Directory
- flags: TargetMatchMode
Returns void
- Defined in Decoration.ts:64
Parameters
- file: FileEntry
Returns void

negateTarget

negateTarget(directory: Directory, flags: TargetMatchMode): void
negateTarget(file: FileEntry): void

- Defined in Decoration.ts:86
Parameters
- directory: Directory
- flags: TargetMatchMode
Returns void
- Defined in Decoration.ts:87
Parameters
- file: FileEntry
Returns void

onDidAddCSSClassname

onDidAddCSSClassname(callback: function): IDisposable

- Defined in Decoration.ts:129
Parameters
- callback: function
  - - (decoration: Decoration, classname: string): void
    - Parameters
      - decoration: Decoration
      - classname: string
      Returns void
Returns IDisposable

onDidAddTarget

onDidAddTarget(callback: function): IDisposable

- Defined in Decoration.ts:109
Parameters
- callback: function
  - - (decoration: Decoration, target: FileEntry | Directory, flags: TargetMatchMode): void
    - Parameters
      - decoration: Decoration
      - target: FileEntry | Directory
      - flags: TargetMatchMode
      Returns void
Returns IDisposable

onDidDisableDecoration

onDidDisableDecoration(callback: function): IDisposable

- Defined in Decoration.ts:137
Parameters
- callback: function
  - - (decoration: Decoration): void
    - Parameters
      - decoration: Decoration
      Returns void
Returns IDisposable

onDidEnableDecoration

onDidEnableDecoration(callback: function): IDisposable

- Defined in Decoration.ts:133
Parameters
- callback: function
  - - (decoration: Decoration): void
    - Parameters
      - decoration: Decoration
      Returns void
Returns IDisposable

onDidNegateTarget

onDidNegateTarget(callback: function): IDisposable

- Defined in Decoration.ts:117
Parameters
- callback: function
  - - (decoration: Decoration, target: FileEntry | Directory, flags: TargetMatchMode): void
    - Parameters
      - decoration: Decoration
      - target: FileEntry | Directory
      - flags: TargetMatchMode
      Returns void
Returns IDisposable

onDidRemoveCSSClassname

onDidRemoveCSSClassname(callback: function): IDisposable

- Defined in Decoration.ts:125
Parameters
- callback: function
  - - (decoration: Decoration, classname: string): void
    - Parameters
      - decoration: Decoration
      - classname: string
      Returns void
Returns IDisposable

onDidRemoveTarget

onDidRemoveTarget(callback: function): IDisposable

- Defined in Decoration.ts:113
Parameters
- callback: function
  - - (decoration: Decoration, target: FileEntry | Directory): void
    - Parameters
      - decoration: Decoration
      - target: FileEntry | Directory
      Returns void
Returns IDisposable

onDidUnNegateTarget

onDidUnNegateTarget(callback: function): IDisposable

- Defined in Decoration.ts:121
Parameters
- callback: function
  - - (decoration: Decoration, target: FileEntry | Directory): void
    - Parameters
      - decoration: Decoration
      - target: FileEntry | Directory
      Returns void
Returns IDisposable

removeCSSClass

removeCSSClass(classname: string): void

- Defined in Decoration.ts:57
Parameters
- classname: string
Returns void

removeTarget

removeTarget(directory: Directory): void
removeTarget(file: FileEntry): void

- Defined in Decoration.ts:74
Parameters
- directory: Directory
Returns void
- Defined in Decoration.ts:75
Parameters
- file: FileEntry
Returns void

unNegateTarget

unNegateTarget(directory: Directory): void
unNegateTarget(file: FileEntry): void

- Defined in Decoration.ts:97
Parameters
- directory: Directory
Returns void
- Defined in Decoration.ts:98
Parameters
- file: FileEntry
Returns void

Generated using TypeDoc