public class

Hyperlink

extends Widget
implements HasClickHandlers HasDirectionEstimator HasDirectionalSafeHtml HasHTML SourcesClickEvents

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Hyperlink

Known Direct Subclasses

InlineHyperlink

Class Overview

A widget that serves as an "internal" hyperlink. That is, it is a link to another state of the running application. When clicked, it will create a new history frame using newItem(String), but without reloading the page.

If you want an HTML hyperlink (<a> tag) without interacting with the history system, use Anchor instead.

Being a true hyperlink, it is also possible for the user to "right-click, open link in new window", which will cause the application to be loaded in a new window at the state specified by the hyperlink.

Built-in Bidi Text Support

This widget is capable of automatically adjusting its direction according to its content. This feature is controlled by setDirectionEstimator(boolean) or passing a DirectionEstimator parameter to the constructor, and is off by default.

CSS Style Rules

.gwt-Hyperlink { }

Example

{@example com.google.gwt.examples.HistoryExample}

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Fields
public static final DirectionEstimator	DEFAULT_DIRECTION_ESTIMATOR
protected final DirectionalTextHelper	directionalTextHelper

Public Constructors
	Hyperlink() Creates an empty hyperlink.
	Hyperlink(SafeHtml html, String targetHistoryToken) Creates a hyperlink with its html and target history token specified.
	Hyperlink(SafeHtml html, HasDirection.Direction dir, String targetHistoryToken) Creates a hyperlink with its html and target history token specified.
	Hyperlink(SafeHtml html, DirectionEstimator directionEstimator, String targetHistoryToken) Creates a hyperlink with its html and target history token specified.
	Hyperlink(String text, String targetHistoryToken) Creates a hyperlink with its text and target history token specified.
	Hyperlink(String text, HasDirection.Direction dir, String targetHistoryToken) Creates a hyperlink with its text and target history token specified.
	Hyperlink(String text, DirectionEstimator directionEstimator, String targetHistoryToken) Creates a hyperlink with its text and target history token specified.
	Hyperlink(String text, boolean asHTML, String targetHistoryToken) Creates a hyperlink with its text and target history token specified.

Protected Constructors
	Hyperlink(Element elem)

Public Methods
HandlerRegistration	addClickHandler(ClickHandler handler) This method is deprecated. Use `addClickHandler(ClickHandler)` instead and call History.newItem from the handler if you need to process the click before the history token is set.
void	addClickListener(ClickListener listener) This method is deprecated. Use `addClickHandler(ClickHandler)` instead and call History.newItem from the handler if you need to process the click before the history token is set.
DirectionEstimator	getDirectionEstimator() Returns the `DirectionEstimator` object.
String	getHTML() Gets this object's contents as HTML.
String	getTargetHistoryToken() Gets the history token referenced by this hyperlink.
String	getText() Gets this object's text.
HasDirection.Direction	getTextDirection() Gets the direction of this object's text.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	removeClickListener(ClickListener listener) This method is deprecated. Use the `removeHandler()` method on the object returned by an addHandler method instead*
void	setDirectionEstimator(DirectionEstimator directionEstimator) Sets the `DirectionEstimator` object. Note: DirectionEstimator should be set before the widget has any content; it's highly recommended to set it using a constructor.
void	setDirectionEstimator(boolean enabled) Toggles on / off direction estimation. See note at `setDirectionEstimator(DirectionEstimator)`.
void	setHTML(SafeHtml html) Sets this object's contents via known-safe HTML.
void	setHTML(SafeHtml html, HasDirection.Direction dir) Sets this object's html, also declaring its direction.
void	setHTML(String html) Sets this object's contents via HTML.
void	setTargetHistoryToken(String targetHistoryToken) Sets the history token referenced by this hyperlink.
void	setText(String text, HasDirection.Direction dir) Sets this object's text, also declaring its direction.
void	setText(String text) Sets this object's text.

Protected Methods
void	onEnsureDebugId(String baseID) Affected Elements: -wrapper = the div around the link.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.dom.client.HasClickHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.i18n.shared.HasDirectionEstimator

From interface com.google.gwt.safehtml.client.HasSafeHtml

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasDirectionalSafeHtml

From interface com.google.gwt.user.client.ui.HasDirectionalText

From interface com.google.gwt.user.client.ui.HasHTML

From interface com.google.gwt.user.client.ui.HasText

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.SourcesClickEvents

Fields

public static final DirectionEstimator DEFAULT_DIRECTION_ESTIMATOR

protected final DirectionalTextHelper directionalTextHelper

Public Constructors

public Hyperlink ()

Creates an empty hyperlink.

public Hyperlink (SafeHtml html, String targetHistoryToken)

Creates a hyperlink with its html and target history token specified.

Parameters

html	the hyperlink's safe html
targetHistoryToken	the history token to which it will link

public Hyperlink (SafeHtml html, HasDirection.Direction dir, String targetHistoryToken)

Creates a hyperlink with its html and target history token specified.

Parameters

html	the hyperlink's safe html
dir	the html's direction
targetHistoryToken	the history token to which it will link

public Hyperlink (SafeHtml html, DirectionEstimator directionEstimator, String targetHistoryToken)

Creates a hyperlink with its html and target history token specified.

Parameters

html	the hyperlink's safe html
directionEstimator	A DirectionEstimator object used for automatic direction adjustment. For convenience, `DEFAULT_DIRECTION_ESTIMATOR` can be used.
targetHistoryToken	the history token to which it will link

public Hyperlink (String text, String targetHistoryToken)

Creates a hyperlink with its text and target history token specified.

Parameters

text	the hyperlink's text
targetHistoryToken	the history token to which it will link, which may not be null (use `Anchor` instead if you don't need history processing)

public Hyperlink (String text, HasDirection.Direction dir, String targetHistoryToken)

Creates a hyperlink with its text and target history token specified.

Parameters

text	the hyperlink's text
dir	the text's direction
targetHistoryToken	the history token to which it will link, which may not be null (use `Anchor` instead if you don't need history processing)

public Hyperlink (String text, DirectionEstimator directionEstimator, String targetHistoryToken)

Creates a hyperlink with its text and target history token specified.

Parameters

text	the hyperlink's text
directionEstimator	A DirectionEstimator object used for automatic direction adjustment. For convenience, `DEFAULT_DIRECTION_ESTIMATOR` can be used.
targetHistoryToken	the history token to which it will link, which may not be null (use `Anchor` instead if you don't need history processing)

public Hyperlink (String text, boolean asHTML, String targetHistoryToken)

Creates a hyperlink with its text and target history token specified.

Parameters

text	the hyperlink's text
asHTML	`true` to treat the specified text as html
targetHistoryToken	the history token to which it will link

Protected Constructors

protected Hyperlink (Element elem)

Public Methods

public HandlerRegistration addClickHandler (ClickHandler handler)

This method is deprecated.
Use addClickHandler(ClickHandler) instead and call History.newItem from the handler if you need to process the click before the history token is set.

Adds a ClickEvent handler.

Parameters

handler	the click handler

Returns

HandlerRegistration used to remove this handler

public void addClickListener (ClickListener listener)

This method is deprecated.
Use addClickHandler(ClickHandler) instead and call History.newItem from the handler if you need to process the click before the history token is set.

Adds a listener interface to receive click events.

Parameters

listener	the listener interface to add

public DirectionEstimator getDirectionEstimator ()

Returns the DirectionEstimator object.

public String getHTML ()

Gets this object's contents as HTML.

Returns

the object's HTML

public String getTargetHistoryToken ()

Gets the history token referenced by this hyperlink.

Returns

the target history token

public String getText ()

Gets this object's text.

Returns

the object's text

public HasDirection.Direction getTextDirection ()

Gets the direction of this object's text.

Returns

the direction of this object's text

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

public void removeClickListener (ClickListener listener)

This method is deprecated.
Use the removeHandler() method on the object returned by an add*Handler method instead

Removes a previously added listener interface.

Parameters

listener	the listener interface to remove

public void setDirectionEstimator (DirectionEstimator directionEstimator)

Sets the DirectionEstimator object.

Note: DirectionEstimator should be set before the widget has any content; it's highly recommended to set it using a constructor. Reason: if the widget already has non-empty content, this will update its direction according to the new estimator's result. This may cause flicker, and thus should be avoided.

Parameters

directionEstimator	The {code DirectionEstimator} to be set. `null` means turning off direction estimation.

public void setDirectionEstimator (boolean enabled)

Toggles on / off direction estimation.

See note at setDirectionEstimator(DirectionEstimator).

Parameters

enabled	Whether to enable direction estimation. If `true`, sets the `DirectionEstimator` object to a default `DirectionEstimator`.

public void setHTML (SafeHtml html)

Sets this object's contents via known-safe HTML.

The object will behave exactly the same as when a widget's setHTML(String) method is invoked; however the SafeHtml passed to this method observes the contract that it can be used in an HTML context without causing unsafe script execution. Thus, unlike setHTML(String), using this method cannot result in Cross-Site Scripting security vulnerabilities.

Parameters

html	the object's new HTML, represented as a `SafeHtml` object

public void setHTML (SafeHtml html, HasDirection.Direction dir)

Sets this object's html, also declaring its direction.

Parameters

html	the object's new html
dir	the html's direction

public void setHTML (String html)

Sets this object's contents via HTML. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using setText(String) whenever possible.

Parameters

html	the object's new HTML

public void setTargetHistoryToken (String targetHistoryToken)

Sets the history token referenced by this hyperlink. This is the history token that will be passed to newItem(String) when this link is clicked.

Parameters

targetHistoryToken	the new history token, which may not be null (use `Anchor` instead if you don't need history processing)

public void setText (String text, HasDirection.Direction dir)

Sets this object's text, also declaring its direction.

Parameters

text	the object's new text
dir	the text's direction

public void setText (String text)

Sets this object's text.

Parameters

text	the object's new text

Protected Methods

protected void onEnsureDebugId (String baseID)

Affected Elements:

-wrapper = the div around the link.

Parameters

baseID	the base ID used by the main element

Interfaces

Classes

Annotations

Enums

Exceptions

Hyperlink

Class Overview

Built-in Bidi Text Support

CSS Style Rules

Example

See Also

Summary

Fields

public static final DirectionEstimator DEFAULT_DIRECTION_ESTIMATOR

protected final DirectionalTextHelper directionalTextHelper

Public Constructors

public Hyperlink ()

public Hyperlink (SafeHtml html, String targetHistoryToken)

Parameters

See Also

public Hyperlink (SafeHtml html, HasDirection.Direction dir, String targetHistoryToken)

Parameters

See Also

public Hyperlink (SafeHtml html, DirectionEstimator directionEstimator, String targetHistoryToken)

Parameters

See Also

public Hyperlink (String text, String targetHistoryToken)

Parameters

public Hyperlink (String text, HasDirection.Direction dir, String targetHistoryToken)

Parameters

public Hyperlink (String text, DirectionEstimator directionEstimator, String targetHistoryToken)

Parameters

public Hyperlink (String text, boolean asHTML, String targetHistoryToken)

Parameters

See Also

Protected Constructors

protected Hyperlink (Element elem)

Public Methods

public HandlerRegistration addClickHandler (ClickHandler handler)

Parameters

Returns

public void addClickListener (ClickListener listener)

Parameters

public DirectionEstimator getDirectionEstimator ()

public String getHTML ()

Returns

public String getTargetHistoryToken ()

Returns

See Also

public String getText ()

Returns

public HasDirection.Direction getTextDirection ()

Returns

public void onBrowserEvent (Event event)

Parameters

public void removeClickListener (ClickListener listener)

Parameters

public void setDirectionEstimator (DirectionEstimator directionEstimator)

Parameters

public void setDirectionEstimator (boolean enabled)

Parameters

public void setHTML (SafeHtml html)

Parameters

public void setHTML (SafeHtml html, HasDirection.Direction dir)

Parameters

public void setHTML (String html)

Parameters

public void setTargetHistoryToken (String targetHistoryToken)

Parameters

public void setText (String text, HasDirection.Direction dir)

Parameters

public void setText (String text)

Parameters

Protected Methods

protected void onEnsureDebugId (String baseID)

Parameters

See Also