01: /*
02:
03: Licensed to the Apache Software Foundation (ASF) under one or more
04: contributor license agreements. See the NOTICE file distributed with
05: this work for additional information regarding copyright ownership.
06: The ASF licenses this file to You under the Apache License, Version 2.0
07: (the "License"); you may not use this file except in compliance with
08: the License. You may obtain a copy of the License at
09:
10: http://www.apache.org/licenses/LICENSE-2.0
11:
12: Unless required by applicable law or agreed to in writing, software
13: distributed under the License is distributed on an "AS IS" BASIS,
14: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: See the License for the specific language governing permissions and
16: limitations under the License.
17:
18: */
19: package org.apache.batik.gvt.event;
20:
21: import java.util.EventObject;
22:
23: import org.apache.batik.gvt.GraphicsNode;
24:
25: /**
26: * A low-level event for GraphicsNode.
27: *
28: * @author <a href="mailto:Thierry.Kormann@sophia.inria.fr">Thierry Kormann</a>
29: * @version $Id: GraphicsNodeEvent.java 475477 2006-11-15 22:44:28Z cam $
30: */
31: public class GraphicsNodeEvent extends EventObject {
32:
33: /** Indicates whether or not this event is consumed. */
34: private boolean consumed = false;
35:
36: /** The ID of this event. */
37: protected int id;
38:
39: /**
40: * Constructs a new graphics node event with the specified source and ID.
41: * @param source the graphics node where the event originated
42: * @param id the id of this event
43: */
44: public GraphicsNodeEvent(GraphicsNode source, int id) {
45: super (source);
46: this .id = id;
47: }
48:
49: /**
50: * Returns the ID of this event.
51: */
52: public int getID() {
53: return id;
54: }
55:
56: /**
57: * Returns the graphics node where the event is originated.
58: */
59: public GraphicsNode getGraphicsNode() {
60: return (GraphicsNode) source;
61: }
62:
63: /**
64: * Consumes this event so that it will not be processed
65: * in the default manner by the source which originated it.
66: */
67: public void consume() {
68: consumed = true;
69: }
70:
71: /**
72: * Returns whether or not this event has been consumed.
73: */
74: public boolean isConsumed() {
75: return consumed;
76: }
77: }
|