GrepCode: org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteSettings (.java) - Class

Maven-Central
/
org.apache.wicket / wicket-extensions
/
1.4.5

1.5.4
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.7
1.3.6
1.3.4
/
org.apache.wicket.extensions.ajax.markup.html.autocomplete.AutoCompleteSettings
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one or more
3
   * contributor license agreements.  See the NOTICE file distributed with
4
   * this work for additional information regarding copyright ownership.
5
   * The ASF licenses this file to You under the Apache License, Version 2.0
6
   * (the "License"); you may not use this file except in compliance with
7
   * the License.  You may obtain a copy of the License at
8
   *
9
   *      http://www.apache.org/licenses/LICENSE-2.0
10
  *
11
  * Unless required by applicable law or agreed to in writing, software
12
  * distributed under the License is distributed on an "AS IS" BASIS,
13
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
  * See the License for the specific language governing permissions and
15
  * limitations under the License.
16
  */
17
 package org.apache.wicket.extensions.ajax.markup.html.autocomplete;
18
 
19
 import org.apache.wicket.IClusterable;

 This class encapsulates various settings for AbstractAutoCompleteBehavior. See the
 documentation for the property accessors of this class for further information.
 
 Default settings:
 
settingdefault value
preselectfalse
maxHeightInPx-1
showListOnEmptyInputfalse
 Author(s):Gerolf Seitz
47
 
48
 public final class AutoCompleteSettings implements IClusterable
49
 {
50
 	private static final long serialVersionUID = 1L;
51
 
52
 	private boolean preselect = false;
53
 
54
 	private int maxHeightInPx = -1;
55
 
56
 	private boolean showListOnEmptyInput = false;
57
 
58
 	private boolean useSmartPositioning = false;
59
 
60
 	private boolean useHideShowCoveredIEFix = true;
61
 
62
 	private String cssClassName = null;
63
 
64
 	private boolean adjustInputWidth = true;
65
 
66
 	private boolean showListOnFocusGain = false;
67
 
68
 	private boolean showCompleteListOnFocusGain = false;
69
 
70
 	private int throttleDelay = 300;

	
 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
78
 
79
 	public boolean getPreselect()
80
 	{
81
 		return preselect;
82
 	}

	
 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
91
 
92
 	public AutoCompleteSettings setPreselect(boolean preselect)
93
 	{
94
 		this.preselect = preselect;
95
 		return this;
96
 	}

	
 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.
104
105
	public void setThrottleDelay(int throttleDelay)
106
	{
107
		this.throttleDelay = throttleDelay;
108
	}

	
 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)
115
116
	public int getThrottleDelay()
117
	{
118
		return throttleDelay;
119
	}

	
 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
126
127
	public int getMaxHeightInPx()
128
	{
129
		return maxHeightInPx;
130
	}

	
 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
147
148
	public AutoCompleteSettings setMaxHeightInPx(int maxHeightInPx)
149
	{
150
		this.maxHeightInPx = maxHeightInPx;
151
		return this;
152
	}

	
 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.
159
160
	public boolean getUseSmartPositioning()
161
	{
162
		return useSmartPositioning;
163
	}

	
 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.
171
172
	public boolean getUseHideShowCoveredIEFix()
173
	{
174
		return useHideShowCoveredIEFix;
175
	}

	
 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
182
183
	public boolean getShowListOnEmptyInput()
184
	{
185
		return showListOnEmptyInput;
186
	}

	
 Sets whether the list should be shown when the input is empty.
 
 
 Parameters:showListOnEmptyInput
            the flag Returns:this AutoCompleteSettings
194
195
	public AutoCompleteSettings setShowListOnEmptyInput(boolean showListOnEmptyInput)
196
	{
197
		this.showListOnEmptyInput = showListOnEmptyInput;
198
		return this;
199
	}

	
 Get CSS class name to add to the autocompleter markup container
 
 
 Returns:CSS class name, or null if not used
205
206
	public String getCssClassName()
207
	{
208
		return cssClassName;
209
	}

	
 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.
220
221
	public AutoCompleteSettings setCssClassName(final String cssClassName)
222
	{
223
		this.cssClassName = cssClassName;
224
		return this;
225
	}

	
 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
233
234
	public boolean isAdjustInputWidth()
235
	{
236
		return adjustInputWidth;
237
	}

	
 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.
249
250
	public AutoCompleteSettings setAdjustInputWidth(final boolean adjustInputWidth)
251
	{
252
		this.adjustInputWidth = adjustInputWidth;
253
		return this;
254
	}

	
 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
261
262
	public boolean getShowListOnFocusGain()
263
	{
264
		return showListOnFocusGain;
265
	}

	
 Sets whether the list should be shown when the input field receives focus.
 
 
 Parameters:showListOnEmptyInput
            the flag Returns:this AutoCompleteSettings.
273
274
	public AutoCompleteSettings setShowCompleteListOnFocusGain(final boolean showCompleteListOnFocusGain)
275
	{
276
		this.showCompleteListOnFocusGain = showCompleteListOnFocusGain;
277
		return this;
278
	}

	
 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
285
286
	public boolean getShowCompleteListOnFocusGain()
287
	{
288
		return showCompleteListOnFocusGain;
289
	}

	
 Sets whether the list should be shown when the input field receives focus.
 
 
 Parameters:showListOnEmptyInput
            the flag Returns:this AutoCompleteSettings.
297
298
	public AutoCompleteSettings setShowListOnFocusGain(final boolean showListOnFocusGain)
299
	{
300
		this.showListOnFocusGain = showListOnFocusGain;
301
		return this;
302
	}

	
 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.
311
312
	public AutoCompleteSettings setUseSmartPositioning(final boolean useSmartPositioning)
313
	{
314
		this.useSmartPositioning = useSmartPositioning;
315
		return this;
316
	}

	
 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.
326
327
	public AutoCompleteSettings setUseHideShowCoveredIEFix(final boolean useHideShowCoveredIEFix)
328
	{
329
		this.useHideShowCoveredIEFix = useHideShowCoveredIEFix;
330
		return this;
331
	}
332
333
}