kui_shell_plugin_client_common.TabModel.md

Kui API Documentation - v11.0.0 / @kui-shell/plugin-client-common / TabModel

Class: TabModel

@kui-shell/plugin-client-common.TabModel

Table of contents

Constructors

• constructor

Accessors

• buttons
• exec
• initialCommandLine
• onClose
• state
• title
• uuid

Methods

• setTitle
• update

Constructors

constructor

• new TabModel(_uuid?, desiredStatusStripeDecoration?, doNotChangeActiveTab?, _title?, _state?, _buttons?, _initialCommandLine?, _onClose?, _exec?)

Parameters

Name	Type	Default value
_uuid	string	undefined
desiredStatusStripeDecoration?	StatusStripeChangeEvent	undefined
doNotChangeActiveTab?	boolean	undefined
_title?	string	undefined
_state	default	undefined
_buttons	TopTabButton<{ key: string }>[]	[]
_initialCommandLine?	string	undefined
_onClose?	string	undefined
_exec?	"pexec" | "qexec"	undefined

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:30

Accessors

buttons

• get buttons(): TopTabButton<{ key: string }>[]

Returns

TopTabButton<{ key: string }>[]

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:56

---

exec

• get exec(): "pexec" | "qexec"

Returns

"pexec" | "qexec"

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:76

---

initialCommandLine

• get initialCommandLine(): string

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:68

---

onClose

• get onClose(): string

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:72

---

state

• get state(): default

Returns

default

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:52

---

title

• get title(): string

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:60

---

uuid

• get uuid(): string

Returns

string

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:48

Methods

setTitle

▸ setTitle(newTitle): TabModel

Parameters

Name	Type
newTitle	string

Returns

TabModel

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:64

---

update

▸ update(buttons, newTitle?): TabModel

Parameters

Name	Type
buttons	TopTabButton<{ key: string }>[]
newTitle?	string

Returns

TabModel

Defined in

plugins/plugin-client-common/src/components/Client/TabModel.ts:80