org.apache.tapestry.form
Class LinkSubmit

java.lang.Object
  extended byorg.apache.hivemind.impl.BaseLocatable
      extended byorg.apache.tapestry.AbstractComponent
          extended byorg.apache.tapestry.form.AbstractFormComponent
              extended byorg.apache.tapestry.form.AbstractSubmit
                  extended byorg.apache.tapestry.form.LinkSubmit
All Implemented Interfaces:
IComponent, IFormComponent, IRender, org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder

public abstract class LinkSubmit
extends org.apache.tapestry.form.AbstractSubmit

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_FUNCTION_NAME
          The name of an IRequestCycleattribute in which the link submit component that generates the javascript function is stored.
static java.lang.String ATTRIBUTE_NAME
          The name of an IRequestCycleattribute in which the current submit link is stored.
 
Constructor Summary
LinkSubmit()
           
 
Method Summary
abstract  boolean getDefer()
          parameter
abstract  IActionListener getListener()
          parameter
abstract  ListenerInvoker getListenerInvoker()
          Injected
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.
abstract  boolean isDisabled()
          parameter
protected  void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to actually render the component (with any parameter values already set).
abstract  void setSelected(java.lang.Object tag)
          parameter
protected  void writeTag(IMarkupWriter writer, IRequestCycle cycle, java.lang.String name)
          Write the tag (and any nested content) for this submit component.
 
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, checkActiveLock, cleanupAfterRender, enterActiveState, finishLoad, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, 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.IComponent
addAsset, addBody, addComponent, enterActiveState, finishLoad, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, 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
 

Field Detail

ATTRIBUTE_NAME

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

See Also:
Constant Field Values

ATTRIBUTE_FUNCTION_NAME

public static final java.lang.String ATTRIBUTE_FUNCTION_NAME
The name of an IRequestCycleattribute in which the link submit component that generates the javascript function is stored. The function is only required once per page (containing a form with a non-disabled LinkSubmit)

See Also:
Constant Field Values
Constructor Detail

LinkSubmit

public LinkSubmit()
Method Detail

isClicked

protected boolean isClicked(IRequestCycle cycle,
                            java.lang.String name)
Description copied from class: org.apache.tapestry.form.AbstractSubmit
Determine if this submit component was clicked.

Parameters:
cycle -
name -
Returns:
true if this submit was clicked

writeTag

protected void writeTag(IMarkupWriter writer,
                        IRequestCycle cycle,
                        java.lang.String name)
Description copied from class: org.apache.tapestry.form.AbstractSubmit
Write the tag (and any nested content) for this submit component.

Parameters:
writer -
cycle -
name -

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.


isDisabled

public abstract boolean isDisabled()
parameter


getListener

public abstract IActionListener getListener()
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