com.google.gwt.user.client.ui
Class FileUpload

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.FileUpload
All Implemented Interfaces:
HasChangeHandlers, HasHandlers, EventListener, HasName

public class FileUpload
extends Widget
implements HasName, HasChangeHandlers

A widget that wraps the HTML <input type='file'> element. This widget must be used with FormPanel if it is to be submitted to a server.

Example


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
FileUpload()
          Constructs a new file upload widget.
 
Method Summary
 HandlerRegistration addChangeHandler(ChangeHandler handler)
          Adds a ChangeEvent handler.
 java.lang.String getFilename()
          Gets the filename selected by the user.
 java.lang.String getName()
          Gets the widget's name.
 boolean isEnabled()
          Gets whether this widget is enabled.
 void onBrowserEvent(Event event)
          Fired whenever a browser event is received.
 void setEnabled(boolean enabled)
          Sets whether this widget is enabled.
 void setName(java.lang.String name)
          Sets the widget's name.
static FileUpload wrap(Element element)
          Creates a FileUpload widget that wraps an existing <input type='file'> element.
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
fireEvent, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

FileUpload

public FileUpload()
Constructs a new file upload widget.

Method Detail

wrap

public static FileUpload wrap(Element element)
Creates a FileUpload widget that wraps an existing <input type='file'> element. This element must already be attached to the document. If the element is removed from the document, you must call RootPanel.detachNow(Widget).

Parameters:
element - the element to be wrapped

addChangeHandler

public HandlerRegistration addChangeHandler(ChangeHandler handler)
Description copied from interface: HasChangeHandlers
Adds a ChangeEvent handler.

Specified by:
addChangeHandler in interface HasChangeHandlers
Parameters:
handler - the change handler
Returns:
HandlerRegistration used to remove this handler

getFilename

public java.lang.String getFilename()
Gets the filename selected by the user. This property has no mutator, as browser security restrictions preclude setting it.

Returns:
the widget's filename

getName

public java.lang.String getName()
Description copied from interface: HasName
Gets the widget's name.

Specified by:
getName in interface HasName
Returns:
the widget's name

isEnabled

public boolean isEnabled()
Gets whether this widget is enabled.

Returns:
true if the widget is enabled

onBrowserEvent

public void onBrowserEvent(Event event)
Description copied from interface: EventListener
Fired whenever a browser event is received.

Specified by:
onBrowserEvent in interface EventListener
Overrides:
onBrowserEvent in class Widget
Parameters:
event - the event received

setEnabled

public void setEnabled(boolean enabled)
Sets whether this widget is enabled.

Parameters:
enabled - true to enable the widget, false to disable it

setName

public void setName(java.lang.String name)
Description copied from interface: HasName
Sets the widget's name.

Specified by:
setName in interface HasName
Parameters:
name - the widget's new name