01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.wicket.extensions.breadcrumb;
18:
19: import java.util.EventListener;
20:
21: import org.apache.wicket.IClusterable;
22:
23: /**
24: * Bread crumb model listeners get notified by
25: * {@link IBreadCrumbModel bread crumb models} of
26: * {@link #breadCrumbActivated(IBreadCrumbParticipant, IBreadCrumbParticipant) activation},
27: * {@link #breadCrumbAdded(IBreadCrumbParticipant) addition} and
28: * {@link #breadCrumbRemoved(IBreadCrumbParticipant) removal} events.
29: *
30: * @author Eelco Hillenius
31: */
32: public interface IBreadCrumbModelListener extends EventListener,
33: IClusterable {
34: /**
35: * Called when a bread crumb was activated.
36: *
37: * @param previousParticipant
38: * The previously active participant
39: *
40: * @param breadCrumbParticipant
41: * The bread crumb that was activated.
42: */
43: void breadCrumbActivated(
44: IBreadCrumbParticipant previousParticipant,
45: IBreadCrumbParticipant breadCrumbParticipant);
46:
47: /**
48: * Called when a bread crumb was added to the model.
49: *
50: * @param breadCrumbParticipant
51: * The new bread crumb
52: */
53: void breadCrumbAdded(IBreadCrumbParticipant breadCrumbParticipant);
54:
55: /**
56: * Called when a bread crumb was removed from the model.
57: *
58: * @param breadCrumbParticipant
59: * The bread crumb that was removed
60: */
61: void breadCrumbRemoved(IBreadCrumbParticipant breadCrumbParticipant);
62: }
|