/*
* 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 org.apache.myfaces.tobago.internal.taglib.component;
import org.apache.myfaces.tobago.apt.annotation.BodyContent;
import org.apache.myfaces.tobago.apt.annotation.Tag;
import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
import org.apache.myfaces.tobago.apt.annotation.TagGeneration;
import org.apache.myfaces.tobago.compat.FacesUtils;
import org.apache.myfaces.tobago.component.Attributes;
import org.apache.myfaces.tobago.event.ResetFormActionListener;
import org.apache.myfaces.tobago.event.ResetInputActionListener;
import org.apache.myfaces.tobago.util.ComponentUtils;
import javax.faces.component.ActionSource;
import javax.faces.component.UIComponent;
import javax.faces.webapp.UIComponentTag;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;
/**
* A ResetInputActionListener is a declarative way to allow an action source to reset all EditableValueHolder
* of a page or in a sub-form or part of the component tree.
*/
@Tag(name = "resetInputActionListener", bodyContent = BodyContent.EMPTY)
@TagGeneration(className = "org.apache.myfaces.tobago.internal.taglib.ResetInputActionListenerTag")
public abstract class ResetInputActionListenerTag extends TagSupport {
private static final long serialVersionUID = -8444689365088370011L;
/**
* A list of ids of components. For each id, the surrounding (virtual) UIForm will be searched, and for each of
* them, all containing EditableValueHolder will be reset.
*/
@TagAttribute(required = false, name = Attributes.EXECUTE)
public abstract String getExecuteValue();
public abstract boolean isExecuteLiteral();
public abstract Object getExecuteAsBindingOrExpression();
public abstract boolean isExecuteSet();
public int doStartTag() throws JspException {
// Locate our parent UIComponentTag
UIComponentTag tag =
UIComponentTag.getParentUIComponentTag(pageContext);
if (tag == null) {
// TODO Message resource i18n
throw new JspException("Not nested in faces tag");
}
if (!tag.getCreated()) {
return (SKIP_BODY);
}
UIComponent component = tag.getComponentInstance();
if (component == null) {
// TODO Message resource i18n
throw new JspException("Component Instance is null");
}
if (!(component instanceof ActionSource)) {
// TODO Message resource i18n
throw new JspException("Component " + component.getClass().getName() + " is not instanceof ActionSource");
}
ActionSource actionSource = (ActionSource) component;
if (!isExecuteSet()) {
actionSource.addActionListener(new ResetFormActionListener());
} else if (isExecuteLiteral()) {
actionSource.addActionListener(new ResetInputActionListener(ComponentUtils.splitList(getExecuteValue())));
} else {
FacesUtils.addBindingOrExpressionResetActionListener(actionSource, getExecuteAsBindingOrExpression());
}
return (SKIP_BODY);
}
}