org.apache.wicket.extensions.ajax.markup.html.autocomplete
Class AutoCompleteSettings

java.lang.Object
  org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteSettings

All Implemented Interfaces:

Serializable, org.apache.wicket.util.io.IClusterable

public final class AutoCompleteSettings
extends Object
implements org.apache.wicket.util.io.IClusterable

This class encapsulates various settings for AbstractAutoCompleteBehavior. See the documentation for the property accessors of this class for further information.

Default settings:

setting	default value
preselect	false
maxHeightInPx	-1
showListOnEmptyInput	false

Author:

Gerolf Seitz

See Also:

Serialized Form

Constructor Summary

AutoCompleteSettings()

Method Summary

String	getCssClassName() Get CSS class name to add to the autocompleter markup container
boolean	getIgnoreBordersWhenPositioning() Indicates whether the popup positioning will take into account the borders of the input element and its ancestors.
int	getMaxHeightInPx() Gets the maximum height of the autocomplete list in pixels.
int	getMinInputLength()
String	getParameterName()
boolean	getPreselect() Indicates whether the first item in the list is automatically selected when the autocomplete list is shown.
boolean	getShowCompleteListOnFocusGain() Indicates whether the autocomplete list will be shown when the input field receives focus.
boolean	getShowListOnEmptyInput() Indicates whether the autocomplete list will be shown if the input is empty.
boolean	getShowListOnFocusGain() Indicates whether the autocomplete list will be shown when the input field receives focus.
int	getThrottleDelay() get the throttle delay how long the browser will wait before sending a request to the browser after the user released a key.
boolean	getUseHideShowCoveredIEFix() Indicates whether in case of IE (and Opera), "select" "iframe" and "applet" tags should be hidden if covered by popup.
boolean	getUseSmartPositioning() Indicates whether the popup positioning will take into account browser window visible area or not.
boolean	isAdjustInputWidth() Tells if wicket should adjust the width of the autocompleter selection window to the width of the related input field.
AutoCompleteSettings	setAdjustInputWidth(boolean adjustInputWidth) Adjust the width of the autocompleter selection window to the width of the related input field.
AutoCompleteSettings	setCssClassName(String cssClassName) Sets an CSS class name to add to the autocompleter markup container This makes it easier to have multiple autocompleters in your application with different style and layout.
AutoCompleteSettings	setIgnoreBordersWhenPositioning(boolean ignoreBordersWhenPositioning) Sets whether the popup positioning will take into account the borders of the input element and its ancestors (by including the clientLeft and clientTop DOM properties in the computation).
AutoCompleteSettings	setMaxHeightInPx(int maxHeightInPx) Sets the maximum height in pixels of the autocomplete list.
AutoCompleteSettings	setMinInputLength(int minInputLength) Set the minimum input length required to display the autocomplete list
AutoCompleteSettings	setParameterName(String parameterName) Sets the name of the request parameter that will bring the value of the user input
AutoCompleteSettings	setPreselect(boolean preselect) Sets whether the first item in the autocomplete list should be selected when the autocomplete list is shown.
AutoCompleteSettings	setShowCompleteListOnFocusGain(boolean showCompleteListOnFocusGain) Sets whether the list should be shown when the input field receives focus.
AutoCompleteSettings	setShowListOnEmptyInput(boolean showListOnEmptyInput) Sets whether the list should be shown when the input is empty.
AutoCompleteSettings	setShowListOnFocusGain(boolean showListOnFocusGain) Sets whether the list should be shown when the input field receives focus.
AutoCompleteSettings	setThrottleDelay(int throttleDelay) set the throttle delay how long the browser will wait before sending a request to the browser after the user released a key.
AutoCompleteSettings	setUseHideShowCoveredIEFix(boolean useHideShowCoveredIEFix) Indicates whether in case of IE (and Opera), "select" "iframe" and "applet" tags should be hidden if covered by popup.
AutoCompleteSettings	setUseSmartPositioning(boolean useSmartPositioning) Sets whether the popup positioning will take into account browser window visible area or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCompleteSettings

public AutoCompleteSettings()

Method Detail

getPreselect

public boolean getPreselect()

Indicates whether the first item in the list is automatically selected when the autocomplete list is shown.

Returns:

true if the first item of the autocomplete list should be preselected, false (default) otherwise

setPreselect

public AutoCompleteSettings setPreselect(boolean preselect)

Sets whether the first item in the autocomplete list should be selected when the autocomplete list is shown.

Parameters:

preselect - the flag

Returns:

this AutoCompleteSettings

setThrottleDelay

public AutoCompleteSettings setThrottleDelay(int throttleDelay)

set the throttle delay how long the browser will wait before sending a request to the browser after the user released a key.

Parameters:

throttleDelay - The delay in milliseconds.

Returns:

this AutoCompleteSettings

getThrottleDelay

public int getThrottleDelay()

get the throttle delay how long the browser will wait before sending a request to the browser after the user released a key.

Returns:

the throttle delay in milliseconds (default 300)

getMaxHeightInPx

public int getMaxHeightInPx()

Gets the maximum height of the autocomplete list in pixels. -1 indicates that the autocomplete list should have no maximum height.

Returns:

the maximum height in pixels

setMaxHeightInPx

public AutoCompleteSettings setMaxHeightInPx(int maxHeightInPx)

Sets the maximum height in pixels of the autocomplete list.

The maximum height can also be specified via css (and by setting maxHeightInPx to -1):

 div.wicket-aa-container { maxHeight: 100px; }
 

Note that this does not work in IE6.

Parameters:

maxHeightInPx - the maximum height in pixels

Returns:

this AutoCompleteSettings

getIgnoreBordersWhenPositioning

public boolean getIgnoreBordersWhenPositioning()

Indicates whether the popup positioning will take into account the borders of the input element and its ancestors.

Returns:

true if borders are ignored, false otherwise.

setIgnoreBordersWhenPositioning

public AutoCompleteSettings setIgnoreBordersWhenPositioning(boolean ignoreBordersWhenPositioning)

Sets whether the popup positioning will take into account the borders of the input element and its ancestors (by including the clientLeft and clientTop DOM properties in the computation).

Parameters:

ignoreBordersWhenPositioning - the flag

Returns:

this AutoCompleteSettings.

getUseSmartPositioning

public boolean getUseSmartPositioning()

Indicates whether the popup positioning will take into account browser window visible area or not. (so always show popup bottom-right or not)

Returns:

true if popup smart positioning is used, false otherwise.

getUseHideShowCoveredIEFix

public boolean getUseHideShowCoveredIEFix()

Indicates whether in case of IE (and Opera), "select" "iframe" and "applet" tags should be hidden if covered by popup. (as they might appear on top)
By default this is true (before this flag was added).

Returns:

true if the fix/workaround should be used for IE and Opera, false otherwise.

getShowListOnEmptyInput

public boolean getShowListOnEmptyInput()

Indicates whether the autocomplete list will be shown if the input is empty.

Returns:

true if the autocomlete list will be shown if the input string is empty, false otherwise

setShowListOnEmptyInput

public AutoCompleteSettings setShowListOnEmptyInput(boolean showListOnEmptyInput)

Sets whether the list should be shown when the input is empty.

Parameters:

showListOnEmptyInput - the flag

Returns:

this AutoCompleteSettings

getCssClassName

public String getCssClassName()

Get CSS class name to add to the autocompleter markup container

Returns:

CSS class name, or null if not used

setCssClassName

public AutoCompleteSettings setCssClassName(String cssClassName)

Sets an CSS class name to add to the autocompleter markup container

This makes it easier to have multiple autocompleters in your application with different style and layout.

Parameters:

cssClassName - valid CSS class name

Returns:

this AutoCompleteSettings.

isAdjustInputWidth

public boolean isAdjustInputWidth()

Tells if wicket should adjust the width of the autocompleter selection window to the width of the related input field.

Returns:

true if the autocompleter should have the same size as the input field, false for default browser behavior

setAdjustInputWidth

public AutoCompleteSettings setAdjustInputWidth(boolean adjustInputWidth)

Adjust the width of the autocompleter selection window to the width of the related input field.

Otherwise the size will depend on the default browser behavior and CSS.

Parameters:

adjustInputWidth - true if the autocompleter should have the same size as the input field, false for default browser behavior

Returns:

this AutoCompleteSettings.

getShowListOnFocusGain

public boolean getShowListOnFocusGain()

Indicates whether the autocomplete list will be shown when the input field receives focus.

Returns:

true if the autocomplete list will be shown when the input field receives focus, false otherwise

setShowCompleteListOnFocusGain

public AutoCompleteSettings setShowCompleteListOnFocusGain(boolean showCompleteListOnFocusGain)

Sets whether the list should be shown when the input field receives focus.

Parameters:

showCompleteListOnFocusGain - the flag

Returns:

this AutoCompleteSettings.

getShowCompleteListOnFocusGain

public boolean getShowCompleteListOnFocusGain()

Indicates whether the autocomplete list will be shown when the input field receives focus.

Returns:

true if the autocomplete list will be shown when the input field receives focus, false otherwise

setShowListOnFocusGain

public AutoCompleteSettings setShowListOnFocusGain(boolean showListOnFocusGain)

Sets whether the list should be shown when the input field receives focus.

Parameters:

showListOnFocusGain - the flag

Returns:

this AutoCompleteSettings.

setUseSmartPositioning

public AutoCompleteSettings setUseSmartPositioning(boolean useSmartPositioning)

Sets whether the popup positioning will take into account browser window visible area or not. (so always show popup bottom-right or not)
THIS WILL PRODUCE UNWANTED BEHAVIOR WITH IE versions < 8 (probably because of unreliable clientWidth/clientHeight browser element properties).

Parameters:

useSmartPositioning - the flag

Returns:

this AutoCompleteSettings.

setUseHideShowCoveredIEFix

public AutoCompleteSettings setUseHideShowCoveredIEFix(boolean useHideShowCoveredIEFix)

Indicates whether in case of IE (and Opera), "select" "iframe" and "applet" tags should be hidden if covered by popup. (as they might appear on top)
By default this is true (before this flag was added).

Parameters:

useHideShowCoveredIEFix - the flag

Returns:

this AutoCompleteSettings.

setParameterName

public AutoCompleteSettings setParameterName(String parameterName)

Sets the name of the request parameter that will bring the value of the user input

Parameters:

parameterName - the name of the request parameter that will bring the value of the user input

Returns:

this AutoCompleteSettings

getParameterName

public String getParameterName()

Returns:

the name of the request parameter that will bring the value of the user input

getMinInputLength

public int getMinInputLength()

Returns:

the minimum input length required to display the autocomplete list

setMinInputLength

public AutoCompleteSettings setMinInputLength(int minInputLength)

Set the minimum input length required to display the autocomplete list

Parameters:

minInputLength - the minimum input length required to display the autocomplete list

Returns:

this AutoCompleteSettings