org.richfaces.component.attribute.AjaxProps Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright ${year}, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.richfaces.component.attribute;
import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.Description;
import org.richfaces.cdk.annotations.EventName;
/**
* Interface defining the methods for ajax activator components
*
* @author Lukas Fryc
*/
public interface AjaxProps extends AjaxActivatorProps {
/**
* IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single ID,
* a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords
* "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of
* additional keywords
*/
@Attribute(description = @Description("IDs of components that will participate in the \"execute\" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords \"@this\", \"@form\", \"@all\", \"@none\", \"@region\" may be specified in the identifier list. Some components make use of additional keywords"))
Object getExecute();
/**
* Name of the request status component that will indicate the status of the Ajax request
*/
@Attribute(description = @Description("Name of the request status component that will indicate the status of the Ajax request"))
String getStatus();
/**
* The client-side script method to be called before an ajax request.
*/
@Attribute(events = @EventName("begin"), description = @Description("The client-side script method to be called before an ajax request."))
String getOnbegin();
}