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.ajax;
018
019
020import org.apache.wicket.util.io.IClusterable;
021
022/**
023 * This interface makes it trivial to use busy indicators for ajax requests. This interface can be
024 * implemented by a component that has an ajax behavior attached to it, or any parent of the
025 * component, or by the ajax behavior itself. If this is the case javascript will be added
026 * automatically that will show a markup element pointed to by the
027 * {@link #getAjaxIndicatorMarkupId()} markup id attribute when the ajax request begins, and hide it
028 * when the ajax requests succeeds or fails.
029 * <p>
030 * If both a component and a behavior implement this interface, the component will take precedence.
031 * 
032 * @since 1.2
033 * 
034 * @author Igor Vaynberg (ivaynberg)
035 * 
036 */
037@FunctionalInterface
038public interface IAjaxIndicatorAware extends IClusterable
039{
040        /**
041         * @return the value of the markup id attribute of the indicating element
042         */
043        String getAjaxIndicatorMarkupId();
044}