wicket-core/src/main/java/org/apache/wicket/markup/html/form/IFormSubmittingComponent.java

/*
 * 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.wicket.markup.html.form;

import org.apache.wicket.Component;

/**
 * Interface that must be implemented by components that are able to submit form.
 * 
 * @author Matej Knopp
 */
public interface IFormSubmittingComponent extends IFormSubmitter
{
	/**
	 * Sets the defaultFormProcessing property. When false (default is true), all validation and
	 * form updating is bypassed and the onSubmit method of that button is called directly, and the
	 * onSubmit method of the parent form is not called. A common use for this is to create a cancel
	 * button.
	 * 
	 * @param defaultFormProcessing
	 * @return {@code this} component
	 */
	Component setDefaultFormProcessing(boolean defaultFormProcessing);

	/**
	 * Returns the name that is unique to this component, at least within the form.
	 * 
	 * @return component name
	 */
	String getInputName();
}