001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.markup.html.form;
018
019/**
020 * Participates in the form visiting algorithm, and can hint that visiting should go on as normal (
021 * {@link #processChildren()} returns true) or is limited to the same level (only siblings are
022 * processed, {@link #processChildren()} returns false).
023 * 
024 * @author Pekka Enberg
025 */
026@FunctionalInterface
027public interface IFormVisitorParticipant
028{
029        /**
030         * Should children be traversed during visiting or should only the siblings be processed.
031         * 
032         * @return <tt>true</tt> if children should be traversed during form processing; <tt>false</tt>
033         *         if only the siblings should be processed.
034         */
035        boolean processChildren();
036}