com.extjs.gxt.ui.client.widget.form
Class FileUploadField

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.form.Field<D>
                      extended by com.extjs.gxt.ui.client.widget.form.TextField<java.lang.String>
                          extended by com.extjs.gxt.ui.client.widget.form.FileUploadField
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class FileUploadField
extends TextField<java.lang.String>

A file upload filed. When using this field, the containing form panel's encoding must be set to MULTIPART using @link FormPanel.setEncoding(Encoding). In addition, the method should be set to POST using FormPanel.setMethod(com.extjs.gxt.ui.client.widget.form.FormPanel.Method)

You must set a name for uploads to work with Firefox.


Nested Class Summary
 class FileUploadField.FileUploadFieldMessages
           
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.TextField
TextField.TextFieldMessages
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field
Field.FieldImages, Field.FieldMessages
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.TextField
emptyStyle, impl, input, validator
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field
autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
FileUploadField()
          Creates a new file upload field.
 
Method Summary
protected  void afterRender()
          Called after the component has been rendered and is attached for the first time.
protected  void createFileInput()
           
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 java.lang.String getAccept()
          A comma-separated list of content types that a server processing this form will handle correctly.
 com.google.gwt.user.client.ui.AbstractImagePrototype getButtonIconStyle()
          Returns the button icon class.
 int getButtonOffset()
          Returns the button offset.
 com.google.gwt.dom.client.InputElement getFileInput()
          Returns the file input element.
protected  El getFocusEl()
           
protected  El getInputEl()
          Provides support for wrapping the actual input element.
 FileUploadField.FileUploadFieldMessages getMessages()
          Returns the field's messages.
 java.lang.String getName()
          Returns the name attribute of the field if available.
protected  El getStyleEl()
           
protected  void onBlur(ComponentEvent ce)
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
          Components delegate event handling to Component.onComponentEvent(ComponentEvent).
protected  void onChange(ComponentEvent ce)
           
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onDetach()
           
protected  void onFocus(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onResize(int width, int height)
          Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
 void reset()
          Resets the current field value to the originally loaded value and clears any validation messages.
 void setAccept(java.lang.String accept)
          A comma-separated list of content types that a server processing this form will handle correctly.
 void setButtonIcon(com.google.gwt.user.client.ui.AbstractImagePrototype buttonIconStyle)
          Sets the button icon class.
 void setButtonOffset(int buttonOffset)
          Sets the number of pixels between the input element and the browser button (defaults to 3).
 void setName(java.lang.String name)
          Sets the field's HTML name attribute.
 void setReadOnly(boolean readOnly)
          Sets the field's read only state.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.TextField
adjustInputSize, applyEmptyText, getAllowBlank, getCursorPos, getMaxLength, getMinLength, getRegex, getSelectedText, getSelectionLength, getSelectOnFocus, getValidator, isPassword, removeEmptyText, select, selectAll, setAllowBlank, setAriaState, setCursorPos, setEmptyText, setMaxLength, setMinLength, setPassword, setRegex, setSelectionRange, setSelectOnFocus, setValidator, setValue, validateValue
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field
addInputStyleName, addKeyListener, alignErrorIcon, clear, clearInvalid, createComponentEvent, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessageTarget, getOriginalValue, getPropertyEditor, getRawValue, getValidateOnBlur, getValidationDelay, getValue, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, markInvalid, onClick, onDisable, onEnable, onHide, onKeyDown, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, setAutoValidate, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setOriginalValue, setPropertyEditor, setRawValue, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validate
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileUploadField

public FileUploadField()
Creates a new file upload field.

Method Detail

getAccept

public java.lang.String getAccept()
A comma-separated list of content types that a server processing this form will handle correctly.


getButtonIconStyle

public com.google.gwt.user.client.ui.AbstractImagePrototype getButtonIconStyle()
Returns the button icon class.


getButtonOffset

public int getButtonOffset()
Returns the button offset.


getFileInput

public com.google.gwt.dom.client.InputElement getFileInput()
Returns the file input element. You should not store a reference to this. When resetting this field the file input will change.


getMessages

public FileUploadField.FileUploadFieldMessages getMessages()
Description copied from class: Field
Returns the field's messages.

Overrides:
getMessages in class TextField<java.lang.String>
Returns:
the messages

getName

public java.lang.String getName()
Description copied from class: Field
Returns the name attribute of the field if available.

Overrides:
getName in class Field<java.lang.String>
Returns:
the field name

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)
Description copied from class: Component
Components delegate event handling to Component.onComponentEvent(ComponentEvent). Subclasses should not override.

Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class Component
Parameters:
event - the dom event

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class TextField<java.lang.String>
Parameters:
ce - the base event

reset

public void reset()
Description copied from class: Field
Resets the current field value to the originally loaded value and clears any validation messages.

Overrides:
reset in class Field<java.lang.String>

setAccept

public void setAccept(java.lang.String accept)
A comma-separated list of content types that a server processing this form will handle correctly.


setButtonIcon

public void setButtonIcon(com.google.gwt.user.client.ui.AbstractImagePrototype buttonIconStyle)
Sets the button icon class.

Parameters:
buttonIconStyle - the button icon style

setButtonOffset

public void setButtonOffset(int buttonOffset)
Sets the number of pixels between the input element and the browser button (defaults to 3).


setName

public void setName(java.lang.String name)
Description copied from class: Field
Sets the field's HTML name attribute.

Overrides:
setName in class Field<java.lang.String>
Parameters:
name - the name

setReadOnly

public void setReadOnly(boolean readOnly)
Description copied from class: Field
Sets the field's read only state.

Overrides:
setReadOnly in class Field<java.lang.String>
Parameters:
readOnly - the read only state

afterRender

protected void afterRender()
Description copied from class: Component
Called after the component has been rendered and is attached for the first time. At this time, the component will be part of the DOM which is required when retrieving location and offsets.

Overrides:
afterRender in class Field<java.lang.String>

createFileInput

protected void createFileInput()

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Component

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Field<java.lang.String>

getFocusEl

protected El getFocusEl()
Overrides:
getFocusEl in class TextField<java.lang.String>

getInputEl

protected El getInputEl()
Description copied from class: Field
Provides support for wrapping the actual input element.

Overrides:
getInputEl in class TextField<java.lang.String>
Returns:
the input element

getStyleEl

protected El getStyleEl()
Overrides:
getStyleEl in class TextField<java.lang.String>

onBlur

protected void onBlur(ComponentEvent ce)
Overrides:
onBlur in class TextField<java.lang.String>

onChange

protected void onChange(ComponentEvent ce)

onDetach

protected void onDetach()
Overrides:
onDetach in class Field<java.lang.String>

onFocus

protected void onFocus(ComponentEvent ce)
Overrides:
onFocus in class TextField<java.lang.String>

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class TextField<java.lang.String>
Parameters:
target - the target element
index - the insert location

onResize

protected void onResize(int width,
                        int height)
Description copied from class: BoxComponent
Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:
onResize in class TextField<java.lang.String>
Parameters:
width - the width
height - the height