Merge from mainline (gomp-merge-2005-02-26).
[official-gcc.git] / libjava / javax / swing / event / HyperlinkEvent.java
bloba3a155a31740025deb644d8e34e65fecb95db374
1 /* HyperlinkEvent.java --
2 Copyright (C) 2002, 2004 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 02111-1307 USA.
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
39 package javax.swing.event;
41 import java.net.URL;
42 import java.util.EventObject;
44 import javax.swing.text.Element;
46 /**
47 * @author Andrew Selkirk
48 * @author Ronald Veldema
50 public class HyperlinkEvent extends EventObject
52 public static final class EventType
54 public static final EventType ENTERED = new EventType("ENTERED"); // TODO
55 public static final EventType EXITED = new EventType("EXITED"); // TODO
56 public static final EventType ACTIVATED = new EventType("ACTIVATED"); // TODO
58 private String type;
60 /**
61 * Creates a new Event type.
63 * @param type String representing the event type.
65 private EventType(String type)
67 this.type = type;
70 /**
71 * Returns a <code>String</code> of this object.
73 public String toString()
75 return type;
79 private static final long serialVersionUID = -2054640811732867012L;
81 private EventType type;
82 private URL url;
83 private String description;
84 private Element element;
86 /**
87 * Creates a new <code>HyperlinkEvent</code> with the given arguments.
89 * @param source The object this link is associated to.
90 * @param type The type of event.
91 * @param url The URL this link pointing too.
93 public HyperlinkEvent(Object source, EventType type, URL url)
95 this (source, type, url, null, null);
98 /**
99 * Creates a new <code>HyperlinkEvent</code> with the given arguments.
101 * @param source The object this link is associated to.
102 * @param type The type of event.
103 * @param url The URL this link pointing too.
104 * @param description The description for this link.
106 public HyperlinkEvent(Object source, EventType type, URL url,
107 String description)
109 this (source, type, url, description, null);
113 * Creates a new <code>HyperlinkEvent</code> with the given arguments.
115 * @param source The object this link is associated to.
116 * @param type The type of event.
117 * @param url The URL this link pointing too.
118 * @param description The description for this link.
119 * @param element The element in the document representing the anchor.
121 public HyperlinkEvent(Object source, EventType type, URL url,
122 String description, Element element)
124 super(source);
125 this.type = type;
126 this.url = url;
127 this.description = description;
128 this.element = element;
132 * Returns the element of the document repesenting this anchor.
134 public Element getSourceElement()
136 return element;
140 * Returns the URL of this event.
142 public URL getURL()
144 return url;
148 * Returns the type of this event.
150 public EventType getEventType()
152 return type;
156 * Returns the description of this event.
158 public String getDescription()
160 return description;