Anchor Class
- public class Anchor
extends AbstractBaseTag
implements IAttributeConsumer
, URLParams
Generates a hyperlink to a specified URI.
Also adds support for URL re-writing and JavaScript-based form submission.
An anchor must have one of five attributes to correctly create the hyperlink:
- action - an action invoked by clicking the hyperlink.
- forward - a forward to redirect to.
- href - a URL to go to
- linkName - an internal place in the page to move to
- page - The module-relative page URL to which this hyperlink will be rendered.
Attribute Descriptions |
Attribute | Required | Runtime Expression Evaluation |
Data Bindable |
accessKey | No | No | No |
Define the keyboard navigation key for the element. |
action | No | No | Read Only |
An action invoked by clicking the link. |
formSubmit | No | No | No |
True if clicking this link should submit its enclosing form . |
forward | No | No | No |
The logical forward name from which to retrieve the hyperlink URI. |
href | No | No | Read Only |
A URL destination to go to. |
id | No | No | No |
id is deprecated, use tagId. The id attribute of the generated Anchor. You should use the tagId which will encode the id correctly for containers such as the Portal which needs to rewrite id's to make them unique. |
linkName | No | No | No |
An internal place in the page to move to. |
location | No | No | No |
Location within the URI to visit |
page | No | No | No |
page is deprecated The module-relative page URL to which this hyperlink will be rendered. |
tagId | No | No | No |
The id of this anchor. The real id written to the HTML stream may be changed by the container (Portal),
but may be looked up with the 'tagId' value through the JavaScript method getNetuiTagName( tag, tagId ) method written by the <netui:html> tag. |
target | No | No | No |
The window target |
Related Topics
<netui:anchor> Tag Sample
How Do I: Define an Action That Forwards Users to Another Page?
Form
-
Hierarchy
-
Object
TagSupport
BodyTagSupport
AbstractBaseTag
Anchor
-
All Implemented Interfaces
-
BodyTag
, IAttributeConsumer
, IterationTag
, Serializable
, Tag
, URLParams
-
Direct Known Subclasses
-
ImageAnchor
Fields from com.bea.wlw.netui.tags.AbstractBaseTag |
ATTR_GENERAL , ATTR_GENERAL_EXPRESSION , ATTR_JAVASCRIPT , ATTR_STYLE , CLASS , ID , JAVASCRIPT_STATUS , NAME , NETUI_UNIQUE_CNT , ONCLICK , ONDBLCLICK , ONKEYDOWN , ONKEYPRESS , ONKEYUP , ONMOUSEDOWN , ONMOUSEMOVE , ONMOUSEOUT , ONMOUSEOVER , ONMOUSEUP , STYLE , TABINDEX
|
Methods from com.bea.wlw.netui.tags.AbstractBaseTag |
addTagIdMapping , evaluateAttributeToString , filter , filter , getJavaScriptUtils , getNearestForm , getScriptReporter , getUserLocale , registerTagError , release , renderAttribute , rewriteName , write
|
Methods from javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue |
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HREF
public static final String
HREF
id
protected String
id
Anchor
public Anchor()
addParameter(String, Object) Method
public void addParameter(String
name,
Object
value)
throws JspException
Adds a URL parameter to the generated hyperlink.
Parameters
-
name
- - the name of the parameter to be added.
-
value
- - the value of the parameter to be added (a String or String[]).
Exceptions
-
JspException
createAnchorAttributes(UnsyncStringBuffer) Method
protected void createAnchorAttributes(UnsyncStringBuffer
results)
Method which will write additional attributes into the
anchor being created by the createAnchorBeginTag
method.
This allows subclasses to override which sets of attributes are attached
to the <a>
tag.
createAnchorBeginTag(UnsyncStringBuffer, UnsyncStringBuffer, boolean) Method
protected boolean createAnchorBeginTag(UnsyncStringBuffer
results,
UnsyncStringBuffer
script,
boolean encodeAction)
throws JspException
This method will take all of the internal variables and create an anchor.
Exceptions
-
JspException
doAfterBody() Method
public int doAfterBody()
throws JspException
Save the body content of the Anchor.
-
Overrides
-
BodyTagSupport.doAfterBody()
Exceptions
-
JspException
- if a JSP exception has occurred
doEndTag() Method
public int doEndTag()
throws JspException
Render the hyperlink.
-
Overrides
-
BodyTagSupport.doEndTag()
Exceptions
-
JspException
- if a JSP exception has occurred
doStartTag() Method
public int doStartTag()
throws JspException
Prepare the hyperlink for rendering
-
Overrides
-
BodyTagSupport.doStartTag()
Exceptions
-
JspException
- if a JSP exception has occurred
getAccessKey() Method
public String
getAccessKey()
Gets the accessKey attribute value.
Returns
- the accessKey value.
getAction() Method
public String
getAction()
Return the action of the Anchor.
Returns
- a String representing the action name of the Anchor.
getFormSubmit() Method
public boolean getFormSubmit()
Return the formSubmit indicator.
Returns
- a String representing whether or not the enclosing
Form should be submitted.
getForward() Method
public String
getForward()
Return the forward name of the Anchor.
Returns
- the Anchor's logical forward name
getHref() Method
public String
getHref()
Return the href of the Anchor.
Returns
- the hyperlink URI
getId() Method
public String
getId()
Return the ID associated with this tag.
-
Overrides
-
TagSupport.getId()
Returns
- the ID.
getLinkName() Method
public String
getLinkName()
Return the link name of the Anchor.
Returns
- the linkName
getLocation() Method
public String
getLocation()
Returns the anchor to be added to the end of the generated hyperlink.
Returns
- the name of the location anchor.
getOnBlur() Method
public String
getOnBlur()
Gets the onBlur javascript event.
Returns
- the onBlur event.
getOnClick() Method
public String
getOnClick()
Gets the onClick javascript event.
Returns
- the onClick event.
getOnDblClick() Method
public String
getOnDblClick()
Gets the onDblClick javascript event.
Returns
- the onDblClick event.
getOnFocus() Method
public String
getOnFocus()
Gets the onFocus javascript event.
Returns
- the onFocus event.
getOnKeyDown() Method
public String
getOnKeyDown()
Gets the onKeyDown javascript event.
Returns
- the onKeyDown event.
getOnKeyPress() Method
public String
getOnKeyPress()
Gets the onKeyPress javascript event.
Returns
- the onKeyPress event.
getOnKeyUp() Method
public String
getOnKeyUp()
Gets the onKeyUp javascript event.
Returns
- the onKeyUp event.
getOnMouseDown() Method
public String
getOnMouseDown()
Gets the onMouseDown javascript event.
Returns
- the onMouseDown event.
getOnMouseMove() Method
public String
getOnMouseMove()
Gets the onMouseMove javascript event.
Returns
- the onMouseMove event.
getOnMouseOut() Method
public String
getOnMouseOut()
Gets the onMouseOut javascript event.
Returns
- the onMouseOut event.
getOnMouseOver() Method
public String
getOnMouseOver()
Gets the onMouseOver javascript event.
Returns
- the onMouseOver event.
getOnMouseUp() Method
public String
getOnMouseUp()
Gets the onMouseUp javascript event.
Returns
- the onMouseUp event.
getPage() Method
public String
getPage()
Returns the module-relative page URL to which this hyperlink will be rendered.
Returns
- the page URL.
getRealFormName() Method
protected String
getRealFormName()
This will get the real name of the form. This is set in the
id attribute.
Returns
- The String real name of the containing form.
getStyle() Method
public String
getStyle()
Gets the style of the rendered html tag.
Returns
- the style.
getStyleClass() Method
public String
getStyleClass()
Gets the style class of the rendered html tag.
Returns
- the style class.
getTabindex() Method
public String
getTabindex()
Gets the tabIndex of the rendered html tag.
Returns
- the tabindex.
getTagId() Method
public String
getTagId()
Return the ID of the tag. The id may be rewritten by the container (such
as a portal) to make sure it is unique. JavaScript my lookup the actual id
of the element by looking it up in the netui_names
table written
into the HTML.
Returns
- the tagId.
getTagName() Method
public String
getTagName()
Returns the name of the Tag.
-
Overrides
-
AbstractBaseTag.getTagName()
getTarget() Method
public String
getTarget()
Returns the window target.
Returns
- the window target.
localRelease() Method
protected void localRelease()
Release any acquired resources.
-
Overrides
-
AbstractBaseTag.localRelease()
setAccessKey(String) Method
public void setAccessKey(String
accessKey)
Sets the accessKey attribute value. This should key value of the
keyboard navigation key. It is recommended not to use the following
values because there are often used by browsers A, C, E, F, G,
H, V, left arrow, and right arrow
.
Parameters
-
accessKey
- - the accessKey value.
setAction(String) Method
public void setAction(String
action)
Set the name of the action for the Anchor.
Parameters
-
action
- - the name of the action to set for the Anchor.
setAttribute(String, String) Method
public void setAttribute(String
name,
String
value)
throws JspException
Set an attribute value. The name
represents
the name of the attribute.
The value
represents the value and may contain
a netui expression. This method may result in errors being generated.
This requires that the tag buffer its body and
write attributes in the end tag. For the anchor tag it is not legal to set
the id
, name
, or href
attributes with this method.
Parameters
-
name
- The name of the attribute. This value may not be null or the empty string.
-
value
- The value of the attribute. This may contain a netui expression.
Exceptions
-
JspException
- A JspException may be thrown if there is an error setting the attribute.
setFormSubmit(boolean) Method
public void setFormSubmit(boolean formSubmit)
Sets the formSubmit indicator.
Parameters
-
formSubmit
- - whether or not the enclosing Form should be submitted.
setForward(String) Method
public void setForward(String
forward)
Sets the forward name of the Anchor.
Parameters
-
forward
- - the logical forward name from which to retrieve the hyperlink URI.
setHref(String) Method
public void setHref(String
href)
Sets the href of the Anchor.
Parameters
-
href
- - the hyperlink URI for the Anchor.
setId(String) Method
public void setId(String
id)
Set the ID attribute of the tag.
-
Overrides
-
TagSupport.setId(String)
Parameters
-
id
- - the ID.
setLinkName(String) Method
public void setLinkName(String
linkName)
Sets the link name of the Anchor.
Parameters
-
linkName
- - the link name for the Anchor.
setLocation(String) Method
public void setLocation(String
location)
Sets the anchor to be added to the end of the generated hyperlink.
Parameters
-
location
- - the name of the location anchor.
setOnBlur(String) Method
public void setOnBlur(String
onblur)
Sets the onBlur javascript event.
Parameters
-
onblur
- - the onBlur event.
setOnClick(String) Method
public void setOnClick(String
onclick)
Sets the onClick javascript event.
Parameters
-
onclick
- - the onClick event.
setOnDblClick(String) Method
public void setOnDblClick(String
ondblclick)
Sets the onDblClick javascript event.
Parameters
-
ondblclick
- - the onDblClick event.
setOnFocus(String) Method
public void setOnFocus(String
onfocus)
Sets the onFocus javascript event.
Parameters
-
onfocus
- - the onFocus event.
setOnKeyDown(String) Method
public void setOnKeyDown(String
onkeydown)
Sets the onKeyDown javascript event.
Parameters
-
onkeydown
- - the onKeyDown event.
setOnKeyPress(String) Method
public void setOnKeyPress(String
onkeypress)
Sets the onKeyPress javascript event.
Parameters
-
onkeypress
- - the onKeyPress event.
setOnKeyUp(String) Method
public void setOnKeyUp(String
onkeyup)
Sets the onKeyUp javascript event.
Parameters
-
onkeyup
- - the onKeyUp event.
setOnMouseDown(String) Method
public void setOnMouseDown(String
onmousedown)
Sets the onMouseDown javascript event.
Parameters
-
onmousedown
- - the onMouseDown event.
setOnMouseMove(String) Method
public void setOnMouseMove(String
onmousemove)
Sets the onMouseMove javascript event.
Parameters
-
onmousemove
- - the onMouseMove event.
setOnMouseOut(String) Method
public void setOnMouseOut(String
onmouseout)
Sets the onMouseOut javascript event.
Parameters
-
onmouseout
- - the onMouseOut event.
setOnMouseOver(String) Method
public void setOnMouseOver(String
onmouseover)
Sets the onMouseOver javascript event.
Parameters
-
onmouseover
- - the onMouseOver event.
setOnMouseUp(String) Method
public void setOnMouseUp(String
onmouseup)
Sets the onMouseUp javascript event.
Parameters
-
onmouseup
- - the onMouseUp event.
setPage(String) Method
public void setPage(String
page)
Sets the module-relative page URL to which this hyperlink will be rendered.
Parameters
-
page
- - the page URL.
setStyle(String) Method
public void setStyle(String
style)
Sets the style of the rendered html tag.
Parameters
-
style
- - the html style.
setStyleClass(String) Method
public void setStyleClass(String
styleClass)
Sets the style class of the rendered html tag.
Parameters
-
styleClass
- - the html style class.
setTabindex(String) Method
public void setTabindex(String
tabindex)
Sets the tabIndex of the rendered html tag.
Parameters
-
tabindex
- - the tab index.
setTagId(String) Method
public void setTagId(String
tagId)
Set the ID of the tag.
Parameters
-
tagId
- - the tagId.
setTarget(String) Method
public void setTarget(String
target)
Sets the window target.
Parameters
-
target
- - the window target.