A type map that may add type annotations to completer matches.
Construct a text completer menu widget.
The dataset for the widget's DOM node.
A signal emitted when the widget is disposed.
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.
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.
Set the layout for the widget.
The layout is single-use only. It cannot be changed after the first assignment.
The layout is disposed automatically when the widget is disposed.
Get the DOM node owned by 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.
The default IRenderer instance.
The editor used by the completion widget.
The editor used by the completion widget.
A signal emitted when a selection is made from the completer menu.
A signal emitted when the completer widget's visibility changes.
This signal is useful when there are multiple floating widgets that may contend with the same space and ought to be mutually exclusive.
Cycle through the available completer items.
When the user cycles all the way down to the last index, subsequent
down cycles will remain on the last index. When the user cycles up to
the first item, subsequent up cycles will remain on the first cycle.
Handle keydown events for the widget.
Handle mousedown events for the widget.
Handle scroll events for the widget
Populate the completer up to the longest initial subset of items.
true if a subset match was found and populated.
Set the visible dimensions of the widget.
Post an 'activate-request' message to the widget.
This is a simple convenience method for posting the message.
Add a class name to the widget's DOM node.
The class name to add to the node.
If the class name is already added to the node, this is a no-op.
The class name must not contain whitespace.
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.
Send a 'close-request' message to the widget.
This is a simple convenience method for sending the message.
Test whether a widget is a descendant of this widget.
The descendant widget of interest.
true if the widget is a descendant, false otherwise.
Dispose of the resources held by the completer widget.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Handle the DOM events for the widget.
The DOM event sent to the widget.
This method implements the DOM EventListener interface and is
called in response to events on the dock panel's node. It should
not be called directly by user code.
Test 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.
Invoke the message processing routine of the widget's layout.
The message to dispatch to the layout.
This is a no-op if the widget does not have a layout.
This will not typically be called directly by user code.
A message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
Handle after-attach messages for the widget.
A message handler invoked on an 'after-detach' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on an 'after-show' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-attach' message.
The default implementation of this handler is a no-op.
Handle before-detach messages for the widget.
A message handler invoked on a 'before-hide' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'before-show' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-added' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'child-removed' message.
The default implementation of this handler is a no-op.
A message handler invoked on a 'close-request' message.
The default implementation unparents or detaches the widget.
A message handler invoked on a 'fit-request' message.
The default implementation of this handler is a no-op.
Handle model state changes.
A message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
Handle update-request messages.
Process a message sent to the widget.
The message sent to the widget.
Subclasses may reimplement this method as needed.
Remove a class name from the widget's DOM node.
The class name to remove from the node.
If the class name is not yet added to the node, this is a no-op.
The class name must not contain whitespace.
Reset the widget.
Emit the selected signal for the current active item and reset.
Set the given widget flag.
This will not typically be called directly by user code.
Show or hide the widget according to a boolean value.
true to hide the widget, or false to show it.
This is a convenience method for hide() and show().
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.
Whether 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.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
Attach a widget to a host DOM node.
The widget of interest.
The DOM node to use as the widget's host.
The child of host to use as the reference element.
If this is provided, the widget will be inserted before this
node in the host. The default is null, which will cause the
widget to be added as the last child of the host.
This will throw an error if the widget is not a root widget, if the widget is already attached, or if the host is not attached to the DOM.
Detach the widget from its host DOM node.
The widget of interest.
This will throw an error if the widget is not a root widget, or if the widget is not attached to the DOM.
Generated using TypeDoc
A widget that enables text completion.
Notes
The completer is intended to be absolutely positioned on the page and hover over any other content, so it should be attached directly to
document.body, or a node that is the full size ofdocument.body. Attaching it to other nodes may incorrectly locate the completer.