to.etc.domui.component.misc
Class ALink

java.lang.Object
  extended by to.etc.domui.dom.css.CssBase
      extended by to.etc.domui.dom.html.NodeBase
          extended by to.etc.domui.dom.html.NodeContainer
              extended by to.etc.domui.dom.html.ATag
                  extended by to.etc.domui.component.misc.ALink
All Implemented Interfaces:
java.lang.Iterable<NodeBase>, IModelBinding, 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:

Author:
Frits Jalvingh Created on Nov 3, 2008

Constructor Summary
ALink()
           
ALink(java.lang.Class<? extends UrlPage> targetClass)
          Link to a new page; the new page is a SUB page (it is added to the shelve stack).
ALink(java.lang.Class<? extends UrlPage> targetClass, MoveMode mode)
           
ALink(java.lang.Class<? extends UrlPage> targetClass, PageParameters targetParameters)
          Link to a new page; the new page is a SUB page (it is added to the shelve stack).
ALink(java.lang.Class<? extends UrlPage> targetClass, PageParameters targetParameters, MoveMode mode)
           
ALink(java.lang.Class<? extends UrlPage> targetClass, PageParameters targetParameters, WindowParameters newWindowParameters)
           
ALink(java.lang.String targetURL, PageParameters targetParameters, WindowParameters newWindowParameters)
          Link to some http: url that is not a DomUI page.
 
Method Summary
 java.lang.String getImage()
          Return the URL for the link's image, or null if unassigned.
 MoveMode getMoveMode()
           
 WindowParameters getNewWindowParameters()
           
 java.lang.Class<? extends UrlPage> getTargetClass()
           
 PageParameters 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()
          Overridden click handler.
 void setImage(java.lang.Class<?> resourceBase, java.lang.String name)
          Add an image to the link.
 void setImage(java.lang.String url)
          Add an image to the link.
 void setMoveMode(MoveMode moveMode)
           
 void setNewWindowParameters(WindowParameters newWindowParameters)
           
 void setTargetClass(java.lang.Class<? extends UrlPage> targetClass, java.lang.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, canContain, delegateTo, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChild, getDeepChildren, getErrorFence, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalGetOldChildren, internalShelve, internalUnshelve, iterator, moveControlToModel, moveModelToControl, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setControlsEnabled, setErrorFence, setErrorFence, setText, setValue
 
Methods inherited from class to.etc.domui.dom.html.NodeBase
$, acceptRequestParameter, addCssClass, addGlobalMessage, afterCreateContent, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, build, changed, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, componentHandleWebAction, createContent, findComponentBundle, getActualID, getClicked, getComponentBundle, getCreateJS, getCssClass, getErrorDelegate, getErrorLocation, getMessage, getOnClickJS, getOnMouseDownJS, getPage, getParent, getParent, getParent, getSharedContext, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTitle, getUserObject, handleDrop, hasCssClass, hasError, internalGetOldParent, internalHasChangedAttributes, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetTag, isBuilt, isFocusRequested, onAddedToPage, onBeforeFullRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeCssClass, renderJavascriptState, replaceWith, setClicked, setComponentBundle, setCssClass, setErrorDelegate, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setSpecialAttribute, setTestID, setTitle, setUserObject, stretchHeight, 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, 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, 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
 

Constructor Detail

ALink

public ALink()

ALink

public ALink(java.lang.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(java.lang.Class<? extends UrlPage> targetClass,
             MoveMode mode)

ALink

public ALink(java.lang.Class<? extends UrlPage> targetClass,
             PageParameters 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(java.lang.Class<? extends UrlPage> targetClass,
             PageParameters targetParameters,
             MoveMode mode)

ALink

public ALink(java.lang.Class<? extends UrlPage> targetClass,
             PageParameters targetParameters,
             WindowParameters newWindowParameters)

ALink

public ALink(java.lang.String targetURL,
             PageParameters targetParameters,
             WindowParameters newWindowParameters)
Link to some http: url that is not a DomUI page.

Parameters:
targetURL -
targetParameters -
Method Detail

getTargetClass

public java.lang.Class<? extends UrlPage> getTargetClass()

setTargetClass

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

getTargetParameters

public PageParameters 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()
                       throws java.lang.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:
java.lang.Exception
See Also:
NodeBase.internalOnClicked()

setImage

public void setImage(java.lang.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 -

setImage

public void setImage(java.lang.Class<?> resourceBase,
                     java.lang.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.

Parameters:
url -

getImage

public java.lang.String getImage()
Return the URL for the link's image, or null if unassigned.

Returns: