Private _activePrivate _createPrivate _createPrivate _cycleCycle through the available completer items.
When the user cycles all the way down to the last index, subsequent
down cycles will cycle to the first index. When the user cycles up to
the first item, subsequent up cycles will cycle to the last index.
Private _defaultPrivate _docPrivate _docPrivate _docPrivate _editorPrivate _evtHandle keydown events for the widget.
Private _evtHandle mousedown events for the widget.
Private _evtHandle scroll events for the widget
Private _findUse preferred heuristic to find the index of the widest item.
Private _geometryIncreasing this counter invalidates previous request to save geometry cache in animation callback.
Private _geometryPrivate _getGet item width heuristic function from renderer if available, or the default one otherwise.
Private _indexPrivate _lastPrivate _maxThe maximum height of a completer widget.
Private _minThe minimum height of a completer widget.
Private _modelPrivate _populatePopulate the completer up to the longest initial subset of items.
true if a subset match was found and populated.
Private _renderPrivate _rendererPrivate _scrollbarPrivate _selectedPrivate _setSet the visible dimensions of the widget.
Private _showPrivate _sizePrivate _togglePrivate _updateUpdate the display-state and contents of the documentation panel
Private _visibilityReadonly nodeGet the DOM node owned by the widget.
Readonly sanitizerThe sanitizer used to sanitize untrusted HTML inputs.
The active index.
The dataset for the widget's DOM node.
The editor used by the completion widget.
Get the method for hiding the widget.
Set 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.
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.
Get the layout for the widget.
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 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 completer used by the completer widget.
Enable/disable the document panel.
Protected sizeGet cached dimensions of the completer box.
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 _updatePost 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.
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.
Post a 'fit-request' message to the widget.
This is a simple convenience method for posting the message.
Protected notifyInvoke 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.
Protected onA message handler invoked on an 'activate-request' message.
The default implementation of this handler is a no-op.
Protected onProtected 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 onProtected 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 onHandle model query changes.
Protected onProtected onA message handler invoked on a 'resize' message.
The default implementation of this handler is a no-op.
Protected onRemove 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.
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().
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.
Post an 'update-request' message to the widget.
This is a simple convenience method for posting the message.
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.