Package org.apache.struts2.components
Class Anchor
java.lang.Object
org.apache.struts2.components.Component
org.apache.struts2.components.UIBean
org.apache.struts2.components.ClosingUIBean
org.apache.struts2.components.Anchor
A tag that creates a HTML <a >.This tag supports the same attributes as the "url" tag, including nested parameters using the "param" tag.
Examples
<s:a id="link1" href="/do-it.action">
<img border="none" src="<%=request.getContextPath()%>/images/delete.gif"/>
<s:param name="id" value="1"/>
</s:a>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected Stringstatic final Stringprotected booleanstatic final Stringprotected UrlProviderprotected UrlRendererFields inherited from class org.apache.struts2.components.UIBean
accesskey, ATTR_FIELD_VALUE, ATTR_NAME_VALUE, ATTR_VALUE, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, errorPosition, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, requiredLabel, requiredPosition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, uiStaticContentPath, uiThemeExpansionToken, valueFields inherited from class org.apache.struts2.components.Component
actionMapper, attributes, COMPONENT_STACK, devMode, escapeHtmlBody, performClearTagStateForTagPoolingServers, stack, standardAttributesMap, throwExceptionOnELFailure -
Constructor Summary
ConstructorsConstructorDescriptionAnchor(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAllAttributes(Map<String, Object> additionalAttributes) Adds all the given attributes to this component's own attributes.voidaddParameter(String key, Object value) Adds the given key and value to this component's own parameter.booleanOverrides to be able to render body in a template rather than always before the templateprotected voidprotected StringA contract that requires each concrete UI Tag to specify which template should be used as a default.voidvoidvoidsetEncode(boolean encode) voidsetEscapeAmp(boolean escapeAmp) voidsetEscapeHtmlBody(boolean escapeHtmlBody) voidvoidsetForceAddSchemeHostAndPort(boolean forceAddSchemeHostAndPort) voidvoidsetIncludeContext(boolean includeContext) voidsetIncludeParams(String includeParams) voidvoidsetNamespace(String namespace) voidsetPortletMode(String portletMode) voidsetPortletUrlType(String portletUrlType) voidvoidsetUrlIncludeParams(String urlIncludeParams) voidsetUrlRenderer(UrlRenderer urlRenderer) voidvoidsetWindowState(String windowState) booleanCallback for the start tag of this component.booleanusesBody()Overwrite to set if body should be used.Methods inherited from class org.apache.struts2.components.ClosingUIBean
setOpenTemplateMethods inherited from class org.apache.struts2.components.UIBean
addFormParameter, applyValueParameter, buildTemplateName, copyAttributes, enableAncestorFormCustomOnsubmit, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getId, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, lazyEvaluation, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setErrorPosition, setId, setJavascriptTooltip, setKey, setLabel, setLabelPosition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequiredLabel, setRequiredPosition, setStaticContentPath, setStyle, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTheme, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setUIThemeExpansionTokenMethods inherited from class org.apache.struts2.components.Component
completeExpression, determineActionURL, determineNamespace, end, escapeHtmlBody, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getAttributes, getComponentStack, getNamespace, getPerformClearTagStateForTagPoolingServers, getStack, getStandardAttributes, isAcceptableExpression, isValidTagAttribute, popComponentStack, setActionMapper, setDevMode, setEscapeHtmlBody, setNotExcludedAcceptedPatterns, setPerformClearTagStateForTagPoolingServers, setThrowExceptionsOnELFailure, setUrlHelper, stripExpression, toString
-
Field Details
-
OPEN_TEMPLATE
- See Also:
-
TEMPLATE
- See Also:
-
COMPONENT_NAME
-
href
-
urlProvider
-
urlRenderer
-
processingTagBody
protected boolean processingTagBody -
urlParameters
-
-
Constructor Details
-
Anchor
public Anchor(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
-
-
Method Details
-
getDefaultOpenTemplate
- Specified by:
getDefaultOpenTemplatein classClosingUIBean
-
getDefaultTemplate
Description copied from class:UIBeanA contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.- Specified by:
getDefaultTemplatein classUIBean- Returns:
- The name of the template to be used as the default.
-
usesBody
public boolean usesBody()Description copied from class:ComponentOverwrite to set if body should be used. -
evaluateExtraParams
protected void evaluateExtraParams()- Overrides:
evaluateExtraParamsin classUIBean
-
setUrlIncludeParams
-
setUrlRenderer
-
setExtraParameterProvider
-
start
Description copied from class:ComponentCallback for the start tag of this component. Should the body be evaluated?- Overrides:
startin classClosingUIBean- Parameters:
writer- the output writer.- Returns:
- true if the body should be evaluated
-
end
Overrides to be able to render body in a template rather than always before the template -
addParameter
Description copied from class:ComponentAdds the given key and value to this component's own parameter.
If the provided key is null nothing happens. If the provided value is null any existing parameter with the given key name is removed.- Overrides:
addParameterin classComponent- Parameters:
key- the key of the new parameter to add.value- the value associated with the key.
-
addAllAttributes
Description copied from class:ComponentAdds all the given attributes to this component's own attributes.- Overrides:
addAllAttributesin classComponent- Parameters:
additionalAttributes- the attributes to add.
-
getUrlProvider
-
setHref
-
setIncludeParams
-
setScheme
-
setValue
-
setAction
-
setNamespace
-
setMethod
-
setEncode
public void setEncode(boolean encode) -
setIncludeContext
public void setIncludeContext(boolean includeContext) -
setPortletMode
-
setWindowState
-
setPortletUrlType
-
setAnchor
-
setEscapeAmp
public void setEscapeAmp(boolean escapeAmp) -
setForceAddSchemeHostAndPort
public void setForceAddSchemeHostAndPort(boolean forceAddSchemeHostAndPort) -
setEscapeHtmlBody
public void setEscapeHtmlBody(boolean escapeHtmlBody)
-