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 of document.body. Attaching it to other nodes may incorrectly locate the completer.

Hierarchy

Constructors

  • Construct a text completer menu widget.

    Parameters

    Returns Completer

Properties

_activeIndex: any
_createCompleterNode: any
_createDocPanelNode: any
_cycle: any

Cycle through the available completer items.

Notes

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.

_defaultRenderer: any
_docPanel: any
_docPanelExpanded: any
_docPanelWidth: any
_editor: any
_evtKeydown: any

Handle keydown events for the widget.

_evtPointerdown: any

Handle mousedown events for the widget.

_evtScroll: any

Handle scroll events for the widget

_findWidestItemIndex: any

Use preferred heuristic to find the index of the widest item.

_geometryCounter: any

Increasing this counter invalidates previous request to save geometry cache in animation callback.

_geometryLock: any
_getPreferredItemWidthHeuristic: any

Get item width heuristic function from renderer if available, or the default one otherwise.

_indexChanged: any
_lastSubsetMatch: any
_maxHeight: any

The maximum height of a completer widget.

_minHeight: any

The minimum height of a completer widget.

_model: any
_populateSubset: any

Populate the completer up to the longest initial subset of items.

Returns

true if a subset match was found and populated.

_renderCounter: any
_renderer: any
_scrollbarWidth: any
_selected: any
_setGeometry: any

Set the visible dimensions of the widget.

_showDoc: any
_sizeCache: any
_toggleDocPanel: any
_updateDocPanel: any

Update the display-state and contents of the documentation panel

_visibilityChanged: any

Get the DOM node owned by the widget.

The sanitizer used to sanitize untrusted HTML inputs.

Accessors

  • get activeIndex(): number
  • The active index.

    Returns number

  • get dataset(): DOMStringMap
  • The dataset for the widget's DOM node.

    Returns DOMStringMap

  • get disposed(): ISignal<this, void>
  • A signal emitted when the widget is disposed.

    Returns ISignal<this, void>

  • get editor(): IEditor
  • The editor used by the completion widget.

    Returns IEditor

  • set editor(newValue): void
  • Parameters

    • newValue: IEditor

    Returns void

  • get hiddenMode(): HiddenMode
  • Get the method for hiding the widget.

    Returns HiddenMode

  • set hiddenMode(value): void
  • Set the method for hiding the widget.

    Parameters

    • value: HiddenMode

    Returns void

  • get id(): string
  • Get the id of the widget's DOM node.

    Returns string

  • set id(value): void
  • Set the id of the widget's DOM node.

    Parameters

    • value: string

    Returns void

  • get indexChanged(): ISignal<this, number>
  • A signal emitted when the active index changes.

    Returns ISignal<this, number>

  • get isAttached(): boolean
  • Test whether the widget's node is attached to the DOM.

    Returns boolean

  • get isDisposed(): boolean
  • Test whether the widget has been disposed.

    Returns boolean

  • get isHidden(): boolean
  • Test whether the widget is explicitly hidden.

    Returns boolean

  • get isVisible(): boolean
  • Test whether the widget is visible.

    Notes

    A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

    Returns boolean

  • get layout(): Layout
  • Get the layout for the widget.

    Returns Layout

  • set layout(value): void
  • Set the layout for the widget.

    Notes

    The layout is single-use only. It cannot be changed after the first assignment.

    The layout is disposed automatically when the widget is disposed.

    Parameters

    • value: Layout

    Returns void

  • get model(): Completer.IModel
  • The model used by the completer widget.

    Returns Completer.IModel

  • set model(model): void
  • Parameters

    Returns void

  • get parent(): Widget
  • Get the parent of the widget.

    Returns Widget

  • set parent(value): void
  • Set the parent of the widget.

    Notes

    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.

    Parameters

    Returns void

  • get selected(): ISignal<this, string>
  • A signal emitted when a selection is made from the completer menu.

    Returns ISignal<this, string>

  • get showDocsPanel(): boolean
  • Returns boolean

  • set showDocsPanel(showDoc): void
  • Enable/disable the document panel.

    Parameters

    • showDoc: boolean

    Returns void

  • get sizeCache(): IDimensions
  • Get cached dimensions of the completer box.

    Returns IDimensions

  • get title(): Title<Widget>
  • The title object for the widget.

    Notes

    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.

    Returns Title<Widget>

  • get visibilityChanged(): ISignal<this, void>
  • A signal emitted when the completer widget's visibility changes.

    Notes

    This signal is useful when there are multiple floating widgets that may contend with the same space and ought to be mutually exclusive.

    Returns ISignal<this, void>

Methods

  • Cache style constraints from CSS.

    Returns void

  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Create an iterator over the widget's children.

    Returns IterableIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    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.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

  • Dispose of the resources held by the completer widget.

    Returns void

  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

  • Handle the DOM events for the widget.

    Parameters

    • event: Event

      The DOM event sent to the widget.

      Notes

      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.

    Returns void

  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • Handle after-attach messages for the widget.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-detach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-attach' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • Handle before-detach messages for the widget.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ChildMessage

    Returns void

  • A message handler invoked on a 'close-request' message.

    Notes

    The default implementation unparents or detaches the widget.

    Parameters

    • msg: Message

    Returns void

  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

  • Handle model query changes.

    Parameters

    Returns void

  • Handle model state changes.

    Returns void

  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: ResizeMessage

    Returns void

  • Handle update-request messages.

    Parameters

    • msg: Message

    Returns void

  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

  • Reset the widget.

    Returns void

  • Emit the selected signal for the current active item and reset.

    Returns void

  • Set the given widget flag.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns void

  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    • flag: Flag

    Returns boolean

  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: boolean

      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.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

Generated using TypeDoc