FileUpload (Apache Beehive NetUI API Documentation (Version 1.0.1))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.netui.tags.html
Class FileUpload

Object
  TagSupport
      BodyTagSupport
          AbstractClassicTag
              HtmlBaseTag
                  HtmlFocusBaseTag
                      HtmlDataSourceTag
                          FileUpload

All Implemented Interfaces:: Serializable, BodyTag, IterationTag, JspTag, Tag, HtmlConstants, IAttributeConsumer, IHtmlAttrs, IHtmlCore, IHtmlEvents, IHtmlI18n, INetuiTag

public class FileUpload
extends HtmlDataSourceTag
extends HtmlDataSourceTag

Renders an input tag with type="file", with the given attributes. Usage of this tag requires the parent Form tag to have enctype="multipart/form-data".

Notes

The dataSource for the FileUpload tag is write-only. This means that the value of the FileUpload cannot get read back into the FileUpload on postback.
The page flow or form bean property pointed to with the FileUpload's dataSource should be of type org.apache.struts.upload.FormFile.

See Also:

Serialized Form

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;
        }
    }

Field Summary

Fields inherited from class HtmlDataSourceTag
`_dataSource`

Fields inherited from class AbstractClassicTag
`DefaultNamingChain, EMPTY_STRING, NETUI_UNIQUE_CNT`

Fields inherited from class BodyTagSupport
`bodyContent`

Fields inherited from class TagSupport
`id, pageContext`

Fields inherited from interface HtmlConstants
ABBR, ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, AREA, AXIS, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, BUTTON, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COLSPAN, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEADERS, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LANGUAGE, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, ROWSPAN, RULES, SCOPE, SCRIPT, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TBODY, TD, TEXT, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH

Fields inherited from interface HtmlConstants

ABBR, ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, AREA, AXIS, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, BUTTON, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COLSPAN, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEADERS, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LANGUAGE, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, ROWSPAN, RULES, SCOPE, SCRIPT, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TBODY, TD, TEXT, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH

Fields inherited from interface BodyTag
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

Fields inherited from interface IterationTag
`EVAL_BODY_AGAIN`

Fields inherited from interface Tag
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

Constructor Summary
`FileUpload()`

Method Summary
`int`	`doEndTag()` Render the FileUpload.
`int`	`doStartTag()` Render the fileUpLoad tag.
`protected AbstractHtmlState`	`getState()` This method will return the state associated with the tag.
`String`	`getTagName()` Return the name of the Tag.
`protected void`	`localRelease()` Release any acquired resources.
`void`	`setAccept(String accept)` Set the mime-types accepted for the FileUpload.
`void`	`setAttribute(String name, String value, String facet)` Base support for the attribute tag.
`void`	`setReadonly(boolean readonly)` Set if this FileUpload is read-only.
`void`	`setSize(String size)` Set the size (in characters) of the FileUpload.
`void`	`setTabindex(int tabindex)` Sets the tabIndex of the rendered html tag.

Methods inherited from class HtmlDataSourceTag
`evaluateDataSource, getNamingChain, nameHtmlControl, setDataSource`

Methods inherited from class HtmlFocusBaseTag
`isDisabled, setDisabled, setOnBlur, setOnChange, setOnFocus, setOnSelect`

Methods inherited from class HtmlBaseTag
`getJavaScriptAttribute, getOnClick, getTagId, renderDefaultNameAndId, renderNameAndId, setDir, setLang, setOnClick, setOnDblClick, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setStateAttribute, setStyle, setStyleClass, setTagId, setTitle`

Methods inherited from class AbstractClassicTag
`applyNamingChain, getErrorsReport, getIdForTagId, getNearestForm, getNextId, getScriptReporter, getUserLocale, hasErrors, qualifyAttribute, registerTagError, registerTagError, reportAndExit, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write`

Methods inherited from class BodyTagSupport
`doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

Methods inherited from class TagSupport
`findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface Tag
`getParent, setPageContext, setParent`

Constructor Detail

FileUpload

public FileUpload()

Method Detail

getTagName

public String getTagName()

Return the name of the Tag.

Specified by:: getTagName in interface INetuiTag
Specified by:: getTagName in class AbstractClassicTag

Returns:: the name of the tag.

setAttribute

public void setAttribute(String name,
                         String value,
                         String facet)
                  throws JspException

Base support for the attribute tag. This is overridden to prevent setting the type attribute.

Specified by:: setAttribute in interface IAttributeConsumer
Overrides:: setAttribute in class HtmlBaseTag

Parameters:: name - The name of the attribute. This value may not be null or the empty string.; value - The value of the attribute. This may contain an expression.; facet - The name of a facet to which the attribute will be applied. This is optional.
Throws:: JspException - A JspException may be thrown if there is an error setting the attribute.

getState

protected AbstractHtmlState getState()

This method will return the state associated with the tag. This is used by this base class to access the individual state objects created by the tags.

Specified by:: getState in class HtmlBaseTag

Returns:: a subclass of the AbstractHtmlState class.

setAccept

public void setAccept(String accept)

Set the mime-types accepted for the FileUpload.

Parameters:: accept - the accepted mime-types

setReadonly

public void setReadonly(boolean readonly)

Set if this FileUpload is read-only.

Parameters:: readonly - the read-only state

setSize

public void setSize(String size)

Set the size (in characters) of the FileUpload.

Parameters:: size - the size

setTabindex

public void setTabindex(int tabindex)

Sets the tabIndex of the rendered html tag.

Parameters:: tabindex - the tab index.

doStartTag

public int doStartTag()
               throws JspException

Render the fileUpLoad tag. Cause the body to be buffered to look for contained tags.

Specified by:: doStartTag in interface Tag
Overrides:: doStartTag in class BodyTagSupport

Throws:: JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws JspException

Render the FileUpload.

Specified by:: doEndTag in interface Tag
Overrides:: doEndTag in class BodyTagSupport

Throws:: JspException - if a JSP exception has occurred

localRelease

protected void localRelease()

Release any acquired resources.

Overrides:: localRelease in class HtmlDataSourceTag