wicket-core/src/main/java/org/apache/wicket/markup/html/form/IFormVisitorParticipant.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;

/**
 * Participates in the form visiting algorithm, and can hint that visiting should go on as normal (
 * {@link #processChildren()} returns true) or is limited to the same level (only siblings are
 * processed, {@link #processChildren()} returns false).
 * 
 * @author Pekka Enberg
 */
@FunctionalInterface
public interface IFormVisitorParticipant
{
	/**
	 * Should children be traversed during visiting or should only the siblings be processed.
	 * 
	 * @return <tt>true</tt> if children should be traversed during form processing; <tt>false</tt>
	 *         if only the siblings should be processed.
	 */
	boolean processChildren();
}