Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

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
 
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;
56
 
57
     private String cssClassName = null;
58
 
59
     private boolean adjustInputWidth = true;
60
     
61
     private boolean showListOnFocusGain = 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
69
 
70
 	public boolean getPreselect()
71
 	{
72
 		return ;
73
 	}
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
82
 
83
 	public AutoCompleteSettings setPreselect(boolean preselect)
84
 	{
85
 		this. = preselect;
86
 		return this;
87
 	}
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
94
 
95
 	public int getMaxHeightInPx()
96
 	{
97
 		return ;
98
 	}
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
116
	public AutoCompleteSettings setMaxHeightInPx(int maxHeightInPx)
117
	{
118
		this. = maxHeightInPx;
119
		return this;
120
	}
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
128
	public boolean getShowListOnEmptyInput()
129
	{
131
	}
Sets whether the list should be shown when the input is empty.

Parameters:
showListOnEmptyInput the flag
Returns:
this AutoCompleteSettings
140
	public AutoCompleteSettings setShowListOnEmptyInput(boolean showListOnEmptyInput)
141
	{
142
		this. = showListOnEmptyInput;
143
		return this;
144
	}

    
Get CSS class name to add to the autocompleter markup container

Returns:
CSS class name, or null if not used
151
    public String getCssClassName()
152
    {
153
        return ;
154
    }

    
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
164
    public void setCssClassName(final String cssClassName)
165
    {
166
        this. = cssClassName;
167
    }

    
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
176
    public boolean isAdjustInputWidth()
177
    {
178
        return ;
179
    }

  
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
189
    public void setAdjustInputWidth(final boolean adjustInputWidth)
190
    {
191
        this. = adjustInputWidth;
192
    }
    
    
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
200
    public boolean getShowListOnFocusGain()
201
    {
202
        return this.;
203
    }
    
    
Sets whether the list should be shown when the input field receives focus.

Parameters:
showListOnEmptyInput the flag
210
    public void setShowListOnFocusGain(final boolean showListOnFocusGain)
211
    {
212
        this. = showListOnFocusGain;
213
    }
New to GrepCode? Check out our FAQ X