org.apache.tapestry.link
Class ActionLink

java.lang.Object
  org.apache.tapestry.spec.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.link.AbstractLinkComponent
              org.apache.tapestry.link.ActionLink

All Implemented Interfaces:

ILinkComponent, IAction, IComponent, ILocatable, ILocationHolder, IRender

public abstract class ActionLink
extends AbstractLinkComponent
implements IAction

A component for creating a link that is handled using the action service. [Component Reference]

Version:

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

Author:

Howard Lewis Ship

Constructor Summary

ActionLink()

Method Summary

ILink	getLink(IRequestCycle cycle) Invoked by the ILinkRenderer (if the link is not disabled) to provide a EngineServiceLink that the renderer can convert into a URL.
abstract IActionListener	getListener()
boolean	getRequiresSession() Returns true if the stateful parameter is bound to a true value.
abstract IBinding	getStatefulBinding()

Methods inherited from class org.apache.tapestry.link.AbstractLinkComponent

addEventHandler, cleanupAfterRender, finishLoad, getAnchor, getLink, getRenderer, isDisabled, renderAdditionalAttributes, renderComponent, setRenderer, writeEventHandler, writeEventHandlers

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, 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

Constructor Detail

ActionLink

public ActionLink()

Method Detail

getRequiresSession

public boolean getRequiresSession()

Returns true if the stateful parameter is bound to a true value. If stateful is not bound, also returns the default, true.

Note that this method can be called when the component is not rendering, therefore it must directly access the IBinding for the stateful parameter.

Specified by:

getRequiresSession in interface IAction

getLink

public ILink getLink(IRequestCycle cycle)

Description copied from interface: ILinkComponent

Invoked by the ILinkRenderer (if the link is not disabled) to provide a EngineServiceLink that the renderer can convert into a URL.

Specified by:

getLink in interface ILinkComponent

Overrides:

getLink in class AbstractLinkComponent

getStatefulBinding

public abstract IBinding getStatefulBinding()

getListener

public abstract IActionListener getListener()