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;
018
019import org.apache.wicket.behavior.Behavior;
020import org.apache.wicket.event.IEvent;
021import org.apache.wicket.event.IEventSink;
022
023/**
024 * A specialization of {@link IEventSink} that adds component as an additional parameter to the
025 * {@link #onEvent(Component, IEvent)} method. This interface is useful for component plugins which
026 * wish to participate in event processing, for example {@link Behavior}s
027 * 
028 * @author igor
029 */
030public interface IComponentAwareEventSink
031{
032        /**
033         * Called when an event is sent to this behavior sink
034         * 
035         * @param component
036         *            component that owns this sink. For example, if the implementation of this
037         *            interface is a {@link Behavior} then component parameter will contain the
038         *            component to which the behavior is attached.
039         * @param event
040         */
041        void onEvent(Component component, IEvent<?> event);
042}