org.apache.tapestry.form
Class ImageSubmit

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.Submit
                  extended by org.apache.tapestry.form.ImageSubmit
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, IComponent, IDirectEvent, IRender

public abstract class ImageSubmit
extends Submit

Used to create an image button inside a Form. Although it is occasionally useful to know the Pointon 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 ]

Author:
Howard Lewis Ship

Constructor Summary
ImageSubmit()
           
 
Method Summary
abstract  IActionListener getAction()
          parameter.
abstract  boolean getDefer()
          parameter.
abstract  IAsset getDisabledImage()
          parameter.
abstract  IAsset getImage()
          parameter.
abstract  IActionListener getListener()
          parameter.
abstract  ListenerInvoker getListenerInvoker()
          Injected.
abstract  java.lang.String getNameOverride()
          parameter.
abstract  java.lang.Object getParameters()
          parameter.
abstract  java.lang.Object getTag()
          parameter.
protected  boolean isClicked(IRequestCycle cycle, java.lang.String name)
          Determine if this submit component was clicked.
protected  void prepareForRender(IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to prepare the component to render.
protected  void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
           
protected  void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle)
           
protected  void setName(IForm form)
           
abstract  void setPoint(java.awt.Point point)
          parameter.
abstract  void setSelected(java.lang.Object tag)
          parameter.
 
Methods inherited from class org.apache.tapestry.form.Submit
getLabel
 
Methods inherited from class org.apache.tapestry.form.AbstractFormComponent
getCanTakeFocus, getForm, getIdParameter, getName, getRenderBodyOnRewind, isRequired, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, renderIdAttribute, setClientId, setForm, setName
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, finishLoad, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString, triggerEvent
 
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.IFormComponent
getClientId, getDisplayName, isDisabled
 
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, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainedComponent, 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

ImageSubmit

public ImageSubmit()
Method Detail

setName

protected void setName(IForm form)
Overrides:
setName in class AbstractFormComponent
See Also:
AbstractFormComponent.setName(org.apache.tapestry.IForm)

isClicked

protected boolean isClicked(IRequestCycle cycle,
                            java.lang.String name)
Determine if this submit component was clicked.

Overrides:
isClicked in class Submit
Returns:
true if this submit was clicked

renderFormComponent

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

getDisabledImage

public abstract IAsset getDisabledImage()
parameter.


getImage

public abstract IAsset getImage()
parameter.


getNameOverride

public abstract java.lang.String getNameOverride()
parameter.


setPoint

public abstract void setPoint(java.awt.Point point)
parameter.


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. This implementation does nothing.

Overrides:
prepareForRender in class AbstractComponent

rewindFormComponent

protected void rewindFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)
Specified by:
rewindFormComponent in class AbstractFormComponent
See Also:
AbstractFormComponent.rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

getListener

public abstract IActionListener getListener()
parameter.


getAction

public abstract IActionListener getAction()
parameter.


getTag

public abstract java.lang.Object getTag()
parameter.


setSelected

public abstract void setSelected(java.lang.Object tag)
parameter.


getDefer

public abstract boolean getDefer()
parameter.


getParameters

public abstract java.lang.Object getParameters()
parameter.


getListenerInvoker

public abstract ListenerInvoker getListenerInvoker()
Injected.



Copyright © 2006 Apache Software Foundation. All Rights Reserved.