ProtectedacceptProtectedacceptProtectedactiveProtectedbackProtectedcloseProtected ReadonlycloseProtected ReadonlycontentProtected ReadonlycontrolProtected ReadonlyerrorProtectedforwardReadonlyhiddenProtectedhiddenProtectedhomeReadonlylocationProtectedlocationReadonlynodeGet the DOM node owned by the widget.
ReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlyonProtected ReadonlyonReadonlypropsProtectedrejecteslint-disable-next-line @typescript-eslint/no-explicit-any
ProtectedresolveProtected OptionalscrollProtected OptionalscrollProtected ReadonlytitleProtected ReadonlytoProtected ReadonlytoReadonlytreeProtectedtreeProtectedtreeProtectedupProtectedvalidateReadonlywidgetThe 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.
ProtectedacceptProtectedaddProtectedaddProtectedaddProtectedaddProtectedaddOptionaluseCapture: booleanProtectedaddProtectedaddProtectedaddProtectedappendOptionaltext: stringProtectedappendProtectedappendOptionaltext: stringProtectedappendCreate 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.
ProtectedcreateProtecteddisableProtectedgetProtectedgetProtectedhandleProtectedhandleProtectedhandleTest 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.
ProtectedisReturn a string of zero-length or true if valid.
ProtectednotifyProtectedonA 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.
OptionaldisposeOnResolve: booleanProtectedpreventThis prevents tabbing outside the dialog by marking elements as inert, i.e., non-clickable and non-focussable.
Optionalelements: Element[]the elements for which we disable tabbing. By default all elements within the body element are considered. Please note that this may also include other popups such as the suggestion overlay, the notification center or quick picks.
a disposable that will restore the previous tabbing behavior
ProtectedsetShow 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.
ProtectedtargetProtectedtargetTest 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.
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.
Protectedvalidate
The base class of the lumino widget hierarchy.
Notes
This class will typically be subclassed in order to create a useful widget. However, it can be used directly to host externally created content.