001    /* HTMLFrameHyperlinkEvent.java --
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.swing.text.html;
040    
041    import java.net.URL;
042    
043    import javax.swing.event.HyperlinkEvent;
044    import javax.swing.text.Element;
045    
046    /**
047     * HTMLFrameHyperlinkEvent transfers information about the link that was
048     * activated in a frame.
049     *
050     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
051     */
052    public class HTMLFrameHyperlinkEvent extends HyperlinkEvent
053    {
054      private final String target_frame;
055    
056      /**
057       * Creates a new hypertext link event.
058       *
059       * @param source The object this link is associated to.
060       * @param type The type of event.
061       * @param url The URL this link pointing too.
062       * @param element The element in the document representing the anchor.
063       * @param frame - the Frame to display the document in.
064       */
065      public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
066                                     Element element, String frame)
067      {
068        super(source, type, url, frame, element);
069        target_frame = frame;
070      }
071    
072      /**
073       * Creates a new hypertext link event.
074       *
075       * @param source The object this link is associated to.
076       * @param type The type of event.
077       * @param url The URL this link pointing too.
078       * @param frame - the Frame to display the document in.
079       */
080      public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
081                                     String frame)
082      {
083        super(source, type, url, frame);
084        target_frame = frame;
085      }
086    
087      /**
088       * Creates a new hypertext link event.
089       *
090       * @param source The object this link is associated to.
091       * @param type The type of event.
092       * @param url The URL this link pointing too.
093       * @param description The description for this link.
094       * @param element The element in the document representing the anchor.
095       * @param frame - the Frame to display the document in.
096       */
097      public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
098                                     String description, Element element,
099                                     String frame)
100      {
101        super(source, type, url, description, element);
102        target_frame = frame;
103      }
104    
105      /**
106       * Creates a new hypertext link event.
107       *
108       * @param source The object this link is associated to.
109       * @param type The type of event.
110       * @param url The URL this link pointing too.
111       * @param description The description for this link.
112       * @param frame - the Frame to display the document in.
113       */
114      public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
115                                     String description, String frame)
116      {
117        super(source, type, url, description);
118        target_frame = frame;
119      }
120    
121      /**
122       * Gets the string, passed as the target frame identifier.
123       *
124       * @return the target for the link.
125       */
126      public String getTarget()
127      {
128        return target_frame;
129      }
130    }