Eclipse Platform
Release 3.0

org.eclipse.ui.forms.events
Class HyperlinkEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byorg.eclipse.swt.internal.SWTEventObject
          extended byorg.eclipse.swt.events.TypedEvent
              extended byorg.eclipse.ui.forms.events.HyperlinkEvent
All Implemented Interfaces:
Serializable

public final class HyperlinkEvent
extends TypedEvent

Notifies listeners about a hyperlink change.

Since:
3.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.swt.events.TypedEvent
data, display, time, widget
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
HyperlinkEvent(Widget widget, Object href, String label, int modifier)
          Creates a new hyperlink
 
Method Summary
 Object getHref()
          The hyperlink reference that will be followed when the hyperlink is activated.
 String getLabel()
          The text of the hyperlink rendered in the source widget.
 int getStateMask()
          Returns the value of the keyboard state mask present when the event occured, or SWT.NULL for no modifiers.
 
Methods inherited from class org.eclipse.swt.events.TypedEvent
toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HyperlinkEvent

public HyperlinkEvent(Widget widget,
                      Object href,
                      String label,
                      int modifier)
Creates a new hyperlink

Parameters:
href - the hyperlink reference that will be followed upon when the hyperlink is activated.
label - the name of the hyperlink (the text that is rendered as a link in the source widget).
Method Detail

getHref

public Object getHref()
The hyperlink reference that will be followed when the hyperlink is activated.

Returns:
the hyperlink reference object

getLabel

public String getLabel()
The text of the hyperlink rendered in the source widget.

Returns:
the hyperlink label

getStateMask

public int getStateMask()
Returns the value of the keyboard state mask present when the event occured, or SWT.NULL for no modifiers.

Returns:
the keyboard state mask or SWT.NULL.

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.