org.apache.tapestry.form
Class ImageSubmit

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.form.AbstractFormComponent
              org.apache.tapestry.form.ImageSubmit

All Implemented Interfaces:

IFormComponent, IComponent, ILocatable, ILocationHolder, IRender

public abstract class ImageSubmit
extends AbstractFormComponent

Used to create an image button inside a Form. Although it is occasionally useful to know the Point on the image that was clicked (i.e., use the image as a kind of image map, which was the original intent of the HTML element), it is more commonly used to provide a graphic image for the user to click, rather than the rather plain <input type=submit>. [Component Reference]

Version:

$Id: ImageSubmit.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Lewis Ship

Constructor Summary

ImageSubmit()

Method Summary

abstract IAsset	getDisabledImage()
abstract IAsset	getImage()
abstract IActionListener	getListener()
abstract String	getNameOverride()
abstract IBinding	getPointBinding()
abstract IBinding	getSelectedBinding()
abstract Object	getTag()
abstract boolean	isDisabled() Returns true if the component is disabled.
protected void	prepareForRender(IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to prepare the component to render.
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set).

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

getDisplayName, getForm, getForm, getName, setForm, setName

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, cleanupAfterRender, finishLoad, finishLoad, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, format, format, format, format, formatString, formatString, formatString, formatString, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getChangeObserver, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, pageEndRender, render, renderBody, renderInformalParameters, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification, toString

Methods inherited from class org.apache.tapestry.spec.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.IComponent

addAsset, addBody, addComponent, finishLoad, getAsset, getAssets, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, getString, renderBody, setBinding, setContainer, setId, setNamespace, setPage, setProperty, setSpecification

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.tapestry.ILocationHolder

setLocation

Methods inherited from interface org.apache.tapestry.ILocatable

getLocation

Constructor Detail

ImageSubmit

public ImageSubmit()

Method Detail

getPointBinding

public abstract IBinding getPointBinding()

getSelectedBinding

public abstract IBinding getSelectedBinding()

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to actually render the component (with any parameter values already set). This is the method that subclasses must implement.

Specified by:

renderComponent in class AbstractComponent

isDisabled

public abstract boolean isDisabled()

Description copied from interface: IFormComponent

Returns true if the component is disabled. This is important when the containing form is submitted, since disabled parameters do not update their bindings.

getDisabledImage

public abstract IAsset getDisabledImage()

getImage

public abstract IAsset getImage()

getListener

public abstract IActionListener getListener()

getTag

public abstract Object getTag()

getNameOverride

public abstract String getNameOverride()

prepareForRender

protected void prepareForRender(IRequestCycle cycle)

Description copied from class: AbstractComponent

Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle) to prepare the component to render. This implementation sets JavaBeans properties from matching bound parameters. Subclasses that override this method must invoke this implementation as well.

Overrides:

prepareForRender in class AbstractComponent