1 /*
2 * Copyright 2006-2016 The JGUIraffe Team.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License")
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package net.sf.jguiraffe.gui.builder.event;
17
18 import java.util.EventObject;
19
20 /**
21 * <p>
22 * The base class of events used in the form and form builder framework.
23 * </p>
24 * <p>
25 * The form framework provides an abstraction from specific GUI libraries like
26 * Swing or SWT. This abstraction includes the event handling mechanism, too. To
27 * achieve this, generic event classes are defined, to which library specific
28 * event types have to be converted. This class is the base class for these
29 * generic event classes. There are also corresponding event listener
30 * interfaces.
31 * </p>
32 * <p>
33 * The common denominator of all event classes in the builder framework is the
34 * <code>source</code> property (which is already inherited from the base
35 * class <code>EventObject</code>. Here the original, library specific event
36 * object should be set allowing application code to access platform specific
37 * information if necessary.
38 * </p>
39 *
40 * @author Oliver Heger
41 * @version $Id: BuilderEvent.java 205 2012-01-29 18:29:57Z oheger $
42 */
43 public class BuilderEvent extends EventObject
44 {
45 /**
46 * The serial version UID.
47 */
48 private static final long serialVersionUID = -8841052675925806622L;
49
50 /**
51 * Creates a new instance of <code>BuilderEvent</code> and initializes it.
52 * The event's source is passed, which should be the the platform specific
53 * event object that is wrapped by this generic object instance.
54 *
55 * @param source the source of this event
56 */
57 public BuilderEvent(Object source)
58 {
59 super(source);
60 }
61 }