com.ibm.xsp.component.xp
Class XspFileUpload

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.ibm.xsp.component.UIFileuploadEx
                      com.ibm.xsp.component.xp.XspFileUpload

All Implemented Interfaces:

FacesInputComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class XspFileUpload
extends UIFileuploadEx

A control that allows users to upload files to the page

XPages Core Controls - File Upload

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.xsp.component.UIFileuploadEx

UIFileuploadEx.UploadedFile

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String

COMPONENT_TYPE

Fields inherited from class com.ibm.xsp.component.UIFileuploadEx

ACCEPT_ATTR, COMPONENT_FAMILY, EXCLUDE_ATTR

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspFileUpload()

Method Summary

java.lang.String	getAccept() Return the value of the accept property.
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getExclude() Return the value of the exclude property.
java.lang.String	getFilename() Return the value of the filename property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getMimetype() Return the value of the mimetype property.
java.lang.String	getOnblur() Return the value of the onblur property.
java.lang.String	getOnchange() Return the value of the onchange property.
java.lang.String	getOnclick() Return the value of the onclick property.
java.lang.String	getOndblclick() Return the value of the ondblclick property.
java.lang.String	getOnfocus() Return the value of the onfocus property.
java.lang.String	getOnkeydown() Return the value of the onkeydown property.
java.lang.String	getOnkeypress() Return the value of the onkeypress property.
java.lang.String	getOnkeyup() Return the value of the onkeyup property.
java.lang.String	getOnmousedown() Return the value of the onmousedown property.
java.lang.String	getOnmousemove() Return the value of the onmousemove property.
java.lang.String	getOnmouseout() Return the value of the onmouseout property.
java.lang.String	getOnmouseover() Return the value of the onmouseover property.
java.lang.String	getOnmouseup() Return the value of the onmouseup property.
java.lang.String	getOnselect() Return the value of the onselect property.
java.lang.String	getRole() Return the value of the role property.
int	getSize() Return the value of the size property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getTabindex() Return the value of the tabindex property.
java.lang.String	getTitle() Return the value of the title property.
boolean	isDisabled() Return the value of the disabled property.
boolean	isReadonly() Return the value of the readonly property.
boolean	isUseUploadname() Return the value of the useUploadname property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setAccept(java.lang.String accept) Set the value of the accept property.
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setExclude(java.lang.String exclude) Set the value of the exclude property.
void	setFilename(java.lang.String filename) Set the value of the filename property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setMimetype(java.lang.String mimetype) Set the value of the mimetype property.
void	setOnblur(java.lang.String onblur) Set the value of the onblur property.
void	setOnchange(java.lang.String onchange) Set the value of the onchange property.
void	setOnclick(java.lang.String onclick) Set the value of the onclick property.
void	setOndblclick(java.lang.String ondblclick) Set the value of the ondblclick property.
void	setOnfocus(java.lang.String onfocus) Set the value of the onfocus property.
void	setOnkeydown(java.lang.String onkeydown) Set the value of the onkeydown property.
void	setOnkeypress(java.lang.String onkeypress) Set the value of the onkeypress property.
void	setOnkeyup(java.lang.String onkeyup) Set the value of the onkeyup property.
void	setOnmousedown(java.lang.String onmousedown) Set the value of the onmousedown property.
void	setOnmousemove(java.lang.String onmousemove) Set the value of the onmousemove property.
void	setOnmouseout(java.lang.String onmouseout) Set the value of the onmouseout property.
void	setOnmouseover(java.lang.String onmouseover) Set the value of the onmouseover property.
void	setOnmouseup(java.lang.String onmouseup) Set the value of the onmouseup property.
void	setOnselect(java.lang.String onselect) Set the value of the onselect property.
void	setReadonly(boolean readonly) Set the value of the readonly property.
void	setRole(java.lang.String role) Set the value of the role property.
void	setSize(int size) Set the value of the size property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTabindex(java.lang.String tabindex) Set the value of the tabindex property.
void	setTitle(java.lang.String title) Set the value of the title property.
void	setUseUploadname(boolean useUploadname) Set the value of the useUploadname property.

Methods inherited from class com.ibm.xsp.component.UIFileuploadEx

getFamily, getRendersChildren, getRequiredMessage, getStyleKitFamily, isDisableClientSideValidation, isDisableModifiedFlag, isDisableValidators, isRequired, setDisableClientSideValidation, setDisableModifiedFlag, setDisableValidators, setRequired, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

XspFileUpload

public XspFileUpload()

Method Detail

getAccept

public java.lang.String getAccept()

Return the value of the accept property. Contents:

Shows a list of MIME types that the file upload control can accept

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getExclude

public java.lang.String getExclude()

Return the value of the exclude property. Contents:

Shows a list of MIME types that the file upload control excludes.

getFilename

public java.lang.String getFilename()

Return the value of the filename property. Contents:

Changes the name of the file that users upload to the page.

Overrides:

getFilename in class UIFileuploadEx

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getMimetype

public java.lang.String getMimetype()

Return the value of the mimetype property. Contents:

Forces the MIME type of the file being uploaded. When this property is empty, it deduces the MIME type from the file extension.

Overrides:

getMimetype in class UIFileuploadEx

getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus

getOnchange

public java.lang.String getOnchange()

Return the value of the onchange property. Contents:

JavaScript code executed when this control loses focus and its value has been modified since gaining focus

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control

getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control

getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus

getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control

getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.

getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control

getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control

getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control

getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control

getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control

getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control

getOnselect

public java.lang.String getOnselect()

Return the value of the onselect property. Contents:

JavaScript code executed when text within this control is selected by the user

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getSize

public int getSize()

Return the value of the size property. Contents:

%/com.ibm.xsp.InputText/size/descr%

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

isDisabled

public boolean isDisabled()

Return the value of the disabled property. Contents:

Determines whether or not the page can receive focus or be included in page submissions.

isReadonly

public boolean isReadonly()

Return the value of the readonly property. Contents:

Flag indicating that this control will prohibit changes by the user. The control may receive focus unless it has also been disabled.

isUseUploadname

public boolean isUseUploadname()

Return the value of the useUploadname property. Contents:

Indicates to use the original name of the uploaded file.

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UIFileuploadEx

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIFileuploadEx

setAccept

public void setAccept(java.lang.String accept)

Set the value of the accept property.

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

setExclude

public void setExclude(java.lang.String exclude)

Set the value of the exclude property.

setFilename

public void setFilename(java.lang.String filename)

Set the value of the filename property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setMimetype

public void setMimetype(java.lang.String mimetype)

Set the value of the mimetype property.

setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.

setOnchange

public void setOnchange(java.lang.String onchange)

Set the value of the onchange property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.

setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.

setOnselect

public void setOnselect(java.lang.String onselect)

Set the value of the onselect property.

setReadonly

public void setReadonly(boolean readonly)

Set the value of the readonly property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setSize

public void setSize(int size)

Set the value of the size property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

setUseUploadname

public void setUseUploadname(boolean useUploadname)

Set the value of the useUploadname property.