org.omegat.gui.editor.autocompleter

Class AutoCompleterListView

java.lang.Object

org.omegat.gui.editor.autocompleter.AbstractAutoCompleterView

org.omegat.gui.editor.autocompleter.AutoCompleterListView

Direct Known Subclasses:

AutotextAutoCompleterView, GlossaryAutoCompleterView, HistoryCompleter, HistoryPredictor, TagAutoCompleterView

public abstract class AutoCompleterListView
extends AbstractAutoCompleterView

A list based auto-completer view.

Field Summary

Fields inherited from class org.omegat.gui.editor.autocompleter.AbstractAutoCompleterView

completer

Constructor Summary

Constructors

Constructor and Description
AutoCompleterListView(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<AutoCompleterItem>	computeListData(java.lang.String prevText, boolean contextualOnly) Compute the items visible in the auto-completer list
protected java.lang.String	getLastToken(java.lang.String text)
javax.swing.JList<AutoCompleterItem>	getList()
int	getPreferredHeight() get the preferred height of the component
int	getPreferredWidth() get the preferred width of the component
int	getRowCount() return the size of the data list / array.
AutoCompleterItem	getSelectedValue() get the selected value
java.awt.Component	getViewContent() Obtain the content to put in the autocompleter popup.
abstract java.lang.String	itemToString(AutoCompleterItem item) Each view should determine how to print a view item.
boolean	processKeys(java.awt.event.KeyEvent e) Process the autocompletion keys
protected void	selectNextPossibleValue() Selects the next item in the list.
protected void	selectNextPossibleValueByPage() Selects the item in the list following the current one by one page, or the last item if there is less than one page following.
protected void	selectPreviousPossibleValue() Selects the previous item in the list.
protected void	selectPreviousPossibleValueByPage() Selects the item in the list preceding the current one by one page, or the first item if there is less than one page preceding.
protected void	setData(AutoCompleterItem... entries)
boolean	shouldPopUp() Return true to indicate that the view has relevant contextual suggestions that merit displaying the AutoCompleter popup unprompted.
void	updateViewData() Update the view data

Methods inherited from class org.omegat.gui.editor.autocompleter.AbstractAutoCompleterView

getLeadingText, getModifiedRowCount, getName, getTargetLanguage, getTokenizer, isEnabled, setParent, shouldCloseOnSelection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoCompleterListView

public AutoCompleterListView(java.lang.String name)

Method Detail

getList

public javax.swing.JList<AutoCompleterItem> getList()

processKeys

public boolean processKeys(java.awt.event.KeyEvent e)

Description copied from class: AbstractAutoCompleterView

Process the autocompletion keys

Specified by:

processKeys in class AbstractAutoCompleterView

Parameters:

e - the key event to process

Returns:

true if a key has been processed, false if otherwise.

selectNextPossibleValue

protected void selectNextPossibleValue()

Selects the next item in the list.

selectNextPossibleValueByPage

protected void selectNextPossibleValueByPage()

Selects the item in the list following the current one by one page, or the last item if there is less than one page following.

selectPreviousPossibleValue

protected void selectPreviousPossibleValue()

Selects the previous item in the list.

selectPreviousPossibleValueByPage

protected void selectPreviousPossibleValueByPage()

Selects the item in the list preceding the current one by one page, or the first item if there is less than one page preceding.

getRowCount

public int getRowCount()

Description copied from class: AbstractAutoCompleterView

return the size of the data list / array.

Specified by:

getRowCount in class AbstractAutoCompleterView

Returns:

getPreferredHeight

public int getPreferredHeight()

Description copied from class: AbstractAutoCompleterView

get the preferred height of the component

Specified by:

getPreferredHeight in class AbstractAutoCompleterView

Returns:

getPreferredWidth

public int getPreferredWidth()

Description copied from class: AbstractAutoCompleterView

get the preferred width of the component

Specified by:

getPreferredWidth in class AbstractAutoCompleterView

Returns:

setData

protected void setData(AutoCompleterItem... entries)

getSelectedValue

public AutoCompleterItem getSelectedValue()

Description copied from class: AbstractAutoCompleterView

get the selected value

Specified by:

getSelectedValue in class AbstractAutoCompleterView

Returns:

getViewContent

public java.awt.Component getViewContent()

Description copied from class: AbstractAutoCompleterView

Obtain the content to put in the autocompleter popup. The view should also do any other preparation necessary for display.

Specified by:

getViewContent in class AbstractAutoCompleterView

Returns:

the component to show in the autocompleter popup

updateViewData

public void updateViewData()

Description copied from class: AbstractAutoCompleterView

Update the view data

Specified by:

updateViewData in class AbstractAutoCompleterView

shouldPopUp

public boolean shouldPopUp()

Description copied from class: AbstractAutoCompleterView

Return true to indicate that the view has relevant contextual suggestions that merit displaying the AutoCompleter popup unprompted.

Specified by:

shouldPopUp in class AbstractAutoCompleterView

Returns:

Whether or not the AutoCompleter should appear

getLastToken

protected java.lang.String getLastToken(java.lang.String text)

computeListData

public abstract java.util.List<AutoCompleterItem> computeListData(java.lang.String prevText,
                                                                  boolean contextualOnly)

Compute the items visible in the auto-completer list

Parameters:

prevText - the text in the editing field up to the cursor location

Returns:

a list of AutoCompleterItems.

itemToString

public abstract java.lang.String itemToString(AutoCompleterItem item)

Each view should determine how to print a view item.

Parameters:

item - The item to print

Returns:

A string representation of the view item