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 by setDirectionEstimator(boolean) or passing a DirectionEstimator parameter to the constructor, and is off by default.

CSS Style Rules

• .gwt-Anchor { }

See Also:

Hyperlink

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.user.client.ui.HasHorizontalAlignment

HasHorizontalAlignment.AutoHorizontalAlignmentConstant, HasHorizontalAlignment.HorizontalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

HasDirection.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static DirectionEstimator	DEFAULT_DIRECTION_ESTIMATOR

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

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

Constructors

Modifier	Constructor and Description
	Anchor() Creates an empty anchor.
	Anchor(boolean useDefaultHref) Creates an anchor.
protected	Anchor(Element element) This constructor may be used by subclasses to explicitly use an existing element.
	Anchor(SafeHtml html) Creates an anchor for scripting.
	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.
	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, SafeUri href) Creates an anchor with its html and href (target URL) specified.
	Anchor(SafeHtml html, SafeUri href, String target) Creates a source anchor (link to URI).
	Anchor(SafeHtml html, String href) Creates an anchor with its html and href (target URL) specified.
	Anchor(SafeHtml html, String href, String target) Creates a source anchor (link to URI).
	Anchor(String text) Creates an anchor for scripting.
	Anchor(String text, boolean asHtml) Creates an anchor for scripting.
	Anchor(String text, boolean asHTML, String href) Creates an anchor with its text and href (target URL) specified.
	Anchor(String text, boolean asHtml, String href, String target) Creates a source anchor (link to URI).
	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.
	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, String href) Creates an anchor with its text and href (target URL) specified.
	Anchor(String text, String href, String target) Creates a source anchor with a frame target.

Method Summary

Modifier and Type	Method and Description
HasDirection.Direction	getDirection() Gets the directionality of the widget.
DirectionEstimator	getDirectionEstimator() Returns the DirectionEstimator object.
HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() Gets the horizontal alignment.
String	getHref() Gets the anchor's href (the url to which it links).
String	getHTML() Gets this object's contents as HTML.
String	getName() Gets the widget's name.
int	getTabIndex() Gets the tab index.
String	getTarget() Gets the anchor's target frame (the frame in which navigation will occur when the link is selected).
String	getText() Gets this object's text.
HasDirection.Direction	getTextDirection() Gets the direction of this object's text.
boolean	getWordWrap() Gets whether word-wrapping is enabled.
void	setAccessKey(char key) Sets the widget's 'access key'.
void	setDirection(HasDirection.Direction direction) Deprecated. Use setDirectionEstimator(boolean) and / or pass explicit direction to setText(java.lang.String), setHTML(com.google.gwt.safehtml.shared.SafeHtml) instead
void	setDirectionEstimator(boolean enabled) Toggles on / off direction estimation.
void	setDirectionEstimator(DirectionEstimator directionEstimator) Sets the DirectionEstimator object.
void	setFocus(boolean focused) Explicitly focus/unfocus this widget.
void	setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant align) Sets the horizontal alignment.
void	setHref(SafeUri href) Sets the anchor's href (the url to which it links).
void	setHref(String href) Sets the anchor's href (the url to which it links).
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	setName(String name) Sets the widget's name.
void	setTabIndex(int index) Sets the widget's position in the tab index.
void	setTarget(String target) Sets the anchor's target frame (the frame in which navigation will occur when the link is selected).
void	setText(String text) 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	wrap(Element element) 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, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, 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

equals, finalize, getClass, hashCode

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

DEFAULT_DIRECTION_ESTIMATOR

public static final DirectionEstimator DEFAULT_DIRECTION_ESTIMATOR

Constructor Detail

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(boolean)

Anchor

public Anchor(boolean useDefaultHref)

Creates an anchor. The anchor's href is optionally set to javascript:;, based on the expectation that listeners will be added to the anchor.

Parameters:

useDefaultHref - true to set the default href to javascript:;, false to leave it blank

Anchor

public Anchor(SafeHtml html)

Creates an anchor for scripting.

Parameters:

html - the anchor's html

Anchor

public Anchor(SafeHtml html,
              HasDirection.Direction dir)

Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.

Parameters:

html - the anchor's html

dir - the html's direction

Anchor

public Anchor(SafeHtml html,
              DirectionEstimator directionEstimator)

Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.

Parameters:

html - the anchor's html

directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.

Anchor

public Anchor(String text)

Creates an anchor for scripting. The anchor's href is set to javascript:;, based on the expectation that listeners will be added to the anchor.

Parameters:

text - the anchor's text

Anchor

public Anchor(String text,
              HasDirection.Direction dir)

Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.

Parameters:

text - the anchor's text

dir - the text's direction

Anchor

public Anchor(String text,
              DirectionEstimator directionEstimator)

Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.

Parameters:

text - the anchor's text

directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.

Anchor

public Anchor(String text,
              boolean asHtml)

Creates an anchor for scripting. The anchor's href is set to javascript:;, based on the expectation that listeners will be added to the anchor.

Parameters:

text - the anchor's text

asHtml - true to treat the specified text as html

Anchor

public Anchor(SafeHtml html,
              String href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              SafeUri href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              HasDirection.Direction dir,
              String href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

dir - the html's direction

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              HasDirection.Direction dir,
              SafeUri href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

dir - the html's direction

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              DirectionEstimator directionEstimator,
              String href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              DirectionEstimator directionEstimator,
              SafeUri href)

Creates an anchor with its html and href (target URL) specified.

Parameters:

html - the anchor's html

directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.

href - the url to which it will link

Anchor

public Anchor(String text,
              String href)

Creates an anchor with its text and href (target URL) specified.

Parameters:

text - the anchor's text

href - the url to which it will link

Anchor

public Anchor(String text,
              HasDirection.Direction dir,
              String href)

Creates an anchor with its text and href (target URL) specified.

Parameters:

text - the anchor's text

dir - the text's direction

href - the url to which it will link

Anchor

public Anchor(String text,
              DirectionEstimator directionEstimator,
              String href)

Creates an anchor with its text and href (target URL) specified.

Parameters:

text - the anchor's text

directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.

href - the url to which it will link

Anchor

public Anchor(String text,
              boolean asHTML,
              String href)

Creates an anchor with its text and href (target URL) specified.

Parameters:

text - the anchor's text

asHTML - true to treat the specified text as html

href - the url to which it will link

Anchor

public Anchor(SafeHtml html,
              String href,
              String target)

Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.

Parameters:

html - the anchor's html

href - the url to which it will link

target - the target frame (e.g. "_blank" to open the link in a new window)

Anchor

public Anchor(SafeHtml html,
              SafeUri href,
              String target)

Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.

Parameters:

html - the anchor's html

href - the url to which it will link

target - the target frame (e.g. "_blank" to open the link in a new window)

Anchor

public Anchor(String text,
              String href,
              String target)

Creates a source anchor with a frame target.

Parameters:

text - the anchor's text

href - the url to which it will link

target - the target frame (e.g. "_blank" to open the link in a new window)

Anchor

public Anchor(String text,
              boolean asHtml,
              String href,
              String target)

Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.

Parameters:

text - the anchor's text

asHtml - asHTML true to treat the specified text as html

href - the url to which it will link

target - the target frame (e.g. "_blank" to open the link in a new window)

Anchor

protected Anchor(Element element)

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 Detail

wrap

public static Anchor wrap(Element element)

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 call RootPanel.detachNow(Widget).

Parameters:

element - the element to be wrapped

getDirection

public HasDirection.Direction getDirection()

Description copied from interface: HasDirection

Gets the directionality of the widget.

Specified by:

getDirection in interface HasDirection

Returns:

RTL if the directionality is right-to-left, LTR if the directionality is left-to-right, or DEFAULT if the directionality is not explicitly specified

getDirectionEstimator

public DirectionEstimator getDirectionEstimator()

Description copied from interface: HasDirectionEstimator

Returns the DirectionEstimator object.

Specified by:

getDirectionEstimator in interface HasDirectionEstimator

getHorizontalAlignment

public HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()

Description copied from interface: HasHorizontalAlignment

Gets the horizontal alignment.

Specified by:

getHorizontalAlignment in interface HasHorizontalAlignment

Returns:

the current horizontal alignment ( HasHorizontalAlignment.ALIGN_LEFT, HasHorizontalAlignment.ALIGN_CENTER, HasHorizontalAlignment.ALIGN_RIGHT, HasHorizontalAlignment.ALIGN_JUSTIFY, or null).

getHref

public String getHref()

Gets the anchor's href (the url to which it links).

Returns:

the anchor's href

getHTML

public String getHTML()

Description copied from interface: HasHTML

Gets this object's contents as HTML.

Specified by:

getHTML in interface HasHTML

Returns:

the object's HTML

getName

public String getName()

Description copied from interface: HasName

Gets the widget's name.

Specified by:

getName in interface HasName

Returns:

the widget's name

getTabIndex

public int getTabIndex()

Description copied from class: FocusWidget

Gets the tab index.

Specified by:

getTabIndex in interface Focusable

Overrides:

getTabIndex in class FocusWidget

Returns:

the tab index

getTarget

public String getTarget()

Gets the anchor's target frame (the frame in which navigation will occur when the link is selected).

Returns:

the target frame

getText

public String getText()

Description copied from interface: HasText

Gets this object's text.

Specified by:

getText in interface HasText

Returns:

the object's text

getTextDirection

public HasDirection.Direction getTextDirection()

Description copied from interface: HasDirectionalText

Gets the direction of this object's text.

Specified by:

getTextDirection in interface HasDirectionalText

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 interface HasWordWrap

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 interface Focusable

Overrides:

setAccessKey in class FocusWidget

Parameters:

key - the widget's access key

setDirection

@Deprecated
public void setDirection(HasDirection.Direction direction)

Deprecated. Use setDirectionEstimator(boolean) and / or pass explicit direction to setText(java.lang.String), setHTML(com.google.gwt.safehtml.shared.SafeHtml) instead

Description copied from interface: HasDirection

Sets the directionality for a widget.

Specified by:

setDirection in interface HasDirection

Parameters:

direction - RTL if the directionality should be set to right-to-left, LTR if the directionality should be set to left-to-right DEFAULT 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 interface HasDirectionEstimator

Parameters:

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

setDirectionEstimator

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.

Specified by:

setDirectionEstimator in interface HasDirectionEstimator

Parameters:

directionEstimator - The DirectionEstimator to be set. null means turning off direction estimation.

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.

Specified by:

setFocus in interface Focusable

Overrides:

setFocus in class FocusWidget

Parameters:

focused - whether this widget should take focus or release it

setHorizontalAlignment

public void setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant align)

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 interface HasHorizontalAlignment

Parameters:

align - the horizontal alignment ( HasHorizontalAlignment.ALIGN_LEFT, HasHorizontalAlignment.ALIGN_CENTER, HasHorizontalAlignment.ALIGN_RIGHT, HasHorizontalAlignment.ALIGN_JUSTIFY, HasHorizontalAlignment.ALIGN_LOCALE_START, or HasHorizontalAlignment.ALIGN_LOCALE_END).

setHref

public void setHref(SafeUri href)

Sets the anchor's href (the url to which it links).

Parameters:

href - the anchor's href

setHref

public void setHref(String href)

Sets the anchor's href (the url to which it links).

Parameters:

href - the anchor's href

setHTML

public void setHTML(SafeHtml html)

Description copied from interface: HasSafeHtml

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

The object will behave exactly the same as when a widget's HasHTML.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 HasHTML.setHTML(String), using this method cannot result in Cross-Site Scripting security vulnerabilities.

Specified by:

setHTML in interface HasSafeHtml

Parameters:

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

setHTML

public void setHTML(String html)

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 using HasText.setText(String) whenever possible.

Specified by:

setHTML in interface HasHTML

Parameters:

html - the object's new HTML

setHTML

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

Description copied from interface: HasDirectionalSafeHtml

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

Specified by:

setHTML in interface HasDirectionalSafeHtml

Parameters:

html - the object's new html

dir - the html's direction

setName

public void setName(String name)

Description copied from interface: HasName

Sets the widget's name.

Specified by:

setName in interface HasName

Parameters:

name - the widget's new 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 interface Focusable

Overrides:

setTabIndex in class FocusWidget

Parameters:

index - the widget's tab index

setTarget

public void setTarget(String target)

Sets the anchor's target frame (the frame in which navigation will occur when the link is selected).

Parameters:

target - the target frame

setText

public void setText(String text)

Description copied from interface: HasText

Sets this object's text.

Specified by:

setText in interface HasText

Parameters:

text - the object's new text

setText

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

Description copied from interface: HasDirectionalText

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

Specified by:

setText in interface HasDirectionalText

Parameters:

text - the object's new text

dir - 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 interface HasWordWrap

Parameters:

wrap - true to enable word-wrapping.