NetUI Tag Library Documentation (Version 1.0.2)

netui
netui:fileUpload Tag

Renders an HTML input tag with which users can browse, select, and upload files from their local machine.

Syntax

<netui:fileUpload
    [accept="string_acceptTheseMIMETypes"]
    dataSource="expression_datasource"
    [dir="string_dir"]
    [disabled="boolean_disabled"]
    [lang="string_lang"]
    [onBlur="string_onBlur"]
    [onChange="string_onChange"]
    [onClick="string_onClick"]
    [onDblClick="string_onDblClick"]
    [onFocus="string_onFocus"]
    [onKeyDown="string_onKeyDown"]
    [onKeyPress="string_onKeyPress"]
    [onKeyUp="string_onKeyUp"]
    [onMouseDown="string_onMouseDown"]
    [onMouseMove="string_onMouseMove"]
    [onMouseOut="string_onMouseOut"]
    [onMouseOver="string_onMouseOver"]
    [onMouseUp="string_onMouseUp"]
    [onSelect="string_onSelect"]
    [readonly="boolean_readOnly"]
    [size="integer_fieldSize"]
    [style="string_style"]
    [styleClass="string_styleClass"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [title="string_title"] >
    ... JSP content ...
</netui:fileUpload>

Description

Renders an HTML input tag with which users can browse, select, and upload files from their local machine.

To successfully upload files, the following two conditions must be met:

The dataSource attribute for the <netui:fileUpload> tag is write-only. This means that the value of the <netui:fileUpload> tag cannot be read back into the tag on postback.

Attributes
accept
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The set of MIME types accepted for file upload.
dataSource
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

The dataSource attribute determines both (1) the source of populating data for the tag and (2) the object to which the tag submits data.

For example, assume that the Controller file (= JPF file) contains a Form Bean with the property foo. Then the following <netui:textBox> tag will (1) draw populating data from the Form Bean's foo property and (2) submit user defined data to the same property.

    <netui:textBox dataSource="actionForm.foo" />

The dataSource attribute takes either a data binding expression or the name of a Form Bean property. In the above example, <netui:textBox dataSource="foo" /> would have the exactly same behavior.

When the tag is used to submit data, the data binding expression must refer to a Form Bean property. In cases where the tag is not used to submit data, but is used for displaying data only, the data binding expression need not refer to a Form Bean property. For example, assume that myIterativeData is a member variable on the Controller file ( = JPF file). The following <netui-data:repeater> tag draws its data from myIterativeData.

    <netui-data:repeater dataSource="pageFlow.myIterativeData">

dir
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies the direction of text. (LTR | RTL)
disabled
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the disable state either with the literal "true" or "false" or with an expression.
lang
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the language code for the base language of an element's attribute values and text content.
onBlur
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onBlur JavaScript event.
onChange
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onChange JavaScript event.
onClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onClick JavaScript event.
onDblClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onDblClick JavaScript event.
onFocus
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onFocus JavaScript event.
onKeyDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyDown JavaScript event.
onKeyPress
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyPress JavaScript event.
onKeyUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyUp JavaScript event.
onMouseDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseDown JavaScript event.
onMouseMove
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseMove JavaScript event.
onMouseOut
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOut JavaScript event.
onMouseOver
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOver JavaScript event.
onMouseUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseUp JavaScript event.
onSelect
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onSelect JavaScript event.
readonly
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Boolean. Determines whether or not the file upload field is read-only.
size
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Integer. The number of characters visible in the file upload field.
style
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies style information for the current element.
styleClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style class (a style sheet selector).
tabindex
Required: No  |   Type: int  |   Supports runtime evaluation / JSP Expression Language: Yes

The tabIndex of the rendered HTML tag. This attribute determines the position of the rendered HTML tag in the sequence of tags that the user may advance through by pressing the TAB key.
tagId
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

String value. Sets the id (or name) attribute of the rendered HTML tag. Note that the real id attribute rendered in the browser may be changed by the application container (for example, Portal containers may change the rendered id value to ensure the uniqueness of id's on the page). In this case, the real id rendered in the browser may be looked up through the JavaScript function lookupIdByTagId( tagId, tag ).

For example, assume that some tag's tagId attribute is set to foo.

    <netui:textBox tagId="foo" />

Then the following JavaScript function will return the real id attribute rendered in the browser:

    lookupIdByTagId( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function lookupIdByTagId( tagId, tag ). For example, assume that there is a <netui:form> whose tagId attribute is set to bar.

    <netui:form tagId="bar" >

Then the following JavaScript function will return the <netui:form> element and its children (packaged as an array).

    document[lookupIdByTagId( "bar", this )]

To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.

    document[lookupIdByTagId("bar", this)][lookupIdByTagId("foo", this)].value

The second parameter ensures that the JavaScript function begins its search within the correct Portlet scope. Pass the JavaScript keyword this as the second parameter.

title
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The title.

Example

In the following example, note the enctype attribute of the enclosing <netui:form> tag.

    <netui:form action="uploadFile" enctype="multipart/form-data">
        <netui:fileUpload tagId="inputbox" dataSource="actionForm.theFile" />
        <netui:button value="Upload File" />
    </netui:form>
Note that the <netui:fileUpload> tag submits the file to Form Bean property theFile. This property must be of type org.apache.struts.upload.FormFile:
    public static class UploadFileForm extends FormData
    {
        private org.apache.struts.upload.FormFile theFile;

        public void setTheFile(org.apache.struts.upload.FormFile theFile)
        {
            this.theFile = theFile;
        }

        public org.apache.struts.upload.FormFile getTheFile()
        {
            return this.theFile;
        }
    }


Tag Information
Tag Classorg.apache.beehive.netui.tags.html.FileUpload
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone