001/* HyperlinkEvent.java --
002   Copyright (C) 2002, 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.event;
040
041import java.net.URL;
042import java.util.EventObject;
043
044import javax.swing.text.Element;
045
046/**
047 * @author Andrew Selkirk
048 * @author Ronald Veldema
049 */
050public class HyperlinkEvent extends EventObject
051{
052  public static final class EventType
053  {
054    public static final EventType ENTERED = new EventType("ENTERED"); // TODO
055    public static final EventType EXITED = new EventType("EXITED"); // TODO
056    public static final EventType ACTIVATED = new EventType("ACTIVATED"); // TODO
057    
058    private String type;
059
060    /**
061     * Creates a new Event type.
062     * 
063     * @param type String representing the event type.
064     */
065    private EventType(String type)
066    {
067      this.type = type;
068    }
069
070    /**
071     * Returns a <code>String</code> of this object.
072     */
073    public String toString()
074    {
075      return type;
076    }
077  }
078
079  private static final long serialVersionUID = -2054640811732867012L;
080  
081  private EventType type;
082  private URL url;
083  private String description;
084  private Element element;
085
086  /**
087   * Creates a new <code>HyperlinkEvent</code> with the given arguments.
088   * 
089   * @param source The object this link is associated to.
090   * @param type The type of event.
091   * @param url The URL this link pointing too.
092   */
093  public HyperlinkEvent(Object source, EventType type, URL url)
094  {
095    this (source, type, url, null, null);
096  }
097
098  /**
099   * Creates a new <code>HyperlinkEvent</code> with the given arguments.
100   * 
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.
105   */
106  public HyperlinkEvent(Object source, EventType type, URL url,
107                        String description)
108  {
109    this (source, type, url, description, null);
110  }
111  
112  /**
113   * Creates a new <code>HyperlinkEvent</code> with the given arguments.
114   * 
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.
120   */
121  public HyperlinkEvent(Object source, EventType type, URL url,
122                        String description, Element element)
123  {
124    super(source);
125    this.type = type;
126    this.url = url;
127    this.description = description;
128    this.element = element;
129  }
130
131  /**
132   * Returns the element of the document repesenting this anchor.
133   */
134  public Element getSourceElement()
135  {
136    return element;
137  }
138  
139  /**
140   * Returns the URL of this event.
141   */
142  public URL getURL()
143  {
144    return url;
145  }
146
147  /**
148   * Returns the type of this event.
149   */
150  public EventType getEventType()
151  {
152    return type;
153  }
154
155  /**
156   * Returns the description of this event.
157   */
158  public String getDescription()
159  {
160    return description;
161  }
162}