com.jidesoft.hints

Class ListDataIntelliHints<T>

java.lang.Object

com.jidesoft.hints.AbstractIntelliHints

com.jidesoft.hints.AbstractListIntelliHints

com.jidesoft.hints.ListDataIntelliHints<T>

All Implemented Interfaces:

IntelliHints

public class ListDataIntelliHints<T>
extends AbstractListIntelliHints

ListDataIntelliHints 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.hints.AbstractListIntelliHints

_keyStrokes

Fields inherited from interface com.jidesoft.hints.IntelliHints

CLIENT_PROPERTY_INTELLI_HINTS

Constructor Summary

Constructors

Constructor and Description
ListDataIntelliHints(javax.swing.text.JTextComponent comp, java.util.List<T> completionList)
ListDataIntelliHints(javax.swing.text.JTextComponent comp, T[] completionList)

Method Summary

Modifier and Type	Method and Description
protected boolean	compare(java.lang.Object context, T o) Compares the context with the object in the completion list.
java.util.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(java.util.List<T> completionList) Sets a new list of hints.
void	setCompletionList(T[] completionList) Sets a new list of hints.
boolean	updateHints(java.lang.Object context) Update hints depending on the context.

Methods inherited from class com.jidesoft.hints.AbstractListIntelliHints

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

Methods inherited from class com.jidesoft.hints.AbstractIntelliHints

acceptHint, addShowHintsKeyStroke, createPopup, getAllShowHintsKeyStrokes, getCaretPositionForPopup, getCaretRectangleForPopup, getContext, getIntelliHints, getShowHintsDelay, getShowHintsKeyStroke, getTextComponent, hideHintsPopup, isAutoPopup, isFollowCaret, isHintsPopupVisible, isMultilineTextComponent, removeShowHintsKeyStroke, setAutoPopup, setFollowCaret, setHintsEnabled, setShowHintsDelay, showHints, showHintsPopup, updateHints

Methods inherited from class java.lang.Object

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

Constructor Detail

ListDataIntelliHints

public ListDataIntelliHints(javax.swing.text.JTextComponent comp,
                            java.util.List<T> completionList)

ListDataIntelliHints

public ListDataIntelliHints(javax.swing.text.JTextComponent comp,
                            T[] completionList)

Method Detail

getCompletionList

public java.util.List<T> getCompletionList()

Gets the list of hints.

Returns:

the list of hints.

setCompletionList

public void setCompletionList(java.util.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(java.lang.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.

Specified by:

updateHints in interface IntelliHints

Overrides:

updateHints in class AbstractIntelliHints

Parameters:

context - the current context

Returns:

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

compare

protected boolean compare(java.lang.Object context,
                          T o)

Compares the context with the object in the completion list.

Parameters:

context - the context returned from AbstractIntelliHints.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.

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.