|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pivot.wtk.Component
org.apache.pivot.wtk.Container
org.apache.pivot.wtk.Window
org.apache.pivot.wtk.SuggestionPopup
public class SuggestionPopup
Popup that presents a list of text suggestions to the user.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Window |
---|
Window.ActionMapping, Window.ActionMappingSequence, Window.Skin |
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component |
---|
Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary |
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence |
---|
Sequence.Tree<T> |
Constructor Summary | |
---|---|
SuggestionPopup()
|
|
SuggestionPopup(List<?> suggestions)
|
Method Summary | |
---|---|
void |
close()
Closes the window and all of its owned windows. |
void |
close(boolean result)
|
int |
getListSize()
|
boolean |
getResult()
|
int |
getSelectedIndex()
Returns the current selection. |
Object |
getSelectedSuggestion()
Returns the current selection. |
SuggestionPopupCloseListener |
getSuggestionPopupCloseListener()
|
ListenerList<SuggestionPopupListener> |
getSuggestionPopupListeners()
|
ListenerList<SuggestionPopupStateListener> |
getSuggestionPopupStateListeners()
|
ListView.ItemRenderer |
getSuggestionRenderer()
Returns the list view item renderer used to present suggestions. |
List<?> |
getSuggestions()
Returns the list of suggestions presented by the popup. |
TextInput |
getTextInput()
Returns the text input for which suggestions will be provided. |
boolean |
isClosing()
Returns this window's closing state. |
void |
open(Display display,
Window owner)
Opens the window. |
void |
open(TextInput textInput)
Opens the suggestion popup window. |
void |
open(TextInput textInput,
SuggestionPopupCloseListener suggestionPopupCloseListener)
Opens the suggestion popup window. |
void |
setListSize(int listSize)
|
void |
setSelectedIndex(int selectedIndex)
Sets the selection. |
void |
setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer)
Sets the list view item renderer used to present suggestions. |
void |
setSuggestions(List<?> suggestions)
Sets the list of suggestions presented by the popup. |
Methods inherited from class org.apache.pivot.wtk.Window |
---|
align, align, clearActive, clearFocusDescendant, descendantGainedFocus, descendantRemoved, getActionMappings, getActiveWindow, getClientArea, getContent, getFocusDescendant, getIcon, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowActionMappingListeners, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isClosed, isMaximized, isOpen, isOpening, isOwner, keyReleased, moveToBack, moveToFront, open, open, remove, requestActive, setActive, setContent, setEnabled, setIcon, setIcon, setIcon, setMaximized, setParent, setTitle, setVisible |
Methods inherited from class org.apache.pivot.wtk.Container |
---|
add, clear, containsFocus, descendantAdded, descendantLostFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, isAncestor, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setFocusTraversalPolicy, store, transferFocus, update |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SuggestionPopup()
public SuggestionPopup(List<?> suggestions)
Method Detail |
---|
public TextInput getTextInput()
public List<?> getSuggestions()
public void setSuggestions(List<?> suggestions)
suggestions
- public ListView.ItemRenderer getSuggestionRenderer()
public void setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer)
suggestionRenderer
- public int getSelectedIndex()
public void setSelectedIndex(int selectedIndex)
selectedIndex
- The index of the suggestion to select, or -1 to clear the
selection.public Object getSelectedSuggestion()
public int getListSize()
public void setListSize(int listSize)
public final void open(Display display, Window owner)
Window
open
in class Window
display
- The display on which the window will be opened.owner
- The window's owner, or null if the window has no owner.public final void open(TextInput textInput)
textInput
- The text input for which suggestions will be provided.public void open(TextInput textInput, SuggestionPopupCloseListener suggestionPopupCloseListener)
textInput
- The text input for which suggestions will be provided.suggestionPopupCloseListener
- A listener that will be called when the suggestion popup has closed.public boolean isClosing()
Window
isClosing
in class Window
public final void close()
Window
close
in class Window
public void close(boolean result)
public SuggestionPopupCloseListener getSuggestionPopupCloseListener()
public boolean getResult()
public ListenerList<SuggestionPopupListener> getSuggestionPopupListeners()
public ListenerList<SuggestionPopupStateListener> getSuggestionPopupStateListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |