VFilterSelect (vaadin-client 7.7.4 API)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.google.gwt.user.client.ui.Composite
    - - com.vaadin.client.ui.VFilterSelect

All Implemented Interfaces:

com.google.gwt.event.dom.client.BlurHandler, com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, DeferredWorker, Focusable, HandlesAriaCaption, HandlesAriaInvalid, HandlesAriaRequired, Field, SubPartAware
```
public class VFilterSelect
extends com.google.gwt.user.client.ui.Composite
implements Field, com.google.gwt.event.dom.client.KeyDownHandler, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.BlurHandler, Focusable, SubPartAware, HandlesAriaCaption, HandlesAriaInvalid, HandlesAriaRequired, DeferredWorker
```
Client side implementation of the Select component. TODO needs major refactoring (to be extensible etc)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`VFilterSelect.FilterSelectSuggestion` Represents a suggestion in the suggestion popup box
`class`	`VFilterSelect.FilterSelectTextBox` TextBox variant used as input element for filter selects, which prevents selecting text when disabled.
`static class`	`VFilterSelect.Select` For internal use only.
`class`	`VFilterSelect.SuggestionMenu` The menu where the suggestions are rendered
`class`	`VFilterSelect.SuggestionPopup` Represents the popup box with the selection options.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allowNewItem` For internal use only.
`static String`	`CLASSNAME`
`ApplicationConnection`	`client` For internal use only.
`int`	`currentPage` For internal use only.
`VFilterSelect.FilterSelectSuggestion`	`currentSuggestion` The current suggestion selected from the dropdown.
`List<VFilterSelect.FilterSelectSuggestion>`	`currentSuggestions` A collection of available suggestions (options) as received from the server.
`boolean`	`enabled` For internal use only.
`FilteringMode`	`filteringmode` For internal use only.
`static FilteringMode`	`FILTERINGMODE_CONTAINS` Deprecated.
`static FilteringMode`	`FILTERINGMODE_OFF` Deprecated.
`static FilteringMode`	`FILTERINGMODE_STARTSWITH` Deprecated.
`boolean`	`focused` For internal use only.
`boolean`	`immediate` For internal use only.
`boolean`	`initDone` For internal use only.
`String`	`inputPrompt` For internal use only.
`String`	`lastFilter` For internal use only.
`String`	`lastNewItemString` Stores the last new item string to avoid double submissions.
`boolean`	`nullSelectionAllowed` For internal use only.
`boolean`	`nullSelectItem` For internal use only.
`int`	`pageLength` For internal use only.
`String`	`paintableId` For internal use only.
`boolean`	`popupOpenerClicked` Set true when popupopened has been clicked.
`boolean`	`prompting` For internal use only.
`boolean`	`readonly` For internal use only.
`String`	`selectedOptionKey` For internal use only.
`VFilterSelect.Select`	`selectPopupItemWhenResponseIsReceived` For internal use only.
`VFilterSelect.SuggestionPopup`	`suggestionPopup` For internal use only.
`int`	`suggestionPopupMinWidth` For internal use only.
`String`	`suggestionPopupWidth`
`com.google.gwt.user.client.ui.TextBox`	`tb` The text box where the filter is written
`int`	`totalMatches` For internal use only.
`boolean`	`updateSelectionWhenReponseIsReceived` For internal use only.
`boolean`	`waitingForFilteringResponse` For internal use only.

Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

VFilterSelect()
Default constructor.

Constructors
Constructor and Description
`VFilterSelect()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindAriaCaption(com.google.gwt.user.client.Element captionElement)` Called to bind the provided caption (label in HTML speak) element to the main input element of the Widget.
`protected VFilterSelect.SuggestionPopup`	`createSuggestionPopup()` This method will create the SuggestionPopup used by the VFilterSelect instance.
`protected com.google.gwt.user.client.ui.TextBox`	`createTextBox()` This method will create the TextBox used by the VFilterSelect instance.
`void`	`filterOptions(int page)` Filters the options at a certain page.
`void`	`filterOptions(int page, String filter)` Filters the options at certain page using the given filter
`void`	`focus()` Sets focus to this widget.
`String`	`getSelectedCaption()` This method is meant for internal use and may change in future versions.
`com.google.gwt.user.client.Element`	`getSubPartElement(String subPart)` Locates an element inside a component using the identifier provided in `subPart`.
`String`	`getSubPartName(com.google.gwt.user.client.Element subElement)` Provides an identifier that identifies the element within the component.
`boolean`	`hasNextPage()` Does the Select have more pages?
`boolean`	`isWorkPending()` Checks whether there are operations pending for this widget or connector that must be executed before reaching a steady state.
`int`	`minWidth(String captions)` Calculate minimum width for FilterSelect textarea.
`void`	`onBlur(com.google.gwt.event.dom.client.BlurEvent event)`
`void`	`onBrowserEvent(com.google.gwt.user.client.Event event)`
`void`	`onClick(com.google.gwt.event.dom.client.ClickEvent event)` Listener for popupopener
`protected void`	`onDetach()`
`void`	`onFocus(com.google.gwt.event.dom.client.FocusEvent event)`
`void`	`onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)`
`void`	`onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)` Triggered when a key was depressed
`void`	`onSuggestionSelected(VFilterSelect.FilterSelectSuggestion suggestion)` Triggered when a suggestion is selected
`void`	`setAriaInvalid(boolean invalid)` Called to set the element, typically an input element, as invalid.
`void`	`setAriaRequired(boolean required)` Called to set the element, typically an input element, as required.
`void`	`setPromptingOff(String text)` Turns prompting off.
`void`	`setPromptingOn()` Turns prompting on.
`void`	`setSelectedCaption(String selectedCaption)` Sets the caption of selected item, if "scroll to page" is disabled.
`void`	`setSelectedItemIcon(String iconUri)` Sets the icon URI of the selected item.
`void`	`setStyleName(String style)`
`void`	`setStylePrimaryName(String style)`
`void`	`setTextboxText(String text)` Sets the text in the text box.
`void`	`setTextInputEnabled(boolean textInputEnabled)`
`void`	`setWidth(String width)`
`void`	`updateReadOnly()` For internal use only.
`void`	`updateRootWidth()` Calculates the width of the select if the select has undefined width.
`protected void`	`updateStyleNames()`
`void`	`updateSuggestionPopupMinWidth()` Update minimum width for FilterSelect textarea based on input prompt and suggestions.

Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILTERINGMODE_OFF
```
@Deprecated
public static final FilteringMode FILTERINGMODE_OFF
```
    Deprecated.
  - FILTERINGMODE_STARTSWITH
```
@Deprecated
public static final FilteringMode FILTERINGMODE_STARTSWITH
```
    Deprecated.
  - FILTERINGMODE_CONTAINS
```
@Deprecated
public static final FilteringMode FILTERINGMODE_CONTAINS
```
    Deprecated.
  - CLASSNAME
```
public static final String CLASSNAME
```
    See Also:
    
    Constant Field Values
  - pageLength
```
public int pageLength
```
    For internal use only. May be removed or replaced in the future.
  - tb
```
public final com.google.gwt.user.client.ui.TextBox tb
```
    The text box where the filter is written
    For internal use only. May be removed or replaced in the future.
  - suggestionPopup
```
public final VFilterSelect.SuggestionPopup suggestionPopup
```
    For internal use only. May be removed or replaced in the future.
  - client
```
public ApplicationConnection client
```
    For internal use only. May be removed or replaced in the future.
  - paintableId
```
public String paintableId
```
    For internal use only. May be removed or replaced in the future.
  - currentPage
```
public int currentPage
```
    For internal use only. May be removed or replaced in the future.
  - currentSuggestions
```
public final List<VFilterSelect.FilterSelectSuggestion> currentSuggestions
```
    A collection of available suggestions (options) as received from the server.
    For internal use only. May be removed or replaced in the future.
  - immediate
```
public boolean immediate
```
    For internal use only. May be removed or replaced in the future.
  - selectedOptionKey
```
public String selectedOptionKey
```
    For internal use only. May be removed or replaced in the future.
  - waitingForFilteringResponse
```
public boolean waitingForFilteringResponse
```
    For internal use only. May be removed or replaced in the future.
  - updateSelectionWhenReponseIsReceived
```
public boolean updateSelectionWhenReponseIsReceived
```
    For internal use only. May be removed or replaced in the future.
  - initDone
```
public boolean initDone
```
    For internal use only. May be removed or replaced in the future.
  - lastFilter
```
public String lastFilter
```
    For internal use only. May be removed or replaced in the future.
  - selectPopupItemWhenResponseIsReceived
```
public VFilterSelect.Select selectPopupItemWhenResponseIsReceived
```
    For internal use only. May be removed or replaced in the future.
  - currentSuggestion
```
public VFilterSelect.FilterSelectSuggestion currentSuggestion
```
    The current suggestion selected from the dropdown. This is one of the values in currentSuggestions except when filtering, in this case currentSuggestion might not be in currentSuggestions.
    For internal use only. May be removed or replaced in the future.
  - allowNewItem
```
public boolean allowNewItem
```
    For internal use only. May be removed or replaced in the future.
  - totalMatches
```
public int totalMatches
```
    For internal use only. May be removed or replaced in the future.
  - nullSelectionAllowed
```
public boolean nullSelectionAllowed
```
    For internal use only. May be removed or replaced in the future.
  - nullSelectItem
```
public boolean nullSelectItem
```
    For internal use only. May be removed or replaced in the future.
  - enabled
```
public boolean enabled
```
    For internal use only. May be removed or replaced in the future.
  - readonly
```
public boolean readonly
```
    For internal use only. May be removed or replaced in the future.
  - filteringmode
```
public FilteringMode filteringmode
```
    For internal use only. May be removed or replaced in the future.
  - inputPrompt
```
public String inputPrompt
```
    For internal use only. May be removed or replaced in the future.
  - prompting
```
public boolean prompting
```
    For internal use only. May be removed or replaced in the future.
  - popupOpenerClicked
```
public boolean popupOpenerClicked
```
    Set true when popupopened has been clicked. Cleared on each UIDL-update. This handles the special case where are not filtering yet and the selected value has changed on the server-side. See #2119
    For internal use only. May be removed or replaced in the future.
  - suggestionPopupMinWidth
```
public int suggestionPopupMinWidth
```
    For internal use only. May be removed or replaced in the future.
  - suggestionPopupWidth
```
public String suggestionPopupWidth
```
  - lastNewItemString
```
public String lastNewItemString
```
    Stores the last new item string to avoid double submissions. Cleared on uidl updates.
    For internal use only. May be removed or replaced in the future.
  - focused
```
public boolean focused
```
    For internal use only. May be removed or replaced in the future.
- Constructor Detail
  - VFilterSelect
```
public VFilterSelect()
```
    Default constructor.
- Method Detail
  - onBrowserEvent
```
public void onBrowserEvent(com.google.gwt.user.client.Event event)
```
    Specified by:
    
    onBrowserEvent in interface com.google.gwt.user.client.EventListener
    
    Overrides:
    
    onBrowserEvent in class com.google.gwt.user.client.ui.Composite
  - createTextBox
```
protected com.google.gwt.user.client.ui.TextBox createTextBox()
```
    This method will create the TextBox used by the VFilterSelect instance. It is invoked during the Constructor and should only be overridden if a custom TextBox shall be used. The overriding method cannot use any instance variables.
    
    Returns:
    
    TextBox instance used by this VFilterSelect
    
    Since:
    
    7.1.5
  - createSuggestionPopup
```
protected VFilterSelect.SuggestionPopup createSuggestionPopup()
```
    This method will create the SuggestionPopup used by the VFilterSelect instance. It is invoked during the Constructor and should only be overridden if a custom SuggestionPopup shall be used. The overriding method cannot use any instance variables.
    
    Returns:
    
    SuggestionPopup instance used by this VFilterSelect
    
    Since:
    
    7.1.5
  - setStyleName
```
public void setStyleName(String style)
```
    Overrides:
    
    setStyleName in class com.google.gwt.user.client.ui.UIObject
  - setStylePrimaryName
```
public void setStylePrimaryName(String style)
```
    Overrides:
    
    setStylePrimaryName in class com.google.gwt.user.client.ui.UIObject
  - updateStyleNames
```
protected void updateStyleNames()
```
  - hasNextPage
```
public boolean hasNextPage()
```
    Does the Select have more pages?
    
    Returns:
    
    true if a next page exists, else false if the current page is the last page
  - filterOptions
```
public void filterOptions(int page)
```
    Filters the options at a certain page. Uses the text box input as a filter
    
    Parameters:
    
    page - The page which items are to be filtered
  - filterOptions
```
public void filterOptions(int page,
                          String filter)
```
    Filters the options at certain page using the given filter
    
    Parameters:
    
    page - The page to filter
    
    filter - The filter to apply to the components
  - updateReadOnly
```
public void updateReadOnly()
```
    For internal use only. May be removed or replaced in the future.
  - setTextInputEnabled
```
public void setTextInputEnabled(boolean textInputEnabled)
```
  - setTextboxText
```
public void setTextboxText(String text)
```
    Sets the text in the text box.
    
    Parameters:
    
    text - the text to set in the text box
  - setPromptingOn
```
public void setPromptingOn()
```
    Turns prompting on. When prompting is turned on a command prompt is shown in the text box if nothing has been entered.
  - setPromptingOff
```
public void setPromptingOff(String text)
```
    Turns prompting off. When prompting is turned on a command prompt is shown in the text box if nothing has been entered.
    For internal use only. May be removed or replaced in the future.
    
    Parameters:
    
    text - The text the text box should contain.
  - onSuggestionSelected
```
public void onSuggestionSelected(VFilterSelect.FilterSelectSuggestion suggestion)
```
    Triggered when a suggestion is selected
    
    Parameters:
    
    suggestion - The suggestion that just got selected.
  - setSelectedItemIcon
```
public void setSelectedItemIcon(String iconUri)
```
    Sets the icon URI of the selected item. The icon is shown on the left side of the item caption text. Set the URI to null to remove the icon.
    
    Parameters:
    
    iconUri - The URI of the icon
  - onKeyDown
```
public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
```
    Specified by:
    
    onKeyDown in interface com.google.gwt.event.dom.client.KeyDownHandler
  - onKeyUp
```
public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)
```
    Triggered when a key was depressed
    
    Specified by:
    
    onKeyUp in interface com.google.gwt.event.dom.client.KeyUpHandler
    
    Parameters:
    
    event - The KeyUpEvent of the key depressed
  - onClick
```
public void onClick(com.google.gwt.event.dom.client.ClickEvent event)
```
    Listener for popupopener
    
    Specified by:
    
    onClick in interface com.google.gwt.event.dom.client.ClickHandler
  - updateSuggestionPopupMinWidth
```
public void updateSuggestionPopupMinWidth()
```
    Update minimum width for FilterSelect textarea based on input prompt and suggestions.
    For internal use only. May be removed or replaced in the future.
  - minWidth
```
public int minWidth(String captions)
```
    Calculate minimum width for FilterSelect textarea.
    For internal use only. May be removed or replaced in the future.
  - onFocus
```
public void onFocus(com.google.gwt.event.dom.client.FocusEvent event)
```
    Specified by:
    
    onFocus in interface com.google.gwt.event.dom.client.FocusHandler
  - onBlur
```
public void onBlur(com.google.gwt.event.dom.client.BlurEvent event)
```
    Specified by:
    
    onBlur in interface com.google.gwt.event.dom.client.BlurHandler
  - focus
```
public void focus()
```
    Description copied from interface: Focusable
    
    Sets focus to this widget.
    
    Specified by:
    
    focus in interface Focusable
  - updateRootWidth
```
public void updateRootWidth()
```
    Calculates the width of the select if the select has undefined width. Should be called when the width changes or when the icon changes.
    For internal use only. May be removed or replaced in the future.
  - setWidth
```
public void setWidth(String width)
```
    Overrides:
    
    setWidth in class com.google.gwt.user.client.ui.UIObject
  - onDetach
```
protected void onDetach()
```
    Overrides:
    
    onDetach in class com.google.gwt.user.client.ui.Composite
  - getSubPartElement
```
public com.google.gwt.user.client.Element getSubPartElement(String subPart)
```
    Description copied from interface: SubPartAware
    
    Locates an element inside a component using the identifier provided in subPart. The subPart identifier is component specific and may be any string of characters, numbers, space characters and brackets.
    
    Specified by:
    
    getSubPartElement in interface SubPartAware
    
    Parameters:
    
    subPart - The identifier for the element inside the component
    
    Returns:
    
    The element identified by subPart or null if the element could not be found.
  - getSubPartName
```
public String getSubPartName(com.google.gwt.user.client.Element subElement)
```
    Description copied from interface: SubPartAware
    
    Provides an identifier that identifies the element within the component. The subElement is a part of the component and must never be null.
    Note! getSubPartElement(getSubPartName(element)) == element is not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions with subElement are the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed as subElement because interactions with the DIV and the root button element produce the same result.
    
    Specified by:
    
    getSubPartName in interface SubPartAware
    
    Parameters:
    
    subElement - The element the identifier string should uniquely identify
    
    Returns:
    
    An identifier that uniquely identifies subElement or null if no identifier could be provided.
  - setAriaRequired
```
public void setAriaRequired(boolean required)
```
    Description copied from interface: HandlesAriaRequired
    
    Called to set the element, typically an input element, as required.
    
    Specified by:
    
    setAriaRequired in interface HandlesAriaRequired
    
    Parameters:
    
    required - boolean true when the element needs to be set as required
  - setAriaInvalid
```
public void setAriaInvalid(boolean invalid)
```
    Description copied from interface: HandlesAriaInvalid
    
    Called to set the element, typically an input element, as invalid.
    
    Specified by:
    
    setAriaInvalid in interface HandlesAriaInvalid
    
    Parameters:
    
    invalid - boolean, true when the element should be marked invalid, false otherwise
  - bindAriaCaption
```
public void bindAriaCaption(com.google.gwt.user.client.Element captionElement)
```
    Description copied from interface: HandlesAriaCaption
    
    Called to bind the provided caption (label in HTML speak) element to the main input element of the Widget. Binding should be removed from the main input field when captionElement is null.
    
    Specified by:
    
    bindAriaCaption in interface HandlesAriaCaption
    
    Parameters:
    
    captionElement - Element of the caption
  - isWorkPending
```
public boolean isWorkPending()
```
    Description copied from interface: DeferredWorker
    
    Checks whether there are operations pending for this widget or connector that must be executed before reaching a steady state.
    
    Specified by:
    
    isWorkPending in interface DeferredWorker
  - setSelectedCaption
```
public void setSelectedCaption(String selectedCaption)
```
    Sets the caption of selected item, if "scroll to page" is disabled. This method is meant for internal use and may change in future versions.
    
    Parameters:
    
    selectedCaption - the caption of selected item
    
    Since:
    
    7.7
  - getSelectedCaption
```
public String getSelectedCaption()
```
    This method is meant for internal use and may change in future versions.
    
    Returns:
    
    the caption of selected item, if "scroll to page" is disabled
    
    Since:
    
    7.7

Class VFilterSelect

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.google.gwt.user.client.ui.Composite

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Field Detail

FILTERINGMODE_OFF

FILTERINGMODE_STARTSWITH

FILTERINGMODE_CONTAINS

CLASSNAME

pageLength

tb

suggestionPopup

client

paintableId

currentPage

currentSuggestions

immediate

selectedOptionKey

waitingForFilteringResponse

updateSelectionWhenReponseIsReceived

initDone

lastFilter

selectPopupItemWhenResponseIsReceived

currentSuggestion

allowNewItem

totalMatches

nullSelectionAllowed

nullSelectItem

enabled

readonly

filteringmode

inputPrompt

prompting

popupOpenerClicked

suggestionPopupMinWidth

suggestionPopupWidth

lastNewItemString

focused

Constructor Detail

VFilterSelect

Method Detail

onBrowserEvent

createTextBox

createSuggestionPopup

setStyleName

setStylePrimaryName

updateStyleNames

hasNextPage

filterOptions

filterOptions

updateReadOnly

setTextInputEnabled

setTextboxText

setPromptingOn

setPromptingOff

onSuggestionSelected

setSelectedItemIcon

onKeyDown

onKeyUp

onClick

updateSuggestionPopupMinWidth

minWidth

onFocus

onBlur

focus

updateRootWidth

setWidth

onDetach

getSubPartElement

getSubPartName

setAriaRequired

setAriaInvalid

bindAriaCaption