|
||||||||||
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.IconImageSequence, Window.Skin |
Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container |
---|
Container.EDT_Checker |
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 resultArgument)
|
int |
getListSize()
Returns the list size. |
boolean |
getResult()
|
int |
getSelectedIndex()
Returns the current selection. |
Object |
getSelectedSuggestion()
|
List<?> |
getSuggestionData()
Returns the list of suggestions presented by the popup. |
SuggestionPopupCloseListener |
getSuggestionPopupCloseListener()
|
ListenerList<SuggestionPopupItemListener> |
getSuggestionPopupItemListeners()
|
ListenerList<SuggestionPopupListener> |
getSuggestionPopupListeners()
|
ListenerList<SuggestionPopupSelectionListener> |
getSuggestionPopupSelectionListeners()
|
ListenerList<SuggestionPopupStateListener> |
getSuggestionPopupStateListeners()
|
ListView.ItemRenderer |
getSuggestionRenderer()
Returns the list view item renderer used to present suggestions. |
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 textInputArgument)
Opens the suggestion popup window. |
void |
open(TextInput textInputArgument,
SuggestionPopupCloseListener suggestionPopupCloseListenerArgument)
Opens the suggestion popup window. |
void |
setListSize(int listSize)
Sets the list size. |
void |
setSelectedIndex(int selectedIndex)
Sets the selection. |
void |
setSelectedSuggestion(Object suggestion)
|
void |
setSuggestionData(List<?> suggestionData)
Sets the list of suggestions presented by the popup. |
void |
setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer)
Sets the list view item renderer used to present suggestions. |
Methods inherited from class org.apache.pivot.wtk.Window |
---|
align, align, clearActive, clearFocusDescendant, descendantGainedFocus, descendantRemoved, getActionMappings, getActiveWindow, getClientArea, getContent, getFocusDescendant, getIcons, getOwnedWindow, getOwnedWindowCount, getOwner, getRootOwner, getTitle, getWindowActionMappingListeners, getWindowClassListeners, getWindowListeners, getWindowStateListeners, isActive, isBottomMost, isClosed, isMaximized, isOpen, isOpening, isOwner, isTopMost, keyPressed, moveToBack, moveToFront, open, open, remove, requestActive, setActive, setContent, setEnabled, setIcon, setIcon, setMaximized, setParent, setTitle, setVisible |
Methods inherited from class org.apache.pivot.wtk.Container |
---|
add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantLostFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getGraphics, getLength, getNamedComponent, indexOf, insert, invalidate, isAncestor, isDoubleBuffered, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, repaint, requestFocus, setDoubleBuffered, setEventDispatchThreadChecker, 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<?> getSuggestionData()
public void setSuggestionData(List<?> suggestionData)
suggestionData
- 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 void setSelectedSuggestion(Object suggestion)
public int getListSize()
public void setListSize(int listSize)
listSize
- public final void open(Display display, Window owner)
Window
Note that this method is not a synchronous call, it schedules an event to open the 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 textInputArgument)
textInputArgument
- The text input for which suggestions will be provided.public void open(TextInput textInputArgument, SuggestionPopupCloseListener suggestionPopupCloseListenerArgument)
textInputArgument
- The text input for which suggestions will be provided.suggestionPopupCloseListenerArgument
- 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 resultArgument)
public SuggestionPopupCloseListener getSuggestionPopupCloseListener()
public boolean getResult()
public ListenerList<SuggestionPopupListener> getSuggestionPopupListeners()
public ListenerList<SuggestionPopupItemListener> getSuggestionPopupItemListeners()
public ListenerList<SuggestionPopupSelectionListener> getSuggestionPopupSelectionListeners()
public ListenerList<SuggestionPopupStateListener> getSuggestionPopupStateListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |