Package org.apache.struts2.components

Class File

java.lang.Object

org.apache.struts2.components.Component

org.apache.struts2.components.UIBean

org.apache.struts2.components.File

public class File
extends UIBean

Renders an HTML file input element.

Examples

 
 <s:file name="anUploadFile" accept="text/*" />
 <s:file name="anohterUploadFIle" accept="text/html,text/plain" />
 
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accept
protected String	size
static final String	TEMPLATE

Fields inherited from class org.apache.struts2.components.UIBean

accesskey, ATTR_FIELD_VALUE, ATTR_NAME_VALUE, ATTR_VALUE, cspNonceReader, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, errorPosition, html5ConstraintsEnabled, htmlConstraintProvider, 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, value

Fields inherited from class org.apache.struts2.components.Component

actionMapper, attributes, COMPONENT_STACK, devMode, escapeHtmlBody, performClearTagStateForTagPoolingServers, stack, standardAttributesMap, throwExceptionOnELFailure

Constructor Summary

Constructors

Constructor	Description
File(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
protected void	applyValueParameter(String translatedName)	Unlike the String conversion, the raw lookup honours struts.el.throwExceptionOnFailure.
void	evaluateParams()
protected HtmlControlType	getControlType()	The kind of HTML control this component renders, used to decide which HTML5 constraint attributes are legal on it.
protected String	getDefaultTemplate()	A contract that requires each concrete UI Tag to specify which template should be used as a default.
protected Class<?>	getValueClassType()	A file input never renders its value, so keep the raw property: converting null to a String yields "", which would hide a missing attachment from the constraint derivation.
void	setAccept(String accept)
void	setSize(String size)
void	setValue(String value)

Methods inherited from class org.apache.struts2.components.UIBean

addConstraintAttributes, addFormParameter, buildTemplateName, copyAttributes, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateExtraParams, evaluateNameValue, getId, getTemplate, getTemplateDir, getTheme, getTooltipConfig, lazyEvaluation, mergeTemplate, populateComponentHtmlId, setAccesskey, setCspNonceReader, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setErrorPosition, setHtml5ConstraintsEnabled, setHtmlConstraintProvider, 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, setUIThemeExpansionToken

Methods inherited from class org.apache.struts2.components.Component

addAllAttributes, addParameter, clearStandardAttributesMap, 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, start, stripExpression, toString, usesBody

Methods inherited from class java.lang.Object

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

Field Details

TEMPLATE

public static final String TEMPLATE

See Also:

• Constant Field Values

accept

protected String accept

size

protected String size

Constructor Details

File

public File(ValueStack stack,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Method Details

getDefaultTemplate

protected String getDefaultTemplate()

Description copied from class: UIBean

A 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:

getDefaultTemplate in class UIBean

Returns:

The name of the template to be used as the default.

getControlType

protected HtmlControlType getControlType()

Description copied from class: UIBean

The kind of HTML control this component renders, used to decide which HTML5 constraint attributes are legal on it. Defaults to HtmlControlType.UNSUPPORTED, which supports no constraints — so a component that does not override this emits none.

Overrides:

getControlType in class UIBean

getValueClassType

protected Class<?> getValueClassType()

A file input never renders its value, so keep the raw property: converting null to a String yields "", which would hide a missing attachment from the constraint derivation.

Overrides:

getValueClassType in class UIBean

applyValueParameter

protected void applyValueParameter(String translatedName)

Unlike the String conversion, the raw lookup honours struts.el.throwExceptionOnFailure. A file input is routinely bound to no property at all — an UploadedFilesAware action receives the part by name — so that one failure is not the misconfiguration the flag exists to surface.

Overrides:

applyValueParameter in class UIBean

Parameters:

translatedName - the already evaluated UIBean.name

evaluateParams

public void evaluateParams()

Overrides:

evaluateParams in class UIBean

setAccept

public void setAccept(String accept)

setSize

public void setSize(String size)

setValue

public void setValue(String value)

Overrides:

setValue in class UIBean