Package com.google.gwt.user.client.ui
Class Anchor
java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.FocusWidget
com.google.gwt.user.client.ui.Anchor
- All Implemented Interfaces:
HasAllDragAndDropHandlers
,HasAllFocusHandlers
,HasAllGestureHandlers
,HasAllKeyHandlers
,HasAllMouseHandlers
,HasAllTouchHandlers
,HasBlurHandlers
,HasClickHandlers
,HasDoubleClickHandlers
,HasDragEndHandlers
,HasDragEnterHandlers
,HasDragHandlers
,HasDragLeaveHandlers
,HasDragOverHandlers
,HasDragStartHandlers
,HasDropHandlers
,HasFocusHandlers
,HasGestureChangeHandlers
,HasGestureEndHandlers
,HasGestureStartHandlers
,HasKeyDownHandlers
,HasKeyPressHandlers
,HasKeyUpHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasTouchCancelHandlers
,HasTouchEndHandlers
,HasTouchMoveHandlers
,HasTouchStartHandlers
,HasAttachHandlers
,HasHandlers
,HasDirection
,HasDirectionEstimator
,HasSafeHtml
,EventListener
,Focusable
,HasDirectionalSafeHtml
,HasDirectionalText
,HasEnabled
,HasFocus
,HasHorizontalAlignment
,HasHTML
,HasName
,HasText
,HasVisibility
,HasWordWrap
,IsWidget
,SourcesClickEvents
,SourcesFocusEvents
,SourcesKeyboardEvents
,SourcesMouseEvents
public class Anchor
extends FocusWidget
implements HasHorizontalAlignment, HasName, HasHTML, HasWordWrap, HasDirection, HasDirectionEstimator, HasDirectionalSafeHtml
A widget that represents a simple <a> element.
If you want use this anchor only for changing history states, use
Hyperlink
instead.
Built-in Bidi Text Support
This widget is capable of automatically adjusting its direction according to its content. This feature is controlled bysetDirectionEstimator(boolean)
or
passing a DirectionEstimator parameter to the constructor, and is off by
default.
CSS Style Rules
- .gwt-Anchor { }
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection
HasDirection.Direction
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment
HasHorizontalAlignment.AutoHorizontalAlignmentConstant, HasHorizontalAlignment.HorizontalAlignmentConstant
-
Field Summary
Fields inherited from class com.google.gwt.user.client.ui.Widget
eventsToSink
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR
Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment
ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT
-
Constructor Summary
ModifierConstructorDescriptionAnchor()
Creates an empty anchor.Anchor
(boolean useDefaultHref) Creates an anchor.protected
This constructor may be used by subclasses to explicitly use an existing element.Creates an anchor for scripting.Anchor
(SafeHtml html, HasDirection.Direction dir) Creates an anchor for scripting.Anchor
(SafeHtml html, HasDirection.Direction dir, SafeUri href) Creates an anchor with its html and href (target URL) specified.Anchor
(SafeHtml html, HasDirection.Direction dir, String href) Creates an anchor with its html and href (target URL) specified.Anchor
(SafeHtml html, DirectionEstimator directionEstimator) Creates an anchor for scripting.Anchor
(SafeHtml html, DirectionEstimator directionEstimator, SafeUri href) Creates an anchor with its html and href (target URL) specified.Anchor
(SafeHtml html, DirectionEstimator directionEstimator, String href) Creates an anchor with its html and href (target URL) specified.Creates an anchor with its html and href (target URL) specified.Creates a source anchor (link to URI).Creates an anchor with its html and href (target URL) specified.Creates a source anchor (link to URI).Creates an anchor for scripting.Creates an anchor for scripting.Creates an anchor with its text and href (target URL) specified.Creates a source anchor (link to URI).Anchor
(String text, HasDirection.Direction dir) Creates an anchor for scripting.Anchor
(String text, HasDirection.Direction dir, String href) Creates an anchor with its text and href (target URL) specified.Anchor
(String text, DirectionEstimator directionEstimator) Creates an anchor for scripting.Anchor
(String text, DirectionEstimator directionEstimator, String href) Creates an anchor with its text and href (target URL) specified.Creates an anchor with its text and href (target URL) specified.Creates a source anchor with a frame target. -
Method Summary
Modifier and TypeMethodDescriptionGets the directionality of the widget.Returns theDirectionEstimator
object.Gets the horizontal alignment.getHref()
Gets the anchor's href (the url to which it links).getHTML()
Gets this object's contents as HTML.getName()
Gets the widget's name.int
Gets the tab index.Gets the anchor's target frame (the frame in which navigation will occur when the link is selected).getText()
Gets this object's text.Gets the direction of this object's text.boolean
Gets whether word-wrapping is enabled.void
setAccessKey
(char key) Sets the widget's 'access key'.void
setDirection
(HasDirection.Direction direction) Deprecated.void
setDirectionEstimator
(boolean enabled) Toggles on / off direction estimation.void
setDirectionEstimator
(DirectionEstimator directionEstimator) Sets theDirectionEstimator
object.void
setFocus
(boolean focused) Explicitly focus/unfocus this widget.void
Sets the horizontal alignment.void
Sets the anchor's href (the url to which it links).void
Sets the anchor's href (the url to which it links).void
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
Sets this object's contents via HTML.void
Sets the widget's name.void
setTabIndex
(int index) Sets the widget's position in the tab index.void
Sets the anchor's target frame (the frame in which navigation will occur when the link is selected).void
Sets this object's text.void
setText
(String text, HasDirection.Direction dir) Sets this object's text, also declaring its direction.void
setWordWrap
(boolean wrap) Sets whether word-wrapping is enabled.static Anchor
Creates an Anchor widget that wraps an existing <a> element.Methods inherited from class com.google.gwt.user.client.ui.FocusWidget
addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setEnabled
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, replaceElement, setLayoutData, setParent, sinkEvents, unsinkEvents
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Field Details
-
DEFAULT_DIRECTION_ESTIMATOR
-
-
Constructor Details
-
Anchor
public Anchor()Creates an empty anchor.The anchor's href is not set, which means that the widget will not not be styled with the browser's native link styles (such as underline and font color). Use
Anchor(boolean)
to add a default no-op href that does not open a link but ensures the native link styles are applied.- See Also:
-
Anchor
public Anchor(boolean useDefaultHref) Creates an anchor. The anchor's href is optionally set tojavascript:;
, based on the expectation that listeners will be added to the anchor.- Parameters:
useDefaultHref
- true to set the default href tojavascript:;
, false to leave it blank
-
Anchor
Creates an anchor for scripting. The anchor's href is set tojavascript:;
, based on the expectation that listeners will be added to the anchor.- Parameters:
text
- the anchor's text
-
Anchor
Creates an anchor for scripting. The anchor's href is set tojavascript : ;
, based on the expectation that listeners will be added to the anchor.- Parameters:
text
- the anchor's textdir
- the text's direction
-
Anchor
Creates an anchor for scripting. The anchor's href is set tojavascript:;
, based on the expectation that listeners will be added to the anchor.- Parameters:
text
- the anchor's textasHtml
-true
to treat the specified text as html
-
Anchor
Creates an anchor with its text and href (target URL) specified.- Parameters:
text
- the anchor's texthref
- the url to which it will link
-
Anchor
Creates an anchor with its text and href (target URL) specified.- Parameters:
text
- the anchor's textdir
- the text's directionhref
- the url to which it will link
-
Anchor
Creates an anchor with its text and href (target URL) specified.- Parameters:
text
- the anchor's textasHTML
-true
to treat the specified text as htmlhref
- the url to which it will link
-
Anchor
Creates a source anchor with a frame target.- Parameters:
text
- the anchor's texthref
- the url to which it will linktarget
- the target frame (e.g. "_blank" to open the link in a new window)
-
Anchor
Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.- Parameters:
text
- the anchor's textasHtml
- asHTMLtrue
to treat the specified text as htmlhref
- the url to which it will linktarget
- the target frame (e.g. "_blank" to open the link in a new window)
-
Anchor
This constructor may be used by subclasses to explicitly use an existing element. This element must be an <a> element.- Parameters:
element
- the element to be used
-
-
Method Details
-
wrap
Creates an Anchor widget that wraps an existing <a> element. This element must already be attached to the document. If the element is removed from the document, you must callWidget.removeFromParent()
.- Parameters:
element
- the element to be wrapped
-
getDirection
Description copied from interface:HasDirection
Gets the directionality of the widget.- Specified by:
getDirection
in interfaceHasDirection
- Returns:
RTL
if the directionality is right-to-left,LTR
if the directionality is left-to-right, orDEFAULT
if the directionality is not explicitly specified
-
getDirectionEstimator
Description copied from interface:HasDirectionEstimator
Returns theDirectionEstimator
object.- Specified by:
getDirectionEstimator
in interfaceHasDirectionEstimator
-
getHorizontalAlignment
Description copied from interface:HasHorizontalAlignment
Gets the horizontal alignment.- Specified by:
getHorizontalAlignment
in interfaceHasHorizontalAlignment
- Returns:
- the current horizontal alignment (
HasHorizontalAlignment.ALIGN_LEFT
,HasHorizontalAlignment.ALIGN_CENTER
,HasHorizontalAlignment.ALIGN_RIGHT
,HasHorizontalAlignment.ALIGN_JUSTIFY
, or null).
-
getHref
Gets the anchor's href (the url to which it links).- Returns:
- the anchor's href
-
getHTML
Description copied from interface:HasHTML
Gets this object's contents as HTML. -
getName
Description copied from interface:HasName
Gets the widget's name. -
getTabIndex
public int getTabIndex()Description copied from class:FocusWidget
Gets the tab index.- Specified by:
getTabIndex
in interfaceFocusable
- Overrides:
getTabIndex
in classFocusWidget
- Returns:
- the tab index
-
getTarget
Gets the anchor's target frame (the frame in which navigation will occur when the link is selected).- Returns:
- the target frame
-
getText
Description copied from interface:HasText
Gets this object's text. -
getTextDirection
Description copied from interface:HasDirectionalText
Gets the direction of this object's text.- Specified by:
getTextDirection
in interfaceHasDirectionalText
- Returns:
- the direction of this object's text
-
getWordWrap
public boolean getWordWrap()Description copied from interface:HasWordWrap
Gets whether word-wrapping is enabled.- Specified by:
getWordWrap
in interfaceHasWordWrap
- Returns:
true
if word-wrapping is enabled.
-
setAccessKey
public void setAccessKey(char key) Description copied from interface:Focusable
Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.- Specified by:
setAccessKey
in interfaceFocusable
- Overrides:
setAccessKey
in classFocusWidget
- Parameters:
key
- the widget's access key
-
setDirection
Deprecated.UsesetDirectionEstimator(boolean)
and / or pass explicit direction tosetText(java.lang.String)
,setHTML(com.google.gwt.safehtml.shared.SafeHtml)
insteadDescription copied from interface:HasDirection
Sets the directionality for a widget.- Specified by:
setDirection
in interfaceHasDirection
- Parameters:
direction
-RTL
if the directionality should be set to right-to-left,LTR
if the directionality should be set to left-to-rightDEFAULT
if the directionality should not be explicitly set
-
setDirectionEstimator
public void setDirectionEstimator(boolean enabled) Toggles on / off direction estimation.See note at
setDirectionEstimator(DirectionEstimator)
.- Specified by:
setDirectionEstimator
in interfaceHasDirectionEstimator
- Parameters:
enabled
- Whether to enable direction estimation. Iftrue
, sets theDirectionEstimator
object to a defaultDirectionEstimator
.
-
setFocus
public void setFocus(boolean focused) Description copied from interface:Focusable
Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events. NOTE: Most browsers fire FocusEvents asynchronously. Especially within GWT tests, you'll need to make your test asynchronous to properly do verifications. SeeGWTTestCase#delayTestFinish
for more information on how to do this.- Specified by:
setFocus
in interfaceFocusable
- Overrides:
setFocus
in classFocusWidget
- Parameters:
focused
- whether this widget should take focus or release it
-
setHorizontalAlignment
Description copied from interface:HasHorizontalAlignment
Sets the horizontal alignment.Use
null
to clear horizontal alignment, allowing it to be determined by the standard HTML mechanisms such as inheritance and CSS rules.- Specified by:
setHorizontalAlignment
in interfaceHasHorizontalAlignment
- Parameters:
align
- the horizontal alignment (HasHorizontalAlignment.ALIGN_LEFT
,HasHorizontalAlignment.ALIGN_CENTER
,HasHorizontalAlignment.ALIGN_RIGHT
,HasHorizontalAlignment.ALIGN_JUSTIFY
,HasHorizontalAlignment.ALIGN_LOCALE_START
, orHasHorizontalAlignment.ALIGN_LOCALE_END
).
-
setHref
Sets the anchor's href (the url to which it links).- Parameters:
href
- the anchor's href
-
setHTML
Description copied from interface:HasHTML
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 usingHasText.setText(String)
whenever possible. -
setName
Description copied from interface:HasName
Sets the widget's name. -
setTabIndex
public void setTabIndex(int index) Description copied from interface:Focusable
Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to-1
will cause this widget to be removed from the tab order.- Specified by:
setTabIndex
in interfaceFocusable
- Overrides:
setTabIndex
in classFocusWidget
- Parameters:
index
- the widget's tab index
-
setTarget
Sets the anchor's target frame (the frame in which navigation will occur when the link is selected).- Parameters:
target
- the target frame
-
setText
Description copied from interface:HasText
Sets this object's text. -
setText
Description copied from interface:HasDirectionalText
Sets this object's text, also declaring its direction.- Specified by:
setText
in interfaceHasDirectionalText
- Parameters:
text
- the object's new textdir
- the text's direction
-
setWordWrap
public void setWordWrap(boolean wrap) Description copied from interface:HasWordWrap
Sets whether word-wrapping is enabled.- Specified by:
setWordWrap
in interfaceHasWordWrap
- Parameters:
wrap
-true
to enable word-wrapping.
-
setDirectionEstimator(boolean)
and / or pass explicit direction tosetText(java.lang.String)
,setHTML(com.google.gwt.safehtml.shared.SafeHtml)
instead