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

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

1.5.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.7
1.3.6
1.3.5
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
46
 
47
 public final class AutoCompleteSettings implements IClusterable
48
 {
49
 	private static final long serialVersionUID = 1L;
50
 
51
 	private boolean preselect = false;
52
 
53
 	private int maxHeightInPx = -1;
54
 
55
 	private boolean showListOnEmptyInput = false;

	
 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
63
 
64
 	public boolean getPreselect()
65
 	{
66
 		return preselect;
67
 	}

	
 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
76
 
77
 	public AutoCompleteSettings setPreselect(boolean preselect)
78
 	{
79
 		this.preselect = preselect;
80
 		return this;
81
 	}

	
 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
88
 
89
 	public int getMaxHeightInPx()
90
 	{
91
 		return maxHeightInPx;
92
 	}

	
 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
109
110
	public AutoCompleteSettings setMaxHeightInPx(int maxHeightInPx)
111
	{
112
		this.maxHeightInPx = maxHeightInPx;
113
		return this;
114
	}

	
 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
121
122
	public boolean getShowListOnEmptyInput()
123
	{
124
		return showListOnEmptyInput;
125
	}

	
 Sets whether the list should be shown when the input is empty.
 
 
 Parameters:showListOnEmptyInput
            the flag Returns:this AutoCompleteSettings
133
134
	public AutoCompleteSettings setShowListOnEmptyInput(boolean showListOnEmptyInput)
135
	{
136
		this.showListOnEmptyInput = showListOnEmptyInput;
137
		return this;
138
	}
139
}