to.etc.domui.component.misc

Class ALink

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.ATag

to.etc.domui.component.misc.ALink

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate

public class ALink
extends ATag

A hyperlink which allows for opening windows in a separate conversation from the link. This is a rather complex interaction which works as follows:

• The link is generated as an A tag with both an onclick handler and a href URL.
• The href url contains a server-generated link to the Page to reach. This URL does NOT contain a WID.
• The onclick handler is a regular handler passing control to the server and returns false always
• When the link is clicked in a normal way the onclick handles takes precedence over the href. This onclick handler passes control to the server as usual; the server will send a redirect for the actual page to reach and this redirect contains the current WID. This causes the new page to show in the current window session.
• If the link is opened with the right mouse button and "Open in new window" or something like that then the onclick handler is not used; the HREF url is used instead. This causes the browser to open a new window with a new URL not containing a WID. The server will respond by redirecting to the same thing with a new WID. This establishes a new Window session.

Author:

Frits Jalvingh Created on Nov 3, 2008

Constructor Summary

Constructors

Constructor and Description
ALink()
ALink(Class<? extends UrlPage> targetClass) Link to a new page; the new page is a SUB page (it is added to the shelve stack).
ALink(Class<? extends UrlPage> targetClass, IPageParameters targetParameters) Link to a new page; the new page is a SUB page (it is added to the shelve stack).
ALink(Class<? extends UrlPage> targetClass, IPageParameters targetParameters, MoveMode mode)
ALink(Class<? extends UrlPage> targetClass, IPageParameters targetParameters, WindowParameters newWindowParameters)
ALink(Class<? extends UrlPage> targetClass, MoveMode mode)
ALink(String targetURL, IPageParameters targetParameters, WindowParameters newWindowParameters) Link to some http: url that is not a DomUI page.

Method Summary

Modifier and Type	Method and Description
String	getImage() Return the URL for the link's image, or null if unassigned.
MoveMode	getMoveMode()
WindowParameters	getNewWindowParameters()
Class<? extends UrlPage>	getTargetClass()
IPageParameters	getTargetParameters()
boolean	internalNeedClickHandler() Mostly internal only: override when this component has a clicked handler which must not be rendered as a Javascript "onclick".
void	internalOnClicked(ClickInfo cli) Overridden click handler.
void	onAddedToPage(Page p)
void	setImage(Class<?> resourceBase, String name) Add an image to the link.
void	setImage(String url) Add an image to the link.
void	setMoveMode(MoveMode moveMode)
void	setNewWindowParameters(WindowParameters newWindowParameters)
void	setTargetClass(Class<? extends UrlPage> targetClass, Object... parameters)
void	setTargetParameters(PageParameters targetParameters)

Methods inherited from class to.etc.domui.dom.html.ATag

getHref, getTarget, setHref, setTarget, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebAction, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ALink

public ALink()

ALink

public ALink(Class<? extends UrlPage> targetClass)

Link to a new page; the new page is a SUB page (it is added to the shelve stack).

Parameters:

targetClass -

ALink

public ALink(Class<? extends UrlPage> targetClass,
             MoveMode mode)

ALink

public ALink(Class<? extends UrlPage> targetClass,
             IPageParameters targetParameters)

Link to a new page; the new page is a SUB page (it is added to the shelve stack).

Parameters:

targetClass -

targetParameters -

ALink

public ALink(Class<? extends UrlPage> targetClass,
             IPageParameters targetParameters,
             MoveMode mode)

ALink

public ALink(Class<? extends UrlPage> targetClass,
             IPageParameters targetParameters,
             WindowParameters newWindowParameters)

ALink

public ALink(String targetURL,
             IPageParameters targetParameters,
             WindowParameters newWindowParameters)

Link to some http: url that is not a DomUI page.

Parameters:

targetURL -

targetParameters -

Method Detail

getTargetClass

public Class<? extends UrlPage> getTargetClass()

setTargetClass

public void setTargetClass(Class<? extends UrlPage> targetClass,
                           Object... parameters)

getTargetParameters

public IPageParameters getTargetParameters()

setTargetParameters

public void setTargetParameters(PageParameters targetParameters)

getNewWindowParameters

public WindowParameters getNewWindowParameters()

setNewWindowParameters

public void setNewWindowParameters(WindowParameters newWindowParameters)

getMoveMode

public MoveMode getMoveMode()

setMoveMode

public void setMoveMode(MoveMode moveMode)

internalNeedClickHandler

public boolean internalNeedClickHandler()

Description copied from class: NodeBase

Mostly internal only: override when this component has a clicked handler which must not be rendered as a Javascript "onclick". For instance the LookupForm returns false for this, so that it can override the "clicked" property to be called when the lookupform's SEARCH button is pressed.

Overrides:

internalNeedClickHandler in class NodeBase

Returns:

internalOnClicked

public void internalOnClicked(@Nonnull
                              ClickInfo cli)
                       throws Exception

Overridden click handler. If no specific onClick handler is configured we handle the click by moving to the specified page within the same window session.

Overrides:

internalOnClicked in class NodeBase

Throws:

Exception

See Also:

to.etc.domui.dom.html.NodeBase#internalOnClicked()

setImage

public void setImage(String url)

Add an image to the link. The image is added just before the link text and should be an icon of max 16x16 px. The image is cleared by passing null as a parameter.

Parameters:

url -

onAddedToPage

public void onAddedToPage(Page p)

Overrides:

onAddedToPage in class NodeBase

setImage

public void setImage(Class<?> resourceBase,
                     String name)

Add an image to the link. The image is added just before the link text and should be an icon of max 16x16 px.

getImage

public String getImage()

Return the URL for the link's image, or null if unassigned.

Returns: