PluginIconTheme | Theia TypeDoc

Hierarchy

PluginIconThemeDefinition
- PluginIconTheme

Implements

IconTheme
Disposable

Index

Constructors

constructor

Methods

Constructors

constructor

new PluginIconTheme(): PluginIconTheme

Inherited from PluginIconThemeDefinition.constructor

Returns PluginIconTheme

Properties

Protected Readonly definition

definition: PluginIconThemeDefinition

Optional description

description: string

Protected Readonly fileIcon

fileIcon: "theia-plugin-file-icon" = 'theia-plugin-file-icon'

Protected Readonly fileService

fileService: FileService

Protected Readonly folderExpandedIcon

folderExpandedIcon: "theia-plugin-folder-expanded-icon" = 'theia-plugin-folder-expanded-icon'

Protected Readonly folderIcon

folderIcon: "theia-plugin-folder-icon" = 'theia-plugin-folder-icon'

Optional hasFileIcons

hasFileIcons: boolean

Optional hasFolderIcons

hasFolderIcons: boolean

Optional hidesExplorerArrows

hidesExplorerArrows: boolean

Protected Readonly icons

icons: Set<string> = ...

id

id: string

label

label: string

Protected Readonly labelProvider

labelProvider: LabelProvider

Protected locationUri

locationUri: default

Readonly onDidChange

onDidChange: Event<DidChangeLabelEvent> = ...

Protected Readonly onDidChangeEmitter

onDidChangeEmitter: Emitter<DidChangeLabelEvent> = ...

Protected packageRootUri

packageRootUri: default

packageUri

packageUri: string

pluginId

pluginId: string

Protected reload

reload: DebouncedFunc<() => void> = ...

Protected Readonly rootFolderExpandedIcon

rootFolderExpandedIcon: "theia-plugin-root-folder-expanded-icon" = 'theia-plugin-root-folder-expanded-icon'

Protected Readonly rootFolderIcon

rootFolderIcon: "theia-plugin-root-folder-icon" = 'theia-plugin-root-folder-icon'

Protected styleSheetContent

styleSheetContent: undefined | string

Protected Readonly toDeactivate

toDeactivate: DisposableCollection = ...

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeStyleElement

toDisposeStyleElement: DisposableCollection = ...

Protected Readonly toUnload

toUnload: DisposableCollection = ...

Optional uiTheme

uiTheme: "vs" | "vs-dark" | "hc-black"

uri

uri: string

Protected Readonly workspaceService

workspaceService: WorkspaceService

Methods

activate

activate(): Disposable

Implementation of IconTheme.activate
- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:145
Returns Disposable

Protected collectSelectors

collectSelectors(associations: RecursivePartial<PluginIconsAssociation>, accept: (definitionId: string, ...icons: string[]) => void): void

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:385
Parameters
- associations: RecursivePartial<PluginIconsAssociation>
- accept: (definitionId: string, ...icons: string[]) => void
  - - (definitionId: string, ...icons: string[]): void
    - Parameters
      - definitionId: string
      - Rest ...icons: string[]
      Returns void
Returns void

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:137
Returns void

Protected doActivate

doActivate(): Promise<void>

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:154
Returns Promise<void>

Protected escapeCSS

escapeCSS(value: string): string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:341
Parameters
- value: string
Returns string

Protected expandedFolderNameIcon

expandedFolderNameIcon(folderName: string): string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:357
Parameters
- folderName: string
Returns string

Protected fileExtensionIcon

fileExtensionIcon(fileExtension: string): string[]

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:367
Parameters
- fileExtension: string
Returns string[]

Protected fileNameIcon

fileNameIcon(fileName: string): string[]

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:360
Parameters
- fileName: string
Returns string[]

Protected fireDidChange

fireDidChange(): void

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:141
Returns void

Protected folderNameIcon

folderNameIcon(folderName: string): string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:354
Parameters
- folderName: string
Returns string

Protected getClassNames

getClassNames(element: FileStat | default | URIIconReference | FileStatNode | WorkspaceRootNode): string[]

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:473
Parameters
- element: FileStat | default | URIIconReference | FileStatNode | WorkspaceRootNode
Returns string[]

Protected getFileClassNames

getFileClassNames(element: object, uri?: string): string[]

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:511
Parameters
- element: object
- Optional uri: string
Returns string[]

Protected getFolderClassNames

getFolderClassNames(element: object): string[]

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:506
Parameters
- element: object
Returns string[]

getIcon

getIcon(element: FileStat | default | URIIconReference | FileStatNode | WorkspaceRootNode): string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:460
This should be aligned with https://github.com/microsoft/vscode/blob/7cf4cca47aa025a590fc939af54932042302be63/src/vs/editor/common/services/getIconClasses.ts#L5

Parameters
- element: FileStat | default | URIIconReference | FileStatNode | WorkspaceRootNode
Returns string

Protected init

init(): void

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:131
Returns void

Protected languageIcon

languageIcon(languageId: string): string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:381
Parameters
- languageId: string
Returns string

Protected load

load(): Promise<void>

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:184
This should be aligned with https://github.com/microsoft/vscode/blob/7cf4cca47aa025a590fc939af54932042302be63/src/vs/workbench/services/themes/browser/fileIconThemeData.ts#L201

Returns Promise<void>

Protected toCSSUrl

toCSSUrl(iconPath: undefined | string): undefined | string

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:330
Parameters
- iconPath: undefined | string
Returns undefined | string

Protected updateStyleElement

updateStyleElement(): void

- Defined in packages/plugin-ext/src/main/browser/plugin-icon-theme-service.ts:159
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginIconTheme

Properties

Protected Readonly definition

Optional description

Protected Readonly fileIcon

Protected Readonly fileService

Protected Readonly folderExpandedIcon

Protected Readonly folderIcon

Optional hasFileIcons

Optional hasFolderIcons

Optional hidesExplorerArrows

Protected Readonly icons

id

label

Protected Readonly labelProvider

Protected locationUri

Readonly onDidChange

Protected Readonly onDidChangeEmitter

Protected packageRootUri

packageUri

pluginId

Protected reload

Protected Readonly rootFolderExpandedIcon

Protected Readonly rootFolderIcon

Protected styleSheetContent

Protected Readonly toDeactivate

Protected Readonly toDispose

Protected Readonly toDisposeStyleElement

Protected Readonly toUnload

Optional uiTheme

uri

Protected Readonly workspaceService

Methods

activate

Returns Disposable

Protected collectSelectors

Parameters

associations: RecursivePartial<PluginIconsAssociation>

accept: (definitionId: string, ...icons: string[]) => void

Parameters

definitionId: string

Rest ...icons: string[]

Returns void

Returns void

dispose

Returns void

Protected doActivate

Returns Promise<void>

Protected escapeCSS

Parameters

value: string

Returns string

Protected expandedFolderNameIcon

Parameters

folderName: string

Returns string

Protected fileExtensionIcon

Parameters

fileExtension: string

Returns string[]

Protected fileNameIcon

Parameters

fileName: string

Returns string[]

Protected fireDidChange

Returns void

Protected folderNameIcon

Parameters

folderName: string

Returns string

Protected getClassNames

Parameters