com.sencha.gxt.widget.core.client.form

Class FileUploadField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.form.FileUploadField

All Implemented Interfaces:

Editor<String>, LeafValueEditor<String>, HasChangeHandlers, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<String>, HasHandlers, EventListener, TakesValue<String>, HasEnabled, HasName, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, IsField<String>, HasFocusSupport, HasItemId

public class FileUploadField
extends Component
implements IsField<String>, HasChangeHandlers, HasName

A file upload field. When using this field, the containing form panel's encoding must be set to MULTIPART using FormPanel.setEncoding(Encoding). In addition, the method should be set to POST using FormPanel.setMethod(Method)

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileUploadField.FileUploadFieldAppearance
static interface	FileUploadField.FileUploadFieldMessages

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

Editor.Ignore, Editor.Path

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
FileUploadField() Creates a new file upload field.
FileUploadField(FileUploadField.FileUploadFieldAppearance appearance) Creates a new file upload field.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addChangeHandler(ChangeHandler handler)
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<String> valueChangeHandler)
void	clear() Clears the value from the field.
void	clearInvalid() Clear any invalid styles / messages for this field.
void	finishEditing() Used to indicate that this field must be completed with its editing process, as it may be able to be removed from the dom, hidden, or its current results used.
FileUploadField.FileUploadFieldAppearance	getAppearance()
List<EditorError>	getErrors() Returns a list of the current errors.
FileUploadField.FileUploadFieldMessages	getMessages() Returns the file upload field messages.
String	getName()
String	getValue()
boolean	isAllowBlank() Returns the field's allow blank state.
boolean	isReadOnly() Returns the read only state.
boolean	isValid() Returns whether or not the field value is currently valid.
boolean	isValid(boolean preventMark) Returns whether or not the field value is currently valid.
void	onBrowserEvent(Event event)
void	reset() Resets the current field value to the originally loaded value and clears any validation messages.
void	setAllowBlank(boolean allowBlank) Sets whether a field is valid when its value length = 0 (default to true).
void	setEnabled(boolean enabled) Convenience function for setting disabled/enabled by boolean.
void	setMessages(FileUploadField.FileUploadFieldMessages messages) Sets the file upload field messages.
void	setName(String name)
void	setReadOnly(boolean readonly) Sets the field's read only state.
void	setValue(String value)
boolean	validate(boolean preventMark) Validates the field value.

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

FileUploadField

public FileUploadField()

Creates a new file upload field.

FileUploadField

public FileUploadField(FileUploadField.FileUploadFieldAppearance appearance)

Creates a new file upload field.

Parameters:

appearance - the appearance

Method Detail

addChangeHandler

public HandlerRegistration addChangeHandler(ChangeHandler handler)

Specified by:

addChangeHandler in interface HasChangeHandlers

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(ValueChangeHandler<String> valueChangeHandler)

Specified by:

addValueChangeHandler in interface HasValueChangeHandlers<String>

clear

public void clear()

Description copied from interface: IsField

Clears the value from the field.

Specified by:

clear in interface IsField<String>

See Also:

to remove validation messages, to restore to original value and remove validation messages

clearInvalid

public void clearInvalid()

Description copied from interface: IsField

Clear any invalid styles / messages for this field.

Specified by:

clearInvalid in interface IsField<String>

finishEditing

public void finishEditing()

Description copied from interface: IsField

Used to indicate that this field must be completed with its editing process, as it may be able to be removed from the dom, hidden, or its current results used.

Specified by:

finishEditing in interface IsField<String>

getAppearance

public FileUploadField.FileUploadFieldAppearance getAppearance()

getErrors

public List<EditorError> getErrors()

Description copied from interface: IsField

Returns a list of the current errors.

Specified by:

getErrors in interface IsField<String>

Returns:

the errors, or empty list if no errors

getMessages

public FileUploadField.FileUploadFieldMessages getMessages()

Returns the file upload field messages.

Returns:

the messages

getName

public String getName()

Specified by:

getName in interface HasName

getValue

public String getValue()

Specified by:

getValue in interface TakesValue<String>

isAllowBlank

public boolean isAllowBlank()

Returns the field's allow blank state.

Returns:

true if blank values are allowed

isReadOnly

public boolean isReadOnly()

Returns the read only state.

Returns:

true if read only, otherwise false

isValid

public boolean isValid()

Returns whether or not the field value is currently valid.

Returns:

true if the value is valid, otherwise false

isValid

public boolean isValid(boolean preventMark)

Description copied from interface: IsField

Returns whether or not the field value is currently valid.

Specified by:

isValid in interface IsField<String>

Parameters:

preventMark - true for silent validation (no invalid event and field is not marked invalid)

Returns:

true if the value is valid, otherwise false

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Component

reset

public void reset()

Description copied from interface: IsField

Resets the current field value to the originally loaded value and clears any validation messages.

Specified by:

reset in interface IsField<String>

setAllowBlank

public void setAllowBlank(boolean allowBlank)

Sets whether a field is valid when its value length = 0 (default to true).

Parameters:

allowBlank - true to allow blanks, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Convenience function for setting disabled/enabled by boolean.

Specified by:

setEnabled in interface HasEnabled

Overrides:

setEnabled in class Component

Parameters:

enabled - the enabled state

setMessages

public void setMessages(FileUploadField.FileUploadFieldMessages messages)

Sets the file upload field messages.

Parameters:

messages - the messages

setName

public void setName(String name)

Specified by:

setName in interface HasName

setReadOnly

public void setReadOnly(boolean readonly)

Sets the field's read only state.

Parameters:

readonly - the read only state

setValue

public void setValue(String value)

Specified by:

setValue in interface TakesValue<String>

validate

public boolean validate(boolean preventMark)

Description copied from interface: IsField

Validates the field value.

Specified by:

validate in interface IsField<String>

Parameters:

preventMark - true to not mark the field valid and fire invalid event when invalid

Returns:

true if valid, otherwise false