Skip to content

LabelledEntries

Christian Lück edited this page Jul 25, 2022 · 2 revisions

Labelled Entries

In oXbytei a labelled entry is a suggestion for content completion. The name originates from the need not only to provide a raw value, but also a label (or description) for that value that is presented in a user dialog.

Labelled entries are generated from plugins. See plugins for a list of such plugins.

Technical details

As defined by the interface, plugins have a initialization/setup phase and a query phase.

The initialization phase is handled by the plugin loader. Configuration arguments are passed to the plugin. In the setup phase, the editing context is passed into the plugin.

In the query phase, a String provided by the user may be used to build a query, with runtime parameters. This enables plugins that are clients of RESTful APIs. The query phase is handled by the user dialogue. And since user dialogues are configurable for each editing context, more complicated interactions between view and plugins can be realized.

Clone this wiki locally