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 JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	HyperlinkEvent.EventType Defines the ENTERED, EXITED, and ACTIVATED event types, along with their string representations, returned by toString().

Modifier and Type	Field and Description
private String	desc
private InputEvent	inputEvent
private Element	sourceElement
private HyperlinkEvent.EventType	type
private URL	u

Constructor Summary

Access	Constructor and Description
public	HyperlinkEvent(Object the object responsible for the event source, HyperlinkEvent.EventType the event type type, URL the affected URL u) Creates a new object representing a hypertext link event.
public	HyperlinkEvent(Object the object responsible for the event source, HyperlinkEvent.EventType the event type type, URL the affected URL. This may be null if a valid URL could not be created. u, String 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. desc) Creates a new object representing a hypertext link event.
public	HyperlinkEvent(Object the object responsible for the event source, HyperlinkEvent.EventType the event type type, URL the affected URL. This may be null if a valid URL could not be created. u, String 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. desc, Element Element in the Document representing the anchor sourceElement) Creates a new object representing a hypertext link event.
public	HyperlinkEvent(Object the object responsible for the event source, HyperlinkEvent.EventType the event type type, URL the affected URL. This may be null if a valid URL could not be created. u, String 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. desc, Element Element in the Document representing the anchor sourceElement, InputEvent InputEvent that triggered the hyperlink event inputEvent) Creates a new object representing a hypertext link event.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the description of this link as a `String` getDescription() Get the description of the link as a string.
public HyperlinkEvent.EventType	Returns: the type getEventType() Gets the type of event.
public InputEvent	Returns: InputEvent that triggered the hyperlink event, or null getInputEvent() Returns the `InputEvent` that triggered the hyperlink event.
public Element	Returns: Element indicating source of event, or null getSourceElement() Returns the `Element` that corresponds to the source of the event.
public URL	Returns: the URL getURL() Gets the URL that the link refers to.

Inherited from java.util.EventObject:: getSource toString

Field Detail

desc	back to summary
private String desc

inputEvent	back to summary
private InputEvent inputEvent

sourceElement	back to summary
private Element sourceElement

type	back to summary
private HyperlinkEvent.EventType type

u	back to summary
private URL u

Constructor Detail

HyperlinkEvent	back to summary
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:Object the object responsible for the event type:HyperlinkEvent.EventType the event type u:URL the affected URL

HyperlinkEvent

back to summary

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:Object: the object responsible for the event
type:HyperlinkEvent.EventType: the event type
u:URL: the affected URL

HyperlinkEvent	back to summary
public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc) Creates a new object representing a hypertext link event. Parameters source:Object the object responsible for the event type:HyperlinkEvent.EventType the event type u:URL the affected URL. This may be null if a valid URL could not be created. desc:String 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.

HyperlinkEvent

back to summary

public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc)

Creates a new object representing a hypertext link event.

Parameters

source:Object: the object responsible for the event
type:HyperlinkEvent.EventType: the event type
u:URL: the affected URL. This may be null if a valid URL could not be created.
desc:String: 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.

HyperlinkEvent	back to summary
public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc, Element sourceElement) Creates a new object representing a hypertext link event. Parameters source:Object the object responsible for the event type:HyperlinkEvent.EventType the event type u:URL the affected URL. This may be null if a valid URL could not be created. desc:String 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 Element in the Document representing the anchor Since 1.4

HyperlinkEvent

back to summary

public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc, Element sourceElement)

Creates a new object representing a hypertext link event.

Parameters

source:Object: the object responsible for the event
type:HyperlinkEvent.EventType: the event type
u:URL: the affected URL. This may be null if a valid URL could not be created.
desc:String: 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: Element in the Document representing the anchor

Since

1.4

HyperlinkEvent	back to summary
public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc, Element sourceElement, InputEvent inputEvent) Creates a new object representing a hypertext link event. Parameters source:Object the object responsible for the event type:HyperlinkEvent.EventType the event type u:URL the affected URL. This may be null if a valid URL could not be created. desc:String 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 Element in the Document representing the anchor inputEvent:InputEvent InputEvent that triggered the hyperlink event Since 1.7

HyperlinkEvent

back to summary

public HyperlinkEvent(Object source, HyperlinkEvent.EventType type, URL u, String desc, Element sourceElement, InputEvent inputEvent)

Creates a new object representing a hypertext link event.

Parameters

source:Object: the object responsible for the event
type:HyperlinkEvent.EventType: the event type
u:URL: the affected URL. This may be null if a valid URL could not be created.
desc:String: 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: Element in the Document representing the anchor
inputEvent:InputEvent: InputEvent that triggered the hyperlink event

Since

1.7

Method Detail

getDescription back to summary

getDescription	back to summary
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. Returns:String the description of this link as a `String`

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.

Returns:String: the description of this link as a String

getEventType	back to summary
public HyperlinkEvent.EventType getEventType() Gets the type of event. Returns:HyperlinkEvent.EventType the type

getEventType

back to summary

public HyperlinkEvent.EventType getEventType()

Gets the type of event.

Returns:HyperlinkEvent.EventType: the type

getInputEvent back to summary

getInputEvent	back to summary
public InputEvent getInputEvent() Returns the `InputEvent` that triggered the hyperlink event. This will typically be a `MouseEvent`. If a constructor is used that does not specify an `InputEvent`, or `null` was specified as the `InputEvent`, this returns `null`. Returns:InputEvent InputEvent that triggered the hyperlink event, or null Since 1.7

public InputEvent getInputEvent()

Returns the InputEvent that triggered the hyperlink event. This will typically be a MouseEvent. If a constructor is used that does not specify an InputEvent, or null was specified as the InputEvent, this returns null.

Returns:InputEvent: InputEvent that triggered the hyperlink event, or null
Since: 1.7

getSourceElement back to summary

getSourceElement	back to summary
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 constructor that is used that does not specify a source `Element`, or null was specified as the source `Element`, this will return null. Returns:Element Element indicating source of event, or null Since 1.4

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 constructor that is used that does not specify a source Element, or null was specified as the source Element, this will return null.

Returns:Element: Element indicating source of event, or null
Since: 1.4

getURL	back to summary
public URL getURL() Gets the URL that the link refers to. Returns:URL the URL

getURL

back to summary

public URL getURL()

Gets the URL that the link refers to.

Returns:URL: the URL

javax.swing.event back to summary

public final Class HyperlinkEvent.EventType

Class Inheritance

extends Object

java.lang.Object
javax.swing.event.HyperlinkEvent.EventType

Defines the ENTERED, EXITED, and ACTIVATED event types, along with their string representations, returned by toString().

Field Summary

Modifier and Type	Field and Description
public static final HyperlinkEvent.EventType	ACTIVATED Activated type.
public static final HyperlinkEvent.EventType	ENTERED Entered type.
public static final HyperlinkEvent.EventType	EXITED Exited type.
private String	typeString

Constructor Summary

Access	Constructor and Description
private	EventType(String s)

Method Summary

Modifier and Type	Method and Description
public String	Returns: the string toString() Overrides java.lang.Object.toString. Converts the type to a string.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ACTIVATED	back to summary
public static final HyperlinkEvent.EventType ACTIVATED Activated type.

ENTERED	back to summary
public static final HyperlinkEvent.EventType ENTERED Entered type.

EXITED	back to summary
public static final HyperlinkEvent.EventType EXITED Exited type.

typeString	back to summary
private String typeString

Constructor Detail

EventType	back to summary
private EventType(String s)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Converts the type to a string. Returns:String the string

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Converts the type to a string.

Returns:String: the string

public Class HyperlinkEvent

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class HyperlinkEvent.EventType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail