CompletionView (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor.ext
Interface CompletionView

All Known Implementing Classes:: ListCompletionView

public interface CompletionView

Code copmletion view component interface. It best fits the JList but some users may require something else e.g. JTable for displaying the result of the completion query.

Method Summary

void begin()
          Go to the first item in the data item list.

void down()
          Go down to the next item in the data list.

void end()
          Go to the last item in the data item list.

int getSelectedIndex()
          Get the index of the currently selected item.

void pageDown()
          Go down one page in the data item list.

void pageUp()
          Go up one page in the data item list.

void setResult(CompletionQuery.Result result)
          Populate the view with the result from a query.

void up()
          Go up to the previous item in the data list.

Method Summary
`void`	`begin()` Go to the first item in the data item list.
`void`	`down()` Go down to the next item in the data list.
`void`	`end()` Go to the last item in the data item list.
`int`	`getSelectedIndex()` Get the index of the currently selected item.
`void`	`pageDown()` Go down one page in the data item list.
`void`	`pageUp()` Go up one page in the data item list.
`void`	`setResult(CompletionQuery.Result result)` Populate the view with the result from a query.
`void`	`up()` Go up to the previous item in the data list.

Method Detail

setResult

void setResult(CompletionQuery.Result result)

Populate the view with the result from a query.

Parameters:: result - completions query result or null if not computed yet.

getSelectedIndex

int getSelectedIndex()

Get the index of the currently selected item.

up

void up()

Go up to the previous item in the data list. The getSelectedIndex must reflect the change.

down

void down()

Go down to the next item in the data list. The getSelectedIndex must reflect the change.

pageUp

void pageUp()

Go up one page in the data item list. The getSelectedIndex must reflect the change.

pageDown

void pageDown()

Go down one page in the data item list. The getSelectedIndex must reflect the change.

begin

void begin()

Go to the first item in the data item list. The getSelectedIndex must reflect the change.

end

void end()

Go to the last item in the data item list. The getSelectedIndex must reflect the change.