com.jgeppert.struts2.jquery.components.Anchor 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;
/**
*
*
* A tag that creates an HTML <a/> element, that when clicked makes an
* asynchronous request(XMLHttpRequest). The url attribute must be build using
* the <s:url/> tag.
*
*
*
* Examples
*
*
*
*
*
* <div id="div1">Div 1</div>
* <s:url id="ajaxTest" value="/AjaxTest.action"/>
*
* <sj:a id="link1" href="%{ajaxTest}" target="div1"> Update Content </sj:a>
*
*
*
*
*
*
*
* <s:form id="form" action="AjaxTest">
* <input type="textbox" name="data"> </s:form>
*
* <sj:a formId="form" targets="div1">Submit form</sj:a>
*
*
*
*
* @author Johannes Geppert
*
*/
@StrutsTag(name = "a", tldTagClass = "com.jgeppert.struts2.jquery.views.jsp.ui.AnchorTag", description = "Renders an HTML anchor element that when clicked calls a URL via remote XMLHttpRequest and updates its targets content", allowDynamicAttributes = true)
public class Anchor extends AbstractRemoteBean implements ButtonBean {
public static final String TEMPLATE = "a";
public static final String TEMPLATE_CLOSE = "a-close";
public static final String COMPONENT_NAME = Anchor.class.getName();
public static final transient Random RANDOM = new Random();
public static final String JQUERYACTION = "anchor";
protected String openDialog;
protected String openDialogTitle;
protected String onClickTopics;
protected String validate;
protected String validateFunction;
protected String button;
protected String buttonIcon;
protected String buttonIconSecondary;
protected String buttonText;
protected String clearForm;
protected String resetForm;
protected String iframe;
protected String replaceTarget;
public Anchor(ValueStack stack, HttpServletRequest request,
HttpServletResponse response) {
super(stack, request, response);
}
public String getDefaultOpenTemplate() {
return TEMPLATE;
}
protected String getDefaultTemplate() {
return TEMPLATE_CLOSE;
}
public String getComponentName() {
return COMPONENT_NAME;
}
public void evaluateExtraParams() {
super.evaluateExtraParams();
addParameter("jqueryaction", JQUERYACTION);
if (openDialog != null)
addParameter("openDialog", findString(openDialog));
if (openDialogTitle != null)
addParameter("openDialogTitle", findString(openDialogTitle));
if (onClickTopics != null)
addParameter("onClickTopics", findString(onClickTopics));
if (button != null)
addParameter("button", findValue(this.button, Boolean.class));
if (buttonIcon != null)
addParameter("buttonIcon", findString(buttonIcon));
if (buttonIconSecondary != null)
addParameter("buttonIconSecondary", findString(buttonIconSecondary));
if (buttonText != null)
addParameter("buttonText", findValue(this.buttonText, Boolean.class));
if (validate != null)
addParameter("validate", findValue(this.validate, Boolean.class));
if (validateFunction != null)
addParameter("validateFunction", findString(validateFunction));
if (clearForm != null)
addParameter("clearForm", findValue(clearForm, Boolean.class));
if (resetForm != null)
addParameter("resetForm", findValue(resetForm, Boolean.class));
if (iframe != null)
addParameter("iframe", findValue(iframe, Boolean.class));
if (replaceTarget != null)
addParameter("replaceTarget", findValue(this.replaceTarget,
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 = "anchor_" + String.valueOf(nextInt);
addParameter("id", this.id);
}
}
@Override
@StrutsTagSkipInheritance
public void setTheme(String theme) {
super.setTheme(theme);
}
@Override
public String getTheme() {
return "jquery";
}
@StrutsTagAttribute(description = "id of dialog that will be opened when clicked.")
public void setOpenDialog(String openDialog) {
this.openDialog = openDialog;
}
@StrutsTagAttribute(description = "Set the title of a dialog opened by openDialog or openDialogTopics")
public void setOpenDialogTitle(String openDialogTitle) {
this.openDialogTitle = openDialogTitle;
}
@StrutsTagAttribute(name = "onClickTopics", description = "A comma delimited list of topics that published when the element is clicked", type = "String", defaultValue = "")
public void setOnClickTopics(String onClickTopics) {
this.onClickTopics = onClickTopics;
}
@StrutsTagAttribute(description = "jQuery UI Button", defaultValue = "false", type = "Boolean")
public void setButton(String button) {
this.button = button;
}
@StrutsTagAttribute(description = "Icons to display. The primary icon is displayed on the left of the label text. Value must be a classname (String), eg. ui-icon-gear.")
public void setButtonIcon(String buttonIcon) {
this.buttonIcon = buttonIcon;
}
@StrutsTagAttribute(description = "Icons to display. The secondary icon is displayed on the right of the label text. Value must be a classname (String), eg. ui-icon-gear.")
public void setButtonIconSecondary(String buttonIconSecondary) {
this.buttonIconSecondary = buttonIconSecondary;
}
@StrutsTagAttribute(description = "Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.", defaultValue = "true", type = "Boolean")
public void setButtonText(String buttonText) {
this.buttonText = buttonText;
}
@StrutsTagAttribute(description = "A function that handle the client validation result. eg.: myValidation(form, errors)")
public void setValidateFunction(String validateFunction) {
this.validateFunction = validateFunction;
}
@StrutsTagAttribute(description = "Enable client AJAX validation", defaultValue = "false", type = "Boolean")
public void setValidate(String validate) {
this.validate = validate;
}
@StrutsTagAttribute(description = "Clear all form fields after successful submit when using formIds. Default: false", type = "Boolean")
public void setClearForm(String clearForm) {
this.clearForm = clearForm;
}
@StrutsTagAttribute(description = "Reset the form after successful submi twhen using formIds. Default: false", type = "Boolean")
public void setResetForm(String resetForm) {
this.resetForm = resetForm;
}
@StrutsTagAttribute(description = "Boolean flag indicating whether the form should always target the server response to an iframe when using formIds. This is useful in conjuction with file uploads. Default: false", type = "Boolean")
public void setIframe(String iframe) {
this.iframe = iframe;
}
@StrutsTagAttribute(description = "Set to true if the target should be replaced or false if only the target contents should be replaced when using formIds.", defaultValue = "false", type = "Boolean")
public void setReplaceTarget(String replaceTarget) {
this.replaceTarget = replaceTarget;
}
}