com.jgeppert.struts2.jquery.components.Autocompleter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.jgeppert.struts2.jquery.components;
import java.util.Random;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts2.views.annotations.StrutsTag;
import org.apache.struts2.views.annotations.StrutsTagAttribute;
import org.apache.struts2.views.annotations.StrutsTagSkipInheritance;
import com.opensymphony.xwork2.util.ValueStack;
import com.opensymphony.xwork2.util.logging.Logger;
import com.opensymphony.xwork2.util.logging.LoggerFactory;
/**
*
*
* A tag that creates an Autocompleter.
*
*
*
* Examples
*
*
*
*
* Autocompleter handle a String Array
*
*
*
* <sj:autocompleter id="languages" list="%{languages}"/>
*
*
*
*
*
*
* Autocompleter that handle a JSON Result
*
*
*
* <s:url id="remoteurl" action="jsonlanguages"/>
* <sj:autocompleter
* id="languages"
* href="%{remoteurl}"
* delay="50"
* loadMinimumCount="2"
* />
*
*
*
*
*
*
* Autocompleter as Select Box
*
*
*
* <sj:autocompleter
* id="customers"
* name="echo"
* list="%{customers}"
* listValue="name"
* listKey="id"
* selectBox="true"
* />
*
*
*
*
* @author Johannes Geppert
*
*/
@StrutsTag(name = "autocompleter", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.AutocompleterTag", description = "Render a jQuery UI Autocompleter", allowDynamicAttributes = true)
public class Autocompleter extends AbstractFormListElement {
public static final String JQUERYACTION = "autocompleter";
public static final String TEMPLATE = "autocompleter-close";
public static final String OPEN_TEMPLATE = "autocompleter";
final protected static Logger LOG = LoggerFactory
.getLogger(Autocompleter.class);
final private static transient Random RANDOM = new Random();
protected String delay;
protected String loadMinimumCount;
protected String selectBox;
protected String selectBoxIcon;
protected String onSelectTopics;
protected String onFocusTopics;
protected String onSearchTopics;
protected String maxlength;
protected String readonly;
protected String size;
protected String multiple;
protected String listLabel;
protected String forceValidOption;
protected String autoFocus;
protected String valueWidget;
public Autocompleter(ValueStack stack, HttpServletRequest request,
HttpServletResponse response) {
super(stack, request, response);
}
@Override
public String getDefaultOpenTemplate() {
return OPEN_TEMPLATE;
}
protected String getDefaultTemplate() {
return TEMPLATE;
}
public void evaluateParams() {
super.evaluateParams();
addParameter("jqueryaction", JQUERYACTION);
if (getParameters().get("list") != null) {
addParameter("emptyOption", true);
}
if (delay != null)
addParameter("delay", findValue(delay, Integer.class));
if (loadMinimumCount != null)
addParameter("loadMinimumCount",
findValue(loadMinimumCount, Integer.class));
// if (list != null) addParameter("list", findString(list));
if (size != null) {
addParameter("size", findString(size));
}
if (maxlength != null) {
addParameter("maxlength", findString(maxlength));
}
if (selectBox != null) {
addParameter("selectBox", findValue(selectBox, Boolean.class));
}
if (selectBoxIcon != null) {
addParameter("selectBoxIcon",
findValue(selectBoxIcon, Boolean.class));
}
if (readonly != null) {
addParameter("readonly", findValue(readonly, Boolean.class));
}
if (multiple != null) {
addParameter("multiple", findValue(multiple, Boolean.class));
}
if (onSelectTopics != null) {
addParameter("onSelectTopics", findString(onSelectTopics));
}
if (onFocusTopics != null) {
addParameter("onFocusTopics", findString(onFocusTopics));
}
if (onSearchTopics != null) {
addParameter("onSearchTopics", findString(onSearchTopics));
}
if (listLabel != null) {
listLabel = stripExpressionIfAltSyntax(listLabel);
addParameter("listLabel", listLabel);
}
if (forceValidOption != null) {
addParameter("forceValidOption",
findValue(forceValidOption, Boolean.class));
}
if (autoFocus != null) {
addParameter("autoFocus", findValue(autoFocus, Boolean.class));
}
if ((this.id == null || this.id.length() == 0)) {
// resolves Math.abs(Integer.MIN_VALUE) issue reported by FindBugs
// http://findbugs.sourceforge.net/bugDescriptions.html#RV_ABSOLUTE_VALUE_OF_RANDOM_INT
int nextInt = RANDOM.nextInt();
nextInt = nextInt == Integer.MIN_VALUE ? Integer.MAX_VALUE : Math
.abs(nextInt);
this.id = "autocompleter_" + String.valueOf(nextInt);
}
addParameter("id", this.id + "_widget");
addParameter("widgetid", this.id);
String nameValue = (String) getParameters().get("name");
addParameter("name", nameValue + "_widget");
addParameter("widgetname", nameValue);
if (valueWidget != null) {
addParameter("valueWidget", findString(valueWidget));
} else if (value != null) {
addParameter("valueWidget", findString(value));
}
}
@Override
@StrutsTagSkipInheritance
public void setTheme(String theme) {
super.setTheme(theme);
}
@Override
public String getTheme() {
return "jquery";
}
@StrutsTagAttribute(description = "Delay before making the search", type = "Integer", defaultValue = "300")
public void setDelay(String delay) {
this.delay = delay;
}
@StrutsTagAttribute(description = "Minimum number of characters that will force the content to be loaded", type = "Integer", defaultValue = "1")
public void setLoadMinimumCount(String loadMinimumCount) {
this.loadMinimumCount = loadMinimumCount;
}
@StrutsTagAttribute(description = "Use an Select Box as Autocompleter", defaultValue = "false", type = "Boolean", required = false)
public void setSelectBox(String selectBox) {
this.selectBox = selectBox;
}
@StrutsTagAttribute(description = "display the select box icon", type = "Boolean", defaultValue = "false")
public void setSelectBoxIcon(String selectBoxIcon) {
this.selectBoxIcon = selectBoxIcon;
}
@StrutsTagAttribute(description = "A comma delimited list of topics that published when item is selected")
public void setOnSelectTopics(String onSelectTopics) {
this.onSelectTopics = onSelectTopics;
}
@StrutsTagAttribute(description = "A comma delimited list of topics that published before focus is moved to an item")
public void setOnFocusTopics(String onFocusTopics) {
this.onFocusTopics = onFocusTopics;
}
@StrutsTagAttribute(description = "A comma delimited list of topics that published before a request is started, after loadMinimumCount and delay are met.")
public void setOnSearchTopics(String onSearchTopics) {
this.onSearchTopics = onSearchTopics;
}
@StrutsTagAttribute(description = "HTML maxlength attribute", type = "Integer")
public void setMaxlength(String maxlength) {
this.maxlength = maxlength;
}
@StrutsTagAttribute(description = "Whether the input is readonly", type = "Boolean", defaultValue = "false")
public void setReadonly(String readonly) {
this.readonly = readonly;
}
@StrutsTagAttribute(description = "HTML size attribute", type = "Integer")
public void setSize(String size) {
this.size = size;
}
@StrutsTagAttribute(description = " Creates a multiple select. The tag will pre-select multiple values"
+ " if the values are passed as an Array or a Collection(of appropriate types) via the value attribute. If one of the keys equals"
+ " one of the values in the Collection or Array it wil be selected", type = "Boolean", defaultValue = "false")
public void setMultiple(String multiple) {
this.multiple = multiple;
}
@StrutsTagAttribute(description = "a seperate label element.")
public void setListLabel(String listLabel) {
this.listLabel = listLabel;
}
@StrutsTagAttribute(description = "Force selection to be one of the options.", defaultValue = "true", type = "Boolean", required = false)
public void setForceValidOption(String forceValidOption) {
this.forceValidOption = forceValidOption;
}
@StrutsTagAttribute(description = "If set to true the first item will be automatically focused.", defaultValue = "false", type = "Boolean", required = false)
public void setAutoFocus(String autoFocus) {
this.autoFocus = autoFocus;
}
@StrutsTagAttribute(description = "The value of the Widget Input Field.")
public void setValueWidget(String valueWidget) {
this.valueWidget = valueWidget;
}
}