Interface IThemeCollection

A collection of themes.

interface IThemeCollection {
    getDefaultTheme: () => ITheme;
    setDefaultTheme: (theme: ITheme) => ITheme;
    deleteCustomTheme(theme: string | ITheme): ITheme;
    getByName(name: string): ITheme;
    getCount(): number;
    search(options?: SearchOptions): ITheme[];
    setCustomTheme(theme: ITheme): ITheme;
}

Hierarchy (View Summary)

ICollection
- IThemeCollection

Implemented by

ThemeCollection

Index

Properties

getDefaultTheme setDefaultTheme

Methods

deleteCustomTheme getByName getCount search setCustomTheme

Properties

getDefaultTheme

getDefaultTheme: () => ITheme

Returns the name of the default Theme.

Type declaration

- (): ITheme
- Returns ITheme
  A theme that has been set as the Default using setDefaultTheme.

setDefaultTheme

setDefaultTheme: (theme: ITheme) => ITheme

Set the new default theme.

Type declaration

- (theme: ITheme): ITheme
- Parameters
  - theme: ITheme
  Returns ITheme
  The previous default theme.

Methods

deleteCustomTheme

deleteCustomTheme(theme: string | ITheme): ITheme
Remove a custom theme.
Parameters
- theme: string | ITheme
  A Theme or string.
Returns ITheme
true if the Theme was removed.

getByName

getByName(name: string): ITheme
Returns the theme for the given name.
Parameters
- name: string
Returns ITheme
Remarks
Will try to return:
1. The custom theme for the name
2. The builtin theme for the name.
3. nul if it doesn't exist.

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Inherited from ICollection.getCount

search

search(options?: SearchOptions): ITheme[]
Returns all themes that match the search criteria.
Parameters
- Optionaloptions: SearchOptions
  IThemeCollection.SearchOptions
Returns ITheme[]
Remarks
- If no search criteria is provided, all items will be returned.
- Generates a new array so this can be mutated without affecting the internal state.

setCustomTheme

setCustomTheme(theme: ITheme): ITheme
Add or update a theme.
Parameters
- theme: ITheme
  The new theme.
Returns ITheme
The original theme

Remarks
Case insensitive; for duplicate detection purposes.