file (Tobago Core VDL Documentation)

Description:
Renders a file input field.

For content constraints please use tc:validateFileItem.
UIComponentClass: org.apache.myfaces.tobago.component.UIFile
RendererType:
- File (default)
Supported markups:
large
Render a large file input.
small
Render a small file input.

Component Information
Info	Value
Component Type	`org.apache.myfaces.tobago.File`
Handler Class	`org.apache.myfaces.tobago.facelets.TobagoComponentHandler`
Renderer Type	`File`
Description	None

Attributes
Name	Required	Type	Description
`accessKey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Character`)	The access key of this control. Type: `java.lang.Character`
`autoSpacing`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet Type: `java.lang.Boolean`
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean. For Facelets, the component is the outer UIPanel, not the input control. Type: `jakarta.faces.component.UIComponent`
`converterMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	An expression that specifies the converter message. If present, will be used as the text of the converter message, replacing any message that comes from the converter. Type: `java.lang.String`
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that this element is disabled. Type: `boolean` Default: `false`
`dropZone`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The id of the HTMLElement in the Browser to drop the file. Type: `java.lang.String`
`focus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating this component should receive the focus. Type: `boolean` Default: `false`
`help`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text value to display as a help. Type: `java.lang.String`
`helpPosition`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.component.DecorationPosition`)	Defines the position and the appearance of a help message on a component. The default is popoverRight. Type: `org.apache.myfaces.tobago.component.DecorationPosition`
`id`	`false`	`java.lang.String`	The component identifier for this component. This value must be unique within the closest parent component that is a naming container. Type: `java.lang.String`
`label`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A localized user presentable label for this component. Type: `java.lang.String`
`labelLayout`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.component.LabelLayout`)	Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags). Type: `org.apache.myfaces.tobago.component.LabelLayout`
`markup`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.context.Markup`)	Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer. Type: `org.apache.myfaces.tobago.context.Markup`
`messagePosition`	`false`	`javax.el.ValueExpression` (must evaluate to `org.apache.myfaces.tobago.component.DecorationPosition`)	Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight. Type: `org.apache.myfaces.tobago.component.DecorationPosition`
`multiple`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Type: `boolean` Default: `false`
`readonly`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that this component will prohibit changes by the user. Type: `boolean` Default: `false`
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. Type: `boolean` Default: `true`
`required`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered. Type: `boolean` Default: `false`
`requiredMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	An expression that specifies the required message Type: `java.lang.String`
`tabIndex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order. Type: `java.lang.Integer`
`tip`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text value to display as tooltip. Type: `java.lang.String`
`validator`	`false`	`java.lang.String`	A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
`validatorMessage`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	An expression that specifies the validator message. If present, will be used as the text of the validator message, replacing any message that comes from the validator. Type: `java.lang.String`
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Value binding expression pointing to a {@link jakarta.servlet.http.Part} property to store the uploaded file. Type: `[jakarta.servlet.http.Part, jakarta.servlet.http.Part[]]`
`valueChangeListener`	`false`	`java.lang.String`	MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.

tc

Tag file