| java.lang.Object | ||
| ↳ | java.util.EventObject | |
| ↳ | javax.swing.event.HyperlinkEvent | |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
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 XMLEncoder.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| HyperlinkEvent.EventType | Defines the ENTERED, EXITED, and ACTIVATED event types, along with their string representations, returned by toString(). | ||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.util.EventObject
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new object representing a hypertext link event.
| |||||||||||
Creates a new object representing a hypertext link event.
| |||||||||||
Creates a new object representing a hypertext link event.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Get the description of the link as a string.
| |||||||||||
Gets the type of event.
| |||||||||||
Returns the
Element that corresponds to the source of the
event. | |||||||||||
Gets the URL that the link refers to.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.util.EventObject
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public HyperlinkEvent (Object source, HyperlinkEvent.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.
Parameters
| source | the object responsible for the event |
|---|---|
| type | the event type |
| u | the affected URL |
public HyperlinkEvent (Object source, HyperlinkEvent.EventType type, URL u, String desc)
Creates a new object representing a hypertext link event.
Parameters
| source | the object responsible for the event |
|---|---|
| type | the event type |
| u | the affected URL. This may be null if a valid URL could not be created. |
| 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. |
public HyperlinkEvent (Object source, HyperlinkEvent.EventType type, URL u, String desc, Element sourceElement)
Creates a new object representing a hypertext link event.
Parameters
| source | the object responsible for the event |
|---|---|
| type | the event type |
| u | the affected URL. This may be null if a valid URL could not be created. |
| 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. |
| sourceElement | Element in the Document representing the anchor |
Public Methods
public String getDescription ()
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.
public Element getSourceElement ()
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.
Returns
- Element indicating source of event, or null