1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: ModelChangeEventSource.java,v 1.6 2002/09/11 19:12:29 ludovicc Exp $
37 */
38 package org.scopemvc.core;
39
40
41 /***
42 * <P>
43 *
44 * Implemented by model objects that fire {@link ModelChangeEvent}s when their
45 * state changes: an implementation of the Observer Pattern. The Swing
46 * components in {@link org.scopemvc.view.swing} are aware to ModelChangeEvents:
47 * model objects that implement this interface are able to automatically refresh
48 * any {@link View}s bound to them. </P> <P>
49 *
50 * If a submodel of a model changes, the parent must also fire a
51 * ModelChangeEvent to notify of the change in state of one of its properties.
52 * For example, if a <CODE>Person</CODE> has a <CODE>Pet</CODE> as a property,
53 * then when the Pet changes its age it fires an event to notify of a change to
54 * the "age" property. The Person must then also fire an event to notify that
55 * the "pet.age" property changed. The Swing components rely on this behaviour.
56 * </P> <P>
57 *
58 * A useful base implementation of ModelChangeEventSource is provided in {@link
59 * org.scopemvc.model.basic.BasicModel}, which provides several convenience
60 * methods. </P>
61 *
62 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A>
63 * @created 05 August 2002
64 * @version $Revision: 1.6 $ $Date: 2002/09/11 19:12:29 $
65 */
66 public interface ModelChangeEventSource extends ModelChangeListener {
67
68 /***
69 * Adds a listener for ModelChangeEvents
70 *
71 * @param inListener The listener to be added
72 */
73 void addModelChangeListener(ModelChangeListener inListener);
74
75
76 /***
77 * Removes a listener for ModelChangeEvents
78 *
79 * @param inListener The listener to be removed
80 */
81 void removeModelChangeListener(ModelChangeListener inListener);
82
83
84 /***
85 * Fire a ModelChangeEvent to all listeners
86 *
87 * @param inChangeType The type of the change. One of the {@link
88 * ModelChangeTypes} values
89 * @param inSelector The Selector for the property of the model affected by
90 * the change
91 */
92 void fireModelChange(int inChangeType, Selector inSelector);
93
94
95 /***
96 * Implement ModelChangeListener to respond to a ModelChangeEvent from a
97 * contained sub-model that needs changes to be propagated up the model
98 * hierarchy.
99 *
100 * @param inEvent The event
101 */
102 void modelChanged(ModelChangeEvent inEvent);
103 }
This page was automatically generated by Maven