org.apache.tapestry.form
Class Upload

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.form.AbstractFormComponent
              org.apache.tapestry.form.Upload

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, ValidatableField, IComponent, IDirectEvent, Component, IRender

public abstract class Upload
extends AbstractFormComponent
implements ValidatableField

Form element used to upload files. [ Component Reference ]

As of 4.0, this component can be validated.

Since:

1.0.8

Author:

Howard Lewis Ship, Paul Ferraro

Field Summary

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Constructor Summary

Upload()

Method Summary

abstract MultipartDecoder	getDecoder() Injected.
abstract ValidatableFieldSupport	getValidatableFieldSupport() Injected.
boolean	isRequired() Returns false.
protected void	renderFormComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to render the component.
protected void	rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to rewind the component.
abstract void	setFile(IUploadFile file)

Methods inherited from class org.apache.tapestry.form.AbstractFormComponent

generateClientId, getCanTakeFocus, getForm, getIdParameter, getName, getRenderBodyOnRewind, peekClientId, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, setForm, setName, setName

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, equals, finishLoad, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainedRenderers, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getInnerRenderers, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tapestry.form.ValidatableField

getValidators

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, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName

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

setFile

public abstract void setFile(IUploadFile file)

renderFormComponent

protected void renderFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)

Description copied from class: AbstractFormComponent

Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to render the component.

Specified by:

renderFormComponent in class AbstractFormComponent

See Also:

AbstractFormComponent.renderFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

rewindFormComponent

protected void rewindFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)

Description copied from class: AbstractFormComponent

Invoked from AbstractFormComponent.renderComponent(IMarkupWriter, IRequestCycle) to rewind the component. If the component is disabled this will not be invoked.

Specified by:

rewindFormComponent in class AbstractFormComponent

See Also:

AbstractFormComponent.rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

getValidatableFieldSupport

public abstract ValidatableFieldSupport getValidatableFieldSupport()

Injected.

getDecoder

public abstract MultipartDecoder getDecoder()

Injected.

isRequired

public boolean isRequired()

Description copied from class: AbstractFormComponent

Returns false. Subclasses that might be required must override this method. Typically, this involves checking against the component's validators.

Specified by:

isRequired in interface IFormComponent

Overrides:

isRequired in class AbstractFormComponent

See Also:

AbstractFormComponent.isRequired()