tc
Tag fileDrop


Renders a file drop component. This component always makes a partial (ajax) upload!

For content constraints please use tc:validateFileItem.

UIComponentClass: org.apache.myfaces.tobago.component.UIFileDrop

RendererType: FileDrop



Tag Information
Tag Classorg.apache.myfaces.tobago.internal.taglib.FileDropTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
actionfalsefalsejavax.el.MethodExpression
(signature must match java.lang.Object action())
Action to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.
actionListenerfalsefalsejavax.el.MethodExpression
(signature must match void actionListener(javax.faces.event.ActionEvent))
MethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.

Type: javax.faces.component.UIComponent
converterMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the converter message
Type: java.lang.String
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating that this element is disabled.
Type: boolean
Default: false
dropZoneIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)

Indicate the highlighted file drop area.

You should use:

  • a clientId (absolute or relative see setRenderedPartially)
  • @this to use only the layouted space of this tc:fileDrop
  • @parent to use the layouted space of the next parent UIComponent
  • @panel to use the layouted space of the next parent tc:panel


Type: java.lang.String
focusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating this component should receive the focus.
Type: boolean
Default: false
idfalsetruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
imagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Url to an image to display.
Type: java.lang.String
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as label. If text contains an underscore the next character is used as accesskey (if configured so and possible).
Type: java.lang.String
markupfalsefalsejavax.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
multiplefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)

Type: boolean
Default: false
onchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)

**** @deprecated. Will be removed in a future version ****

Client side script function to add to this component's onchange handler.

Client side script function to add to this component's onchange handler.
Type: java.lang.String
readonlyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
Flag indicating that this component will prohibit changes by the user.
Type: boolean
Default: false
renderedfalsefalsejavax.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
renderedPartiallyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String[])

Indicate the partially rendered components in a case of a file drop.

The search depends on the number of prefixed colons in the relativeId:

number of prefixed colons == 0
fully relative
number of prefixed colons == 1
absolute (still normal findComponent syntax)
number of prefixed colons == 2
search in the current naming container (same as 0 colons)
number of prefixed colons == 3
search in the parent naming container of the current naming container
number of prefixed colons > 3
go to the next parent naming container for each additional colon

If a literal is specified: to use more than one identifier the identifiers must be space delimited.

As default the dropZoneId is used.


Type: java.lang.String[]
requiredfalsefalsejavax.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
requiredMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the required message
Type: java.lang.String
tabIndexfalsefalsejavax.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
tipfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as tooltip.
Type: java.lang.String
validatorfalsefalsejavax.el.MethodExpression
(signature must match void validator(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object))
A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
validatorMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the validator message
Type: java.lang.String
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Value binding expression pointing to a javax.servlet.http.Part property to store the uploaded file.
Type: [javax.servlet.http.Part, org.apache.commons.fileupload.FileItem[]]
valueChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void valueChangeListener(javax.faces.event.ValueChangeEvent))
MethodBinding 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.
visibleTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)

Indicate visible component style.

Possible values:

  • DROP_ZONE
  • FILE
  • BUTTON
  • LINK
  • NONE

Default is DROP_ZONE.


Type: java.lang.String

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.