ProtectedaiIndicates whether the "ai-core" extension is available.
ProtectedapplicationThe ApplicationInfo for the application if available.
Used in order to obtain the version number of the application.
ProtectedapplicationThe application name which is used for display purposes.
Protected ReadonlyappProtected ReadonlycommandProtected ReadonlycompatibilityProtected ReadonlydataProtected ReadonlydocumentationCollection of useful links to display for end users.
Protected ReadonlyenvironmentsProtected ReadonlyextensionProtected ReadonlyghProtectedhomeProtected ReadonlylabelProtected ReadonlyloggerProtected ReadonlymarkdownReadonlynodeGet the DOM node owned by the widget.
ProtectednodeReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonProtected ReadonlypluginProtected ReadonlypreferenceProtectedrecentThe recently used workspaces limit. Used in order to limit the number of recently used workspaces to display.
ProtectedrecentThe list of recently used workspaces.
Protected OptionalscrollProtected OptionalscrollProtected ReadonlytheiaProtected ReadonlythemeProtected ReadonlytoProtected ReadonlytoProtected ReadonlyuserProtected ReadonlywalkthroughProtected ReadonlywindowProtected ReadonlyworkspaceStatic ReadonlyIDThe widget id.
Static ReadonlyLABELThe 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 visible.
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.
Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.
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.
ProtectedaddProtectedaddOptionaluseCapture: booleanProtectedaddProtectedaddProtectedbuildBuild 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.
Clear the given widget flag.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
ProtecteddisableProtecteddoTrigger the create file command.
ProtecteddoProtecteddoProtecteddoTrigger the open command.
ProtecteddoProtecteddoProtecteddoTrigger the open AI configuration command.
Used to open the AI Configuration view, which manages the AI preferences.
Referenced by id because @theia/getting-started does not depend on the AI packages, as with the
AI chat view above.
ProtecteddoProtecteddoProtecteddoOpen a link in an external window.
the link.
ProtecteddoProtecteddoTrigger the open file command.
ProtecteddoProtecteddoTrigger the open folder command.
ProtecteddoProtecteddoTrigger the open keyboard shortcuts command. Used to open the keyboard shortcuts widget.
ProtecteddoProtecteddoTrigger the open preferences command. Used to open the preferences widget.
ProtecteddoProtecteddoTrigger the open recent workspace command.
ProtecteddoProtecteddoTrigger the open workspace command.
ProtecteddoProtectedgetProtectedhandleTest 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.
ProtectedinitProtectedisProtectednotifyProtectedonA message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-attach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-detach' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
ProtectedonA message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
ProtectedonA message handler invoked on an 'update-request' message.
The default implementation of this handler is a no-op.
ProtectedopenProtectedopenProtectedrefreshProtectedrenderRender the content of the widget.
ProtectedrenderProtectedrenderRender the widget header.
Renders the title {applicationName} Getting Started.
ProtectedrenderRender the help section.
ProtectedrenderProtectedrenderProtectedrenderRender the recently used workspaces section.
ProtectedrenderRender the selected walkthrough on its own, taking over the whole view. The regular welcome content is restored once the walkthrough is closed.
ProtectedrenderRender the settings section. Generally used to display useful links.
ProtectedrenderRender the Start section.
Displays a collection of "start-to-work" related commands like open commands and some other.
ProtectedrenderRender the version section.
ProtectedrenderSet the given widget flag.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
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.
ProtectedshowTest whether the given widget flag is set.
This will not typically be called directly by user code.
Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Toggle a class name on the widget's DOM node.
The class name to toggle on the node.
Optionalforce: 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.
ProtectedupdateName the widget after the walkthrough it currently shows, so that it can be told apart from the regular welcome content in the tab bar.
Default implementation of the
GettingStartedWidget. The widget is displayed when there are currently no workspaces present. Some of the features displayed include:opencommands.recently used workspaces.settingscommands.helpcommands.