org.apache.tapestry.form
Class Upload

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.form.AbstractFormComponent
              extended by org.apache.tapestry.form.AbstractRequirableField
                  extended by org.apache.tapestry.form.Upload
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, RequirableField, IComponent, IRender

public abstract class Upload
extends AbstractRequirableField

Form element used to upload files. [ Component Reference ] As of 4.0, the Upload field can indicate that it is required.

Since:
1.0.8
Author:
Howard Lewis Ship, Paul Ferraro

Constructor Summary
Upload()
           
 
Method Summary
 void bind(IMarkupWriter writer, IRequestCycle cycle)
          Called on the field if the required field check succeeds.
protected  void finishLoad()
          Invoked, as a convienience, from AbstractComponent.finishLoad(IRequestCycle, IPageLoader, IComponentSpecification).
abstract  MultipartDecoder getDecoder()
           
 java.lang.String getSubmittedValue(IRequestCycle cycle)
          Retrieves a simplified view of the value submitted for this component.
protected  void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
           
abstract  void setFile(IUploadFile file)
           
 
Methods inherited from class org.apache.tapestry.form.AbstractRequirableField
getRequirableFieldSupport, rewindFormComponent, setRequiredMessage
 
Methods inherited from class org.apache.tapestry.form.AbstractFormComponent
getForm, getIdParameter, getName, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, renderIdAttribute, select, setClientId, setForm, setName, setName
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, toString
 
Methods inherited from class org.apache.hivemind.impl.BaseLocatable
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.tapestry.form.RequirableField
getRequiredMessage, isRequired
 
Methods inherited from interface org.apache.tapestry.form.IFormComponent
getClientId, getDisplayName, getForm, getName, isDisabled, setName
 
Methods inherited from interface org.apache.tapestry.IComponent
addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainer, setId, setNamespace, setPage, setProperty
 
Methods inherited from interface org.apache.tapestry.IRender
render
 
Methods inherited from interface org.apache.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Constructor Detail

Upload

public Upload()
Method Detail

bind

public void bind(IMarkupWriter writer,
                 IRequestCycle cycle)
          throws ValidatorException
Description copied from interface: RequirableField
Called on the field if the required field check succeeds.

Throws:
ValidatorException - if required field check fails.
See Also:
org.apache.tapestry.form.validator.AbstractRequirableField#bind(org.apache.tapestry.IRequestCycle)

finishLoad

protected void finishLoad()
Description copied from class: AbstractComponent
Invoked, as a convienience, from AbstractComponent.finishLoad(IRequestCycle, IPageLoader, IComponentSpecification). This implemenation does nothing. Subclasses may override without invoking this implementation.

Overrides:
finishLoad in class AbstractComponent
See Also:
AbstractComponent.finishLoad()

getSubmittedValue

public java.lang.String getSubmittedValue(IRequestCycle cycle)
Description copied from interface: RequirableField
Retrieves a simplified view of the value submitted for this component. Used during required field checking.

Specified by:
getSubmittedValue in interface RequirableField
Overrides:
getSubmittedValue in class AbstractRequirableField
See Also:
RequirableField.getSubmittedValue(org.apache.tapestry.IRequestCycle)

renderFormComponent

protected void renderFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)
Overrides:
renderFormComponent in class AbstractRequirableField
See Also:
AbstractFormComponent.renderFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

setFile

public abstract void setFile(IUploadFile file)

getDecoder

public abstract MultipartDecoder getDecoder()