Package eu.webtoolkit.jwt

Class WAnchor

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WWidget

eu.webtoolkit.jwt.WWebWidget

eu.webtoolkit.jwt.WInteractWidget

eu.webtoolkit.jwt.WContainerWidget

eu.webtoolkit.jwt.WAnchor

Direct Known Subclasses:

IndexAnchor

public class WAnchor
extends WContainerWidget

A widget that represents an HTML anchor (to link to other documents).

Use an anchor to link to another web page, document, internal application path or a resource (which specifies application-dependent content that may be generated by your application on demand). The anchor may contain a label text, an image, or any other widget (as it inherits from WContainerWidget).

If you link to a document or external url, and do not want the application to terminate when the user follows the anchor, you must use link.setTarget(LinkTarget::NewWindow). Even for non-HTML documents, this may be important since pending Ajax requests are cancelled if documents are not served within the browser window in certain browsers.

WAnchor is an inline widget.

CSS

The widget corresponds to the HTML <a> tag and does not provide styling. It can be styled using inline or external CSS as appropriate.

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Field Summary

Fields inherited from class eu.webtoolkit.jwt.WInteractWidget

dragTouchEndSlot_, dragTouchSlot_

Constructor Summary

Constructors

Constructor	Description
WAnchor()	Creates an anchor.
WAnchor(WContainerWidget parentContainer)	Creates an anchor.
WAnchor(WLink link)	Creates an anchor for the given link.
WAnchor(WLink link, WContainerWidget parentContainer)	Creates an anchor for the given link.
WAnchor(WLink link, WImage image)	Creates an anchor for the given link with an image.
WAnchor(WLink link, WImage image, WContainerWidget parentContainer)	Creates an anchor for the given link with an image.
WAnchor(WLink link, CharSequence text)	Creates an anchor for the given link with a text.
WAnchor(WLink link, CharSequence text, WContainerWidget parentContainer)	Creates an anchor for the given link with a text.

Method Summary

Modifier and Type	Method	Description
protected void	enableAjax()	Progresses to an Ajax-enabled widget.
WImage	getImage()	Returns the image.
WLink	getLink()	Returns the link.
int	getTabIndex()	Returns the tab index.
WString	getText()	Returns the label text.
TextFormat	getTextFormat()	Returns the text format.
boolean	hasWordWrap()	Returns whether the widget may break lines.
boolean	isCanReceiveFocus()	Returns whether the widget can receive focus.
boolean	isSetFirstFocus()	Set focus on the widget's first descendant.
protected void	propagateSetEnabled(boolean enabled)	Propagates that a widget was enabled or disabled through children.
void	setImage(WImage image)	Sets an image.
void	setLink(WLink link)	Sets the link.
void	setText(CharSequence text)	Sets the label text.
void	setTextFormat(TextFormat textFormat)	Configures the text format.
void	setWordWrap(boolean wordWrap)	Configures text word wrapping.

Methods inherited from class eu.webtoolkit.jwt.WContainerWidget

addWidget, clear, createDomElement, getContentAlignment, getCount, getDomChanges, getIndexOf, getLayout, getPadding, getScrollLeft, getScrollTop, getWidget, insertBefore, insertWidget, isGlobalUnfocussed, isList, isOrderedList, isUnorderedList, iterateChildren, parentResized, remove, removeWidget, scrolled, setContentAlignment, setContentAlignment, setFormData, setGlobalUnfocused, setLayout, setList, setList, setOverflow, setOverflow, setOverflow, setPadding, setPadding, setPadding

Methods inherited from class eu.webtoolkit.jwt.WInteractWidget

clicked, doubleClicked, enterPressed, escapePressed, gestureChanged, gestureEnded, gestureStarted, getMouseOverDelay, isEnabled, keyPressed, keyWentDown, keyWentUp, load, mouseDragged, mouseMoved, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, mouseWheel, setDraggable, setDraggable, setDraggable, setDraggable, setMouseOverDelay, setPopup, touchEnded, touchMoved, touchStarted, unsetDraggable

Methods inherited from class eu.webtoolkit.jwt.WWebWidget

addStyleClass, beingDeleted, blurred, callJavaScriptMember, childrenChanged, doJavaScript, escapeText, escapeText, escapeText, escapeText, find, findById, focussed, getAttributeValue, getBaseZIndex, getChildren, getClearSides, getDecorationStyle, getFloatSide, getHeight, getHtmlTagName, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isScrollVisibilityEnabled, isScrollVisible, isThemeStyleEnabled, isVisible, jsStringLiteral, jsStringLiteral, manageWidget, parentResized, propagateSetVisible, refresh, removeScript, removeStyleClass, render, resize, scrollVisibilityChanged, setAttributeValue, setBaseZIndex, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFlexBox, setFloatSide, setFocus, setHidden, setHiddenKeepsGeometry, setHtmlTagName, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setObjectName, setOffsets, setParentWidget, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setToolTip, setVerticalAlignment, unescapeText, updateSignalConnection, voidEventSignal, widgetAdded, widgetRemoved

Methods inherited from class eu.webtoolkit.jwt.WWidget

acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, boxBorder, boxPadding, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isGlobalWidget, isLayoutSizeAware, layoutSizeChanged, needsRerender, positionAt, positionAt, removeFromParent, removeStyleClass, render, resize, scheduleRender, scheduleRender, scheduleRender, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr

Methods inherited from class eu.webtoolkit.jwt.WObject

getObjectName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WAnchor

public WAnchor(WContainerWidget parentContainer)

Creates an anchor.

WAnchor

public WAnchor()

Creates an anchor.

Calls this((WContainerWidget)null)

WAnchor

public WAnchor(WLink link,
 WContainerWidget parentContainer)

Creates an anchor for the given link.

The link may point to a URL, a dynamic resource, or an internal path.

See Also:

• setLink(WLink link)

WAnchor

public WAnchor(WLink link)

Creates an anchor for the given link.

Calls this(link, (WContainerWidget)null)

WAnchor

public WAnchor(WLink link,
 CharSequence text,
 WContainerWidget parentContainer)

Creates an anchor for the given link with a text.

The link may point to a URL, a dynamic resource, or an internal path.

See Also:

• setLink(WLink link)
• setText(CharSequence text)

WAnchor

public WAnchor(WLink link,
 CharSequence text)

Creates an anchor for the given link with a text.

Calls this(link, text, (WContainerWidget)null)

WAnchor

public WAnchor(WLink link,
 WImage image,
 WContainerWidget parentContainer)

Creates an anchor for the given link with an image.

See Also:

• setLink(WLink link)
• setImage(WImage image)

WAnchor

public WAnchor(WLink link,
 WImage image)

Creates an anchor for the given link with an image.

Calls this(link, image, (WContainerWidget)null)

Method Details

setLink

public void setLink(WLink link)

Sets the link.

The link may hold a URL, a resource, or an internal path.

When the link points to a resource, the contents of the link may be generated by your application on demand.

When the link points to an internal path, activating the anchor will change the application's internal path or open a new session with the given path as initial path). This is the easiest way to let the application participate in browser history, and generate URLs that are bookmarkable and search engine friendly.

getLink

public WLink getLink()

Returns the link.

See Also:

• setLink(WLink link)

setText

public void setText(CharSequence text)

Sets the label text.

If no text was previously set, a new WText widget is added using WContainerWidget#addWidget().

getText

public WString getText()

Returns the label text.

Returns an empty string if no label was set.

See Also:

• setText(CharSequence text)

setWordWrap

public void setWordWrap(boolean wordWrap)

Configures text word wrapping.

When wordWrap is true, the text set with setText() may be broken up over multiple lines. When wordWrap is false, the text will displayed on a single line, unless the text contains <br /> tags or other block-level tags.

The default value is true.

See Also:

• hasWordWrap()

setTextFormat

public void setTextFormat(TextFormat textFormat)

Configures the text format.

The default text format is TextFormat.XHTML.

See Also:

• WText.setTextFormat(TextFormat textFormat)

getTextFormat

public TextFormat getTextFormat()

Returns the text format.

See Also:

• setTextFormat(TextFormat textFormat)

hasWordWrap

public boolean hasWordWrap()

Returns whether the widget may break lines.

See Also:

• setWordWrap(boolean wordWrap)

setImage

public void setImage(WImage image)

Sets an image.

If an image was previously set, it is deleted. The image is added using WContainerWidget#addWidget().

getImage

public WImage getImage()

Returns the image.

Returns null if no image is set.

See Also:

• setImage(WImage image)

isCanReceiveFocus

public boolean isCanReceiveFocus()

Description copied from class: WWidget

Returns whether the widget can receive focus.

Overrides:

isCanReceiveFocus in class WWebWidget

See Also:

• WWidget.setCanReceiveFocus(boolean enabled)

getTabIndex

public int getTabIndex()

Description copied from class: WWidget

Returns the tab index.

Overrides:

getTabIndex in class WWebWidget

See Also:

• WWidget.setTabIndex(int index)

isSetFirstFocus

public boolean isSetFirstFocus()

Description copied from class: WWidget

Set focus on the widget's first descendant.

Set focus on the widget itself, or on a first descendant which can receive focus.

Returns whether focus could be set.

Overrides:

isSetFirstFocus in class WWebWidget

propagateSetEnabled

protected void propagateSetEnabled(boolean enabled)

Description copied from class: WWidget

Propagates that a widget was enabled or disabled through children.

When enabling or disabling a widget, you usually also want to disable contained children. This method is called by setDisabled() to propagate its state to all children.

You may want to reimplement this method if they wish to render differently when a widget is disabled. The default implementation will propagate the signal to all children.

Overrides:

propagateSetEnabled in class WInteractWidget

enableAjax

protected void enableAjax()

Description copied from class: WWidget

Progresses to an Ajax-enabled widget.

This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

Overrides:

enableAjax in class WWebWidget

See Also:

• WApplication.enableAjax()