Source for javax.swing.text.html.HTMLFrameHyperlinkEvent

   1: /* HTMLFrameHyperlinkEvent.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   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.
  10: 
  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.
  15: 
  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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  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.
  25: 
  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. */
  37: 
  38: 
  39: package javax.swing.text.html;
  40: 
  41: import java.net.URL;
  42: 
  43: import javax.swing.event.HyperlinkEvent;
  44: import javax.swing.event.HyperlinkEvent.EventType;
  45: import javax.swing.text.Element;
  46: 
  47: /**
  48:  * HTMLFrameHyperlinkEvent transfers information about the link that was
  49:  * activated in a frame.
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public class HTMLFrameHyperlinkEvent
  54:   extends HyperlinkEvent
  55: {
  56:   private final String target_frame;
  57: 
  58:   /**
  59:    * Creates a new hypertext link event.
  60:    *
  61:    * @param source The object this link is associated to.
  62:    * @param type The type of event.
  63:    * @param url The URL this link pointing too.
  64:    * @param element The element in the document representing the anchor.
  65:    * @param frame - the Frame to display the document in.
  66:    */
  67:   public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
  68:                                  Element element, String frame)
  69:   {
  70:     super(source, type, url, frame, element);
  71:     target_frame = frame;
  72:   }
  73: 
  74:   /**
  75:    * Creates a new hypertext link event.
  76:    *
  77:    * @param source The object this link is associated to.
  78:    * @param type The type of event.
  79:    * @param url The URL this link pointing too.
  80:    * @param frame - the Frame to display the document in.
  81:    */
  82:   public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
  83:                                  String frame)
  84:   {
  85:     super(source, type, url, frame);
  86:     target_frame = frame;
  87:   }
  88: 
  89:   /**
  90:    * Creates a new hypertext link event.
  91:    *
  92:    * @param source The object this link is associated to.
  93:    * @param type The type of event.
  94:    * @param url The URL this link pointing too.
  95:    * @param description The description for this link.
  96:    * @param element The element in the document representing the anchor.
  97:    * @param frame - the Frame to display the document in.
  98:    */
  99:   public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
 100:                                  String description, Element element,
 101:                                  String frame)
 102:   {
 103:     super(source, type, url, description, element);
 104:     target_frame = frame;
 105:   }
 106: 
 107:   /**
 108:    * Creates a new hypertext link event.
 109:    *
 110:    * @param source The object this link is associated to.
 111:    * @param type The type of event.
 112:    * @param url The URL this link pointing too.
 113:    * @param description The description for this link.
 114:    * @param frame - the Frame to display the document in.
 115:    */
 116:   public HTMLFrameHyperlinkEvent(Object source, EventType type, URL url,
 117:                                  String description, String frame)
 118:   {
 119:     super(source, type, url, description);
 120:     target_frame = frame;
 121:   }
 122: 
 123:   /**
 124:    * Gets the string, passed as the target frame identifier.
 125:    *
 126:    * @return the target for the link.
 127:    */
 128:   public String getTarget()
 129:   {
 130:     return target_frame;
 131:   }
 132: }