com.vaadin.terminal.gwt.client.ui.combobox
Class VFilterSelect.FilterSelectSuggestion

java.lang.Object
  com.vaadin.terminal.gwt.client.ui.combobox.VFilterSelect.FilterSelectSuggestion

All Implemented Interfaces:

com.google.gwt.core.client.Scheduler.ScheduledCommand, com.google.gwt.user.client.Command, com.google.gwt.user.client.ui.SuggestOracle.Suggestion

Enclosing class:

VFilterSelect

public class VFilterSelect.FilterSelectSuggestion
extends Object
implements com.google.gwt.user.client.ui.SuggestOracle.Suggestion, com.google.gwt.user.client.Command

Represents a suggestion in the suggestion popup box

Constructor Summary

VFilterSelect.FilterSelectSuggestion(UIDL uidl)
Constructor

Method Summary

void	execute() Executes a selection of this item.
String	getDisplayString() Gets the visible row in the popup as a HTML string.
String	getIconUri() Get the URI of the icon.
int	getOptionKey() Get the option key which represents the item on the server side.
String	getReplacementString() Get a string that represents this item.

Methods inherited from class java.lang.Object

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

Constructor Detail

VFilterSelect.FilterSelectSuggestion

public VFilterSelect.FilterSelectSuggestion(UIDL uidl)

Constructor

Parameters:

uidl - The UIDL recieved from the server

Method Detail

getDisplayString

public String getDisplayString()

Gets the visible row in the popup as a HTML string. The string contains an image tag with the rows icon (if an icon has been specified) and the caption of the item

Specified by:

getDisplayString in interface com.google.gwt.user.client.ui.SuggestOracle.Suggestion

getReplacementString

public String getReplacementString()

Get a string that represents this item. This is used in the text box.

Specified by:

getReplacementString in interface com.google.gwt.user.client.ui.SuggestOracle.Suggestion

getOptionKey

public int getOptionKey()

Get the option key which represents the item on the server side.

Returns:

The key of the item

getIconUri

public String getIconUri()

Get the URI of the icon. Used when constructing the displayed option.

Returns:

execute

public void execute()

Executes a selection of this item.

Specified by:

execute in interface com.google.gwt.core.client.Scheduler.ScheduledCommand

Specified by:

execute in interface com.google.gwt.user.client.Command