org.apache.pivot.wtk
Class SuggestionPopup

java.lang.Object
  extended by org.apache.pivot.wtk.Component
      extended by org.apache.pivot.wtk.Container
          extended by org.apache.pivot.wtk.Window
              extended by org.apache.pivot.wtk.SuggestionPopup
All Implemented Interfaces:
Iterable<Component>, Sequence<Component>, ConstrainedVisual, Visual

public class SuggestionPopup
extends Window

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 org.apache.pivot.wtk.Component
clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTooltipWrapText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setSkin, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setTooltipWrapText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SuggestionPopup

public SuggestionPopup()

SuggestionPopup

public SuggestionPopup(List<?> suggestions)
Method Detail

getTextInput

public TextInput getTextInput()
Returns the text input for which suggestions will be provided.


getSuggestionData

public List<?> getSuggestionData()
Returns the list of suggestions presented by the popup.


setSuggestionData

public void setSuggestionData(List<?> suggestionData)
Sets the list of suggestions presented by the popup.

Parameters:
suggestionData -

getSuggestionRenderer

public ListView.ItemRenderer getSuggestionRenderer()
Returns the list view item renderer used to present suggestions.


setSuggestionRenderer

public void setSuggestionRenderer(ListView.ItemRenderer suggestionRenderer)
Sets the list view item renderer used to present suggestions.

Parameters:
suggestionRenderer -

getSelectedIndex

public int getSelectedIndex()
Returns the current selection.

Returns:
The index of the currently selected suggestion, or -1 if nothing is selected.

setSelectedIndex

public void setSelectedIndex(int selectedIndex)
Sets the selection.

Parameters:
selectedIndex - The index of the suggestion to select, or -1 to clear the selection.

getSelectedSuggestion

public Object getSelectedSuggestion()

setSelectedSuggestion

public void setSelectedSuggestion(Object suggestion)

getListSize

public int getListSize()
Returns the list size.


setListSize

public void setListSize(int listSize)
Sets the list size. If the number of items in the list exceeds this value, the list will scroll.

Parameters:
listSize -

open

public final void open(Display display,
                       Window owner)
Description copied from class: Window
Opens the window.

Note that this method is not a synchronous call, it schedules an event to open the window.

Overrides:
open in class Window
Parameters:
display - The display on which the window will be opened.
owner - The window's owner, or null if the window has no owner.

open

public final void open(TextInput textInputArgument)
Opens the suggestion popup window.

Parameters:
textInputArgument - The text input for which suggestions will be provided.

open

public void open(TextInput textInputArgument,
                 SuggestionPopupCloseListener suggestionPopupCloseListenerArgument)
Opens the suggestion popup window.

Parameters:
textInputArgument - The text input for which suggestions will be provided.
suggestionPopupCloseListenerArgument - A listener that will be called when the suggestion popup has closed.

isClosing

public boolean isClosing()
Description copied from class: Window
Returns this window's closing state.

Overrides:
isClosing in class Window
Returns:
true if the window is closing; false, otherwise.

close

public final void close()
Description copied from class: Window
Closes the window and all of its owned windows. If any owned window fails to close, this window will also fail to close.

Overrides:
close in class Window

close

public void close(boolean resultArgument)

getSuggestionPopupCloseListener

public SuggestionPopupCloseListener getSuggestionPopupCloseListener()

getResult

public boolean getResult()

getSuggestionPopupListeners

public ListenerList<SuggestionPopupListener> getSuggestionPopupListeners()

getSuggestionPopupItemListeners

public ListenerList<SuggestionPopupItemListener> getSuggestionPopupItemListeners()

getSuggestionPopupSelectionListeners

public ListenerList<SuggestionPopupSelectionListener> getSuggestionPopupSelectionListeners()

getSuggestionPopupStateListeners

public ListenerList<SuggestionPopupStateListener> getSuggestionPopupStateListeners()