com.vaadin.client.ui

Class VFilterSelect.FilterSelectSuggestion

java.lang.Object

com.vaadin.client.ui.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

Constructors

Constructor and Description
FilterSelectSuggestion(UIDL uidl) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
String	getOptionKey() Get the option key which represents the item on the server side.
String	getReplacementString() Get a string that represents this item.
String	getStyle() Gets the style set for this suggestion item.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterSelectSuggestion

public 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 String 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:

getStyle

public String getStyle()

Gets the style set for this suggestion item. Styles are typically set by a server-side ComboBox.ItemStyleGenerator. The returned style is prefixed by v-filterselect-item-.

Returns:

the style name to use, or null to not apply any custom style.

Since:

7.5.6

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object