WorkspaceGroup

Extends

• WorkspaceModel

Constructors

Constructor

new WorkspaceGroup(options): WorkspaceGroup;

Parameters

Parameter	Type
options	WorkspaceGroupOptions

Returns

WorkspaceGroup

Overrides

WorkspaceModel.constructor

Properties

Property	Type	Inherited from
children	WorkspaceModel[]	-
id	string	WorkspaceModel.id
immutable	boolean	WorkspaceModel.immutable
lastActiveChildId?	string	-
model?	ReactorRootWorkspaceModel	WorkspaceModel.model
name	string	WorkspaceModel.name
parentId?	string	WorkspaceModel.parentId
preferredOpenActions	Record<string, string>	WorkspaceModel.preferredOpenActions
priority?	number	WorkspaceModel.priority

Accessors

key

Get Signature

get key(): string;

Returns

string

Inherited from

WorkspaceModel.key

---

mutable

Get Signature

get mutable(): boolean;

Returns

boolean

Inherited from

WorkspaceModel.mutable

Methods

activate()

activate(key?): WorkspaceActivation;

Parameters

Parameter	Type
key?	string

Returns

WorkspaceActivation

Overrides

WorkspaceModel.activate

---

addWorkspace()

addWorkspace(workspace): void;

Parameters

Parameter	Type
workspace	WorkspaceModel

Returns

void

---

clone()

clone(options): WorkspaceGroup;

Parameters

Parameter	Type
options	{ engine: ReactorWorkspaceEngine; generateRootModel: () => ReactorRootWorkspaceModel; id: string; name: string; }
options.engine	ReactorWorkspaceEngine
options.generateRootModel	() => ReactorRootWorkspaceModel
options.id	string
options.name	string

Returns

WorkspaceGroup

Overrides

WorkspaceModel.clone

---

cloneForImport()

cloneForImport(options): WorkspaceGroup;

Parameters

Parameter	Type
options	WorkspaceModelCloneOptions & { getSafeChildName: (name, siblings) => string; }

Returns

WorkspaceGroup

Overrides

WorkspaceModel.cloneForImport

---

collapseToWorkspace()

collapseToWorkspace(): WorkspaceModel;

Returns

WorkspaceModel

---

contains()

contains(key): boolean;

Parameters

Parameter	Type
key	string

Returns

boolean

Overrides

WorkspaceModel.contains

---

getAllWorkspaces()

getAllWorkspaces(): WorkspaceModel[];

Returns

WorkspaceModel[]

Overrides

WorkspaceModel.getAllWorkspaces

---

getChild()

getChild(key): WorkspaceModel;

Parameters

Parameter	Type
key	string

Returns

WorkspaceModel

---

getChildren()

getChildren(): WorkspaceModel[];

Returns

WorkspaceModel[]

Overrides

WorkspaceModel.getChildren

---

getContextMenuItems()

getContextMenuItems(context): ComboBoxItem[];

Parameters

Parameter	Type
context	WorkspaceContextActionContext

Returns

ComboBoxItem[]

Overrides

WorkspaceModel.getContextMenuItems

---

getPreferredOpenAction()

getPreferredOpenAction(entityType): string;

Parameters

Parameter	Type
entityType	string

Returns

string

Inherited from

WorkspaceModel.getPreferredOpenAction

---

isGroup()

isGroup(): boolean;

Returns

boolean

Overrides

WorkspaceModel.isGroup

---

serialize()

serialize(): SerializedWorkspaceGroup;

Returns

SerializedWorkspaceGroup

Overrides

WorkspaceModel.serialize

---

setPreferredOpenAction()

setPreferredOpenAction(entityType, actionId): WorkspaceGroup;

Parameters

Parameter	Type
entityType	string
actionId	string

Returns

WorkspaceGroup

Inherited from

WorkspaceModel.setPreferredOpenAction

---

deserialize()

static deserialize(
   pref, 
   engine, 
   generateRootModel
): WorkspaceGroup;

Parameters

Parameter	Type
pref	SerializedWorkspaceGroup
engine	ReactorWorkspaceEngine
generateRootModel	() => ReactorRootWorkspaceModel

Returns

WorkspaceGroup

Overrides

WorkspaceModel.deserialize

---

fromWorkspace()

static fromWorkspace(workspace, options): WorkspaceGroup;

Parameters

Parameter	Type
workspace	WorkspaceModel
options	{ childId: string; childName: string; }
options.childId	string
options.childName	string

Returns

WorkspaceGroup