org.apache.tapestry.form
Class LinkSubmit

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

All Implemented Interfaces:

IFormComponent, IComponent, ILocatable, ILocationHolder, IRender

public abstract class LinkSubmit
extends AbstractFormComponent

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

Version:

$Id: Submit.java,v 1.6 2003/04/21 13:15:41 glongman Exp $

Author:

Richard Lewis-Shell

Field Summary

static String	ATTRIBUTE_FUNCTION_NAME The name of an IRequestCycle attribute in which the link submit component that generates the javascript function is stored.
static String	ATTRIBUTE_NAME The name of an IRequestCycle attribute in which the current submit link is stored.

Constructor Summary

LinkSubmit()

Method Summary

abstract IActionListener	getListener()
abstract IBinding	getSelectedBinding()
abstract Object	getTag()
abstract boolean	isDisabled() Returns true if the component is disabled.
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	setDisabled(boolean disabled)
abstract void	setListener(IActionListener listener)
abstract void	setSelectedBinding(IBinding value)
abstract void	setTag(Object tag)

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, prepareForRender, 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

Field Detail

ATTRIBUTE_NAME

public static final 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

ATTRIBUTE_FUNCTION_NAME

public static final String ATTRIBUTE_FUNCTION_NAME

The name of an IRequestCycle attribute 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

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.

setDisabled

public abstract void setDisabled(boolean disabled)

getListener

public abstract IActionListener getListener()

setListener

public abstract void setListener(IActionListener listener)

getTag

public abstract Object getTag()

setTag

public abstract void setTag(Object tag)

setSelectedBinding

public abstract void setSelectedBinding(IBinding value)

getSelectedBinding

public abstract IBinding getSelectedBinding()