com.jidesoft.hints
Class ListDataIntelliHints

java.lang.Object
  com.jidesoft.hints.AbstractIntelliHints
      com.jidesoft.hints.AbstractListIntelliHints
          com.jidesoft.hints.ListDataIntelliHints

All Implemented Interfaces:

IntelliHints

public class ListDataIntelliHints
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

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

ListDataIntelliHints(javax.swing.text.JTextComponent comp, java.lang.String[] completionList)

Method Summary

java.util.List<?>	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<?> completionList) Sets a new list of hints.
void	setCompletionList(java.lang.String[] 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, createPopup, getCaretPositionForPopup, getCaretRectangleForPopup, getContext, getIntelliHints, getShowHintsKeyStroke, getTextComponent, hideHintsPopup, isAutoPopup, isFollowCaret, isHintsPopupVisible, isMultilineTextComponent, setAutoPopup, setFollowCaret, setHintsEnabled, showHints, showHintsPopup

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<?> completionList)

ListDataIntelliHints

public ListDataIntelliHints(javax.swing.text.JTextComponent comp,
                            java.lang.String[] completionList)

Method Detail

getCompletionList

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

Gets the list of hints.

Returns:

the list of hints.

setCompletionList

public void setCompletionList(java.util.List<?> completionList)

Sets a new list of hints.

Parameters:

completionList -

setCompletionList

public void setCompletionList(java.lang.String[] completionList)

Sets a new list of hints.

Parameters:

completionList -

updateHints

public boolean updateHints(java.lang.Object context)

Description copied from interface: IntelliHints

Update hints depending on the context.

Parameters:

context - the current context

Returns:

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

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 -