Home » openjdk-7 » javax » swing » event » [javadoc | source]
javax.swing.event
public class: HyperlinkEvent [javadoc | source]
java.lang.Object
   java.util.EventObject
      javax.swing.event.HyperlinkEvent

Direct Known Subclasses:
    HTMLFrameHyperlinkEvent, FormSubmitEvent

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 java.beans.XMLEncoder .

Nested Class Summary:
public static final class  HyperlinkEvent.EventType  Defines the ENTERED, EXITED, and ACTIVATED event types, along with their string representations, returned by toString(). 
Constructor:
 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.
    Parameters:
    source - the object responsible for the event
    type - the event type
    u - the affected URL
 public HyperlinkEvent(Object source,
    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,
    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
    since: 1.4 -
 public HyperlinkEvent(Object source,
    EventType type,
    URL u,
    String desc,
    Element sourceElement,
    InputEvent inputEvent) 
    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
    inputEvent - InputEvent that triggered the hyperlink event
    since: 1.7 -
Method from javax.swing.event.HyperlinkEvent Summary:
getDescription,   getEventType,   getInputEvent,   getSourceElement,   getURL
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.event.HyperlinkEvent Detail:
 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 EventType getEventType() 
    Gets the type of event.
 public InputEvent getInputEvent() 
    Returns the {@code InputEvent} that triggered the hyperlink event. This will typically be a {@code MouseEvent}. If a constructor is used that does not specify an {@code InputEvent}, or @{code null} was specified as the {@code InputEvent}, this returns {@code 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.
 public URL getURL() 
    Gets the URL that the link refers to.