FileDocCategorySizeDatePackage
HyperlinkEvent.javaAPI DocJava SE 5 API4989Fri Aug 26 14:58:00 BST 2005javax.swing.event

HyperlinkEvent

public class HyperlinkEvent extends EventObject
HyperlinkEvent is used to notify interested parties that something has happened with respect to a hypertext link.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

version
1.18 12/19/03
author
Timothy Prinzing

Fields Summary
private EventType
type
private URL
u
private String
desc
private Element
sourceElement
Constructors Summary
public HyperlinkEvent(Object source, EventType type, URL u)
Creates a new object representing a hypertext link event. The other constructor is preferred, as it provides more information if a URL could not be formed. This constructor is primarily for backward compatibility.

param
source the object responsible for the event
param
type the event type
param
u the affected URL

        this(source, type, u, null);
    
public HyperlinkEvent(Object source, EventType type, URL u, String desc)
Creates a new object representing a hypertext link event.

param
source the object responsible for the event
param
type the event type
param
u the affected URL. This may be null if a valid URL could not be created.
param
desc the description of the link. This may be useful when attempting to form a URL resulted in a MalformedURLException. The description provides the text used when attempting to form the URL.

        this(source, type, u, desc, null);
    
public HyperlinkEvent(Object source, EventType type, URL u, String desc, Element sourceElement)
Creates a new object representing a hypertext link event.

param
source the object responsible for the event
param
type the event type
param
u the affected URL. This may be null if a valid URL could not be created.
param
desc the description of the link. This may be useful when attempting to form a URL resulted in a MalformedURLException. The description provides the text used when attempting to form the URL.
param
sourceElement Element in the Document representing the anchor
since
1.4

        super(source);
	this.type = type;
	this.u = u;
	this.desc = desc;
        this.sourceElement = sourceElement;
    
Methods Summary
public java.lang.StringgetDescription()
Get the description of the link as a string. This may be useful if a URL can't be formed from the description, in which case the associated URL would be null.

	return desc;
    
public javax.swing.event.HyperlinkEvent$EventTypegetEventType()
Gets the type of event.

return
the type

	return type;
    
public javax.swing.text.ElementgetSourceElement()
Returns the Element that corresponds to the source of the event. This will typically be an Element representing an anchor. If a constructur that is used that does not specify a source Element, or null was specified as the source Element, this will return null.

return
Element indicating source of event, or null
since
1.4

	return sourceElement;
    
public java.net.URLgetURL()
Gets the URL that the link refers to.

return
the URL

	return u;