com.jidesoft.editor
Class ListDataCodeEditorIntelliHints<T>

java.lang.Object
  com.jidesoft.editor.AbstractCodeEditorIntelliHints
      com.jidesoft.editor.AbstractListCodeEditorIntelliHints
          com.jidesoft.editor.ListDataCodeEditorIntelliHints<T>

All Implemented Interfaces:

IntelliHints

public class ListDataCodeEditorIntelliHints<T>
extends AbstractListCodeEditorIntelliHints

ListDataCodeEditorIntelliHints is a concrete implementation of IntelliHints. It provides hints from a known list of data. It is similar to auto complete text field except the list will be filtered depending on what user types in so far.

Field Summary

Fields inherited from class com.jidesoft.editor.AbstractListCodeEditorIntelliHints

_keyStrokes

Fields inherited from interface com.jidesoft.hints.IntelliHints

CLIENT_PROPERTY_INTELLI_HINTS

Constructor Summary

ListDataCodeEditorIntelliHints(CodeEditor codeEditor, List<T> completionList)
Constructor.

ListDataCodeEditorIntelliHints(CodeEditor codeEditor, T[] completionList)
Constructor.

Method Summary

protected boolean	compare(Object context, T o) Compares the context with the object in the completion list.
List<T>	getCompletionList() Gets the list of hints.
boolean	isCaseSensitive() Checks if it used case sensitive search.
void	setCaseSensitive(boolean caseSensitive) Sets the case sensitive flag.
void	setCompletionList(List<T> completionList) Sets a new list of hints.
void	setCompletionList(T[] completionList) Sets a new list of hints.
boolean	updateHints(Object context) Update hints depending on the context.

Methods inherited from class com.jidesoft.editor.AbstractListCodeEditorIntelliHints

createHintsComponent, createList, getDelegateComponent, getDelegateKeyStrokes, getList, getMinimumPopupWidth, getSelectedHint, setListData, setListData, setMinimumPopupWidth

Methods inherited from class com.jidesoft.editor.AbstractCodeEditorIntelliHints

acceptHint, addShowHintsKeyStroke, createPopup, getAllShowHintsKeyStrokes, getCaretRectangleForPopup, getCodeEditor, getContext, getDelimiters, getIntelliHints, getShowHintsKeyStroke, hideHintsPopup, install, isAutoPopup, isHintsPopupVisible, removeShowHintsKeyStroke, setAutoPopup, setDelimiters, setHintsEnabled, showHintsPopup, uninstall

Methods inherited from class java.lang.Object

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

Constructor Detail

ListDataCodeEditorIntelliHints

public ListDataCodeEditorIntelliHints(CodeEditor codeEditor,
                                      List<T> completionList)

Constructor.

Parameters:

codeEditor - the CodeEditor

completionList - the list to be used

ListDataCodeEditorIntelliHints

public ListDataCodeEditorIntelliHints(CodeEditor codeEditor,
                                      T[] completionList)

Constructor.

Parameters:

codeEditor - the CodeEditor

completionList - the list to be used

Method Detail

getCompletionList

public List<T> getCompletionList()

Gets the list of hints.

Returns:

the list of hints.

setCompletionList

public void setCompletionList(List<T> completionList)

Sets a new list of hints.

Parameters:

completionList - a new list of hints.

setCompletionList

public void setCompletionList(T[] completionList)

Sets a new list of hints.

Parameters:

completionList - a new array of hints.

updateHints

public boolean updateHints(Object context)

Description copied from interface: IntelliHints

Update hints depending on the context. This method will be triggered for every key typed event in the text component. Subclass can override it to provide your own list of hints and call setListData to set it and returns true after that.

Parameters:

context - the current context

Returns:

true or false. If it is false, hint popup will not be shown.

compare

protected boolean compare(Object context,
                          T o)

Compares the context with the object in the completion list.

Parameters:

context - the context returned from AbstractCodeEditorIntelliHints.getContext() method.

o - the object in the completion list.

Returns:

true if the context matches with the object. Otherwise false.

isCaseSensitive

public boolean isCaseSensitive()

Checks if it used case sensitive search. By default it's false.

Returns:

if it's case sensitive.

See Also:

setCaseSensitive(boolean)

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets the case sensitive flag. By default, it's false meaning it's a case insensitive search.

Parameters:

caseSensitive - true or false.