WorkspaceStore

Extends

• AbstractPersistedStore<WorkspacePrefsSerialized, WorkspaceStoreListener>

Constructors

Constructor

new WorkspaceStore(): WorkspaceStore;

Returns

WorkspaceStore

Overrides

AbstractPersistedStore.constructor

Properties

Property	Type	Inherited from
advancedLayoutEngine	AdvancedLayoutEngine	-
engine	ReactorWorkspaceEngine	-
layoutEngine	AbstractLayoutEngine	-
logger	Logger	AbstractPersistedStore.logger
saveWorkspaceDebounced	DebouncedFunc<() => void>	-
simpleLayoutEngine	SimpleLayoutEngine	-
workspaceGenerators	Set<WorkspaceGenerator>	-

Accessors

activatedModel

---

currentModel

---

currentTopWorkspace

---

dialogStore

---

fullscreenModel

---

initialized

Inherited from

AbstractPersistedStore.initialized

---

name

Get Signature

get name(): string;

Returns

string

Inherited from

AbstractPersistedStore.name

---

workspaces

Methods

activateModel()

activateModel(model): void;

Parameters

Parameter	Type
model	WorkspaceModel

Returns

void

---

activatePanel()

activatePanel(model): Promise<void>;

Parameters

Parameter	Type
model	ReactorPanelModel

Returns

Promise<void>

---

addModel()

addModel<T>(input): T;

Type Parameters

Type Parameter
T extends WorkspaceModel<SerializedModel, WorkspaceModelListener>

Parameters

Parameter	Type
input	T

Returns

T

---

addModelInWindow()

addModelInWindow(input, options): void;

Parameters

Parameter	Type
input	WorkspaceModel
options	{ height: number; position?: Alignment; width: number; }
options.height	number
options.position?	Alignment
options.width	number

Returns

void

---

addModels()

addModels<T>(input, options?): T;

Type Parameters

Type Parameter
T extends WorkspaceModel<SerializedModel, WorkspaceModelListener>[]

Parameters

Parameter	Type
input	T
options	AddModelsOptions

Returns

T

---

cloneWorkspace()

cloneWorkspace(name, key): void;

Parameters

Parameter	Type
name	string
key	string

Returns

void

---

collapseWorkspaceGroup()

collapseWorkspaceGroup(key): Promise<void>;

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

convertWorkspaceToGroup()

convertWorkspaceToGroup(key): Promise<void>;

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

deleteWorkspace()

deleteWorkspace(key): void;

Parameters

Parameter	Type
key	string

Returns

void

---

findModel()

findModel(root, id): WorkspaceModel;

Parameters

Parameter	Type
root	WorkspaceNodeModel
id	string

Returns

WorkspaceModel

---

flatten()

flatten(root): WorkspaceModel<SerializedModel, WorkspaceModelListener>[];

Parameters

Parameter	Type
root	WorkspaceNodeModel

Returns

WorkspaceModel<SerializedModel, WorkspaceModelListener>[]

---

generateFullscreenButton()

generateFullscreenButton(model): Btn;

Parameters

Parameter	Type
model	WorkspaceModel

Returns

Btn

---

generateRootModel()

generateRootModel(): ReactorRootWorkspaceModel;

Returns

ReactorRootWorkspaceModel

---

generateWorkspace()

generateWorkspace(generator): Promise<WorkspaceEntry>;

Parameters

Parameter	Type
generator	WorkspaceGenerator

Returns

Promise<WorkspaceEntry>

---

getActivePanelHash()

getActivePanelHash(): string;

Returns

string

---

getActiveTopWorkspace()

getActiveTopWorkspace(): WorkspaceEntry;

Returns

WorkspaceEntry

---

getActiveWorkspace()

getActiveWorkspace(): WorkspaceModel;

Returns

WorkspaceModel

---

getAllWorkspaces()

getAllWorkspaces(): WorkspaceModel[];

Returns

WorkspaceModel[]

---

getControls()

getControls(): AbstractSetting<AbstractSettingOptions>[];

Returns

AbstractSetting<AbstractSettingOptions>[]

Inherited from

AbstractPersistedStore.getControls

---

getExportedWorkspacesURL()

getExportedWorkspacesURL(): string;

Returns

string

---

getExportedWorkspaceURL()

getExportedWorkspaceURL(key): string;

Parameters

Parameter	Type
key	string

Returns

string

---

getIDEWorkspace()

getIDEWorkspace(id): WorkspaceModel;

Parameters

Parameter	Type
id	string

Returns

WorkspaceModel

---

getPanelFactories()

getPanelFactories(opts?): ReactorPanelFactory<ReactorPanelModel<WorkspaceModelListener>>[];

Parameters

Parameter	Type
opts	GetPanelFactoryOptions

Returns

ReactorPanelFactory<ReactorPanelModel<WorkspaceModelListener>>[]

---

getRoot()

getRoot(): ReactorRootWorkspaceModel;

Returns

ReactorRootWorkspaceModel

---

getSafeWorkspaceName()

getSafeWorkspaceName(name, excludeKey?): string;

Parameters

Parameter	Type
name	string
excludeKey?	string

Returns

string

---

getSafeWorkspaceNameInGroup()

getSafeWorkspaceNameInGroup(
   group, 
   name, 
   excludeKey?
): string;

Parameters

Parameter	Type
group	WorkspaceGroup
name	string
excludeKey?	string

Returns

string

---

getTabGroups()

getTabGroups(): ReactorTabFactoryModel[];

Returns

ReactorTabFactoryModel[]

---

getTopLevelWorkspace()

getTopLevelWorkspace(key): WorkspaceEntry;

Parameters

Parameter	Type
key	string

Returns

WorkspaceEntry

---

getTopLevelWorkspaces()

getTopLevelWorkspaces(): WorkspaceEntry[];

Returns

WorkspaceEntry[]

---

getWorkspace()

getWorkspace(key): WorkspaceModel;

Parameters

Parameter	Type
key	string

Returns

WorkspaceModel

---

getWorkspaceEntry()

getWorkspaceEntry(key): WorkspaceEntry;

Parameters

Parameter	Type
key	string

Returns

WorkspaceEntry

---

hasOne()

hasOne(factory): boolean;

Parameters

Parameter	Type
factory	ReactorPanelFactory

Returns

boolean

---

hydratePanelFromURL()

hydratePanelFromURL(): void;

Returns

void

---

importWorkspace()

importWorkspace(): Promise<boolean>;

Returns

Promise<boolean>

---

init()

init(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractPersistedStore.init

---

newWorkspace()

newWorkspace(name): Promise<void>;

Parameters

Parameter	Type
name	string

Returns

Promise<void>

---

newWorkspaceInGroup()

newWorkspaceInGroup(groupKey, name): Promise<void>;

Parameters

Parameter	Type
groupKey	string
name	string

Returns

Promise<void>

---

registerFactory()

registerFactory(factory): void;

Parameters

Parameter	Type
factory	ReactorPanelFactory

Returns

void

---

registerWorkspaceEntry()

registerWorkspaceEntry(workspace): void;

Parameters

Parameter	Type
workspace	WorkspaceEntry

Returns

void

---

registerWorkspaceGenerator()

registerWorkspaceGenerator(generator): void;

Parameters

Parameter	Type
generator	WorkspaceGenerator

Returns

void

---

registerWorkspaceGroup()

registerWorkspaceGroup(group): void;

Parameters

Parameter	Type
group	WorkspaceGroup

Returns

void

---

registerWorkspaces()

registerWorkspaces(model): void;

Parameters

Parameter	Type
model	WorkspaceModel

Returns

void

---

renameWorkspace()

renameWorkspace(name, key): void;

Parameters

Parameter	Type
name	string
key	string

Returns

void

---

reset()

reset(): Promise<void>;

Returns

Promise<void>

---

runDeserialization()

runDeserialization(): Promise<boolean>;

Returns

Promise<boolean>

Inherited from

AbstractPersistedStore.runDeserialization

---

save()

save(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractPersistedStore.save

---

setActiveWorkspace()

setActiveWorkspace(key): Promise<void>;

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

setFullscreenModel()

setFullscreenModel(model): void;

Parameters

Parameter	Type
model	WorkspaceModel<SerializedModel, WorkspaceModelListener>

Returns

void

---

setLogger()

setLogger(logger): void;

Parameters

Parameter	Type
logger	Logger

Returns

void

Inherited from

AbstractPersistedStore.setLogger

---

setWorkspaceLayoutEngine()

setWorkspaceLayoutEngine(engine): void;

Parameters

Parameter	Type
engine	AbstractLayoutEngine

Returns

void

---

switchLayoutEngine()

switchLayoutEngine(advanced): void;

Parameters

Parameter	Type
advanced	boolean

Returns

void

---

updateOptions()

updateOptions(options): void;

Parameters

Parameter	Type
options	Partial<Omit<AbstractPersistedStoreOptions<T>, "name">>

Returns

void

Inherited from

AbstractPersistedStore.updateOptions

---

waitForReady()

waitForReady(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractPersistedStore.waitForReady

---

walk()

walk(root, cb): void;

Parameters

Parameter	Type
root	WorkspaceModel
cb	(model) => any

Returns

void