org.apache.tapestry.form
Class LinkSubmit

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.LinkSubmit
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, IComponent, IRender

public abstract class LinkSubmit
extends AbstractFormComponent

Implements a component that submits its enclosing form via a JavaScript link. [ Component Reference ]

Author:
Richard Lewis-Shell

Field Summary
static java.lang.String ATTRIBUTE_NAME
          The name of an IRequestCycle attribute in which the current submit link is stored.
 
Constructor Summary
LinkSubmit()
           
 
Method Summary
protected  void cleanupAfterRender(IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.
abstract  IActionListener getAction()
          parameter
protected  boolean getAlwaysRenderBodyOnRewind()
          Returns true; the LinkSubmit's body should render during a rewind, even if the component is itself disabled.
protected  boolean getCanTakeFocus()
          Links can not take focus, ever.
abstract  boolean getDefer()
          parameter
abstract  IActionListener getListener()
          parameter
abstract  ListenerInvoker getListenerInvoker()
          Injected
abstract  java.lang.Object getParameters()
          parameter
abstract  IScript getScript()
           
abstract  java.lang.Object getTag()
          parameter
protected  boolean isClicked(IRequestCycle cycle, java.lang.String name)
          Checks the submit name (FormConstants.SUBMIT_NAME_PARAMETER) to see if it matches this LinkSubmit's assigned element name.
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)
           
abstract  void setSelected(java.lang.Object tag)
          parameter
 
Methods inherited from class org.apache.tapestry.form.AbstractFormComponent
getForm, getIdParameter, getName, isRequired, renderComponent, renderDelegateAttributes, renderDelegatePrefix, renderDelegateSuffix, renderIdAttribute, setClientId, setForm, setName, setName
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, enterActiveState, finishLoad, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, 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.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, 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
 

Field Detail

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME
The name of an IRequestCycle attribute in which the current submit link is stored. LinkSubmits do not nest.

See Also:
Constant Field Values
Constructor Detail

LinkSubmit

public LinkSubmit()
Method Detail

isClicked

protected boolean isClicked(IRequestCycle cycle,
                            java.lang.String name)
Checks the submit name (FormConstants.SUBMIT_NAME_PARAMETER) to see if it matches this LinkSubmit's assigned element name.

Returns:
true if this submit was clicked

getScript

public abstract IScript getScript()

renderFormComponent

protected void renderFormComponent(IMarkupWriter writer,
                                   IRequestCycle cycle)
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)
See Also:
AbstractSubmit.rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

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
See Also:
AbstractComponent.prepareForRender(org.apache.tapestry.IRequestCycle)

cleanupAfterRender

protected void cleanupAfterRender(IRequestCycle cycle)
Description copied from class: AbstractComponent
Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders. This implementation does nothing.

Overrides:
cleanupAfterRender in class AbstractComponent
See Also:
AbstractComponent.cleanupAfterRender(org.apache.tapestry.IRequestCycle)

getCanTakeFocus

protected boolean getCanTakeFocus()
Links can not take focus, ever.

Overrides:
getCanTakeFocus in class AbstractFormComponent

getAlwaysRenderBodyOnRewind

protected boolean getAlwaysRenderBodyOnRewind()
Returns true; the LinkSubmit's body should render during a rewind, even if the component is itself disabled.

Overrides:
getAlwaysRenderBodyOnRewind in class AbstractFormComponent
Returns:
false; override this method to change.

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