Protected
aiIndicates whether the "ai-core" extension is available.
Protected
applicationThe ApplicationInfo
for the application if available.
Used in order to obtain the version number of the application.
Protected
applicationThe application name which is used for display purposes.
Protected
Readonly
appProtected
Readonly
commandProtected
Readonly
compatibilityProtected
Readonly
dataProtected
Readonly
documentationCollection of useful links to display for end users.
Protected
Readonly
environmentsProtected
Readonly
extensionProtected
Readonly
ghProtected
homeProtected
Readonly
labelReadonly
nodeGet the DOM node owned by the widget.
Protected
nodeReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onReadonly
onProtected
Readonly
onProtected
Readonly
pluginProtected
Readonly
preferenceProtected
recentThe recently used workspaces limit. Used in order to limit the number of recently used workspaces to display.
Protected
recentThe list of recently used workspaces.
Protected
Optional
scrollProtected
Optional
scrollProtected
Readonly
theiaProtected
Readonly
toProtected
Readonly
toProtected
Readonly
userProtected
Readonly
windowProtected
Readonly
workspaceStatic
Readonly
IDThe widget id
.
Static
Readonly
LABELThe widget label
which is used for display purposes.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
Get the method for hiding the widget.
Get the id of the widget's DOM node.
Set the id of the widget's DOM node.
Test whether the widget's node is attached to the DOM.
Test whether the widget has been disposed.
Test whether the widget is explicitly hidden.
Get the parent of the widget.
Set the parent of the widget.
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.
The widget will be automatically removed from its old parent.
This is a no-op if there is no effective parent change.
The title object for the widget.
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.
Since not all widgets will use the title, it is created on demand.
The owner
property of the title is set to this widget.
Protected
addProtected
addOptional
useCapture: booleanProtected
addProtected
addProtected
buildBuild the list of workspace paths.
{string[]} the list of workspaces.
the list of workspace paths.
Create an iterator over the widget's children.
A new iterator over the children of the widget.
The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true
if the widget is a descendant, false
otherwise.
Protected
disableProtected
doTrigger the create file command.
Protected
doProtected
doProtected
doTrigger the open command.
Protected
doProtected
doProtected
doProtected
doOpen a link in an external window.
the link.
Protected
doProtected
doTrigger the open file command.
Protected
doProtected
doTrigger the open folder command.
Protected
doProtected
doTrigger the open keyboard shortcuts command. Used to open the keyboard shortcuts widget.
Protected
doProtected
doTrigger the open preferences command. Used to open the preferences widget.
Protected
doProtected
doTrigger the open recent workspace command.
Protected
doProtected
doTrigger the open workspace command.
Protected
doProtected
getProtected
handleTest whether the widget's DOM node has the given class name.
The class name of interest.
true
if the node has the class, false
otherwise.
Hide the widget and make it hidden to its parent widget.
This causes the isHidden property to be true
.
If the widget is explicitly hidden, this is a no-op.
Protected
initProtected
isProtected
notifyProtected
onA message handler invoked on an 'activate-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-attach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'after-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-attach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-detach'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-hide'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'before-show'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-added'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'child-removed'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'close-request'
message.
The default implementation unparents or detaches the widget.
Protected
onA message handler invoked on a 'fit-request'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on a 'resize'
message.
The default implementation of this handler is a no-op.
Protected
onA message handler invoked on an 'update-request'
message.
The default implementation of this handler is a no-op.
Protected
openProtected
openProtected
renderRender the content of the widget.
Protected
renderProtected
renderRender the widget header.
Renders the title {applicationName} Getting Started
.
Protected
renderRender the help section.
Protected
renderProtected
renderProtected
renderRender the recently used workspaces section.
Protected
renderRender the settings section. Generally used to display useful links.
Protected
renderRender the Start
section.
Displays a collection of "start-to-work" related commands like open
commands and some other.
Protected
renderRender the version section.
Show the widget and make it visible to its parent widget.
This causes the isHidden property to be false
.
If the widget is not explicitly hidden, this is a no-op.
Test whether the given widget flag is set.
This will not typically be called directly by user code.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optional
force: booleanWhether to force add the class (true
) or force
remove the class (false
). If not provided, the presence of
the class will be toggled from its current state.
true
if the class is now present, false
otherwise.
The class name must not contain whitespace.
Default implementation of the
GettingStartedWidget
. The widget is displayed when there are currently no workspaces present. Some of the features displayed include:open
commands.recently used workspaces
.settings
commands.help
commands.