com.primix.tapestry.link
Class Action

java.lang.Object
  |
  +--com.primix.tapestry.AbstractComponent
        |
        +--com.primix.tapestry.link.AbstractServiceLink
              |
              +--com.primix.tapestry.link.Action
All Implemented Interfaces:
IAction, IComponent, IRender, IServiceLink

public class Action
extends AbstractServiceLink
implements IAction

A component for creating a link that is handled using the action service.
Parameter Type Read / Write Required Default Description
listener IActionListener R no   Specifies an object that is notified when the link is clicked, for services that require a listener.
disabled boolean R No true Controls whether the link is produced. If disabled, the portion of the template the link surrounds is still rendered, but not the link itself.
stateful boolean R no true If true (the default), then the component requires an active (i.e., non-new) HttpSession when triggered. Failing that, it throws a StaleLinkException. If false, then no check is necessary. The latter works well with links that encode all necessary state inside the URL itself.
scheme java.lang.String R no   If specified, then a longer URL (including scheme, server and possibly port) is generated using the specified scheme. Server is determined fromt he incoming request, and port is deterimined from the port paramter or the incoming request.
port int R no   If specified, then a longer URL (including scheme, server and port) is generated using the specified port. The server is determined from the incoming request, the scheme from the scheme paramter or the incoming request.
anchor java.lang.String R no   The name of an anchor or element to link to. The final URL will have '#' and the anchor appended to it.

Informal parameters are allowed.

Version:
$Id: Action.java,v 1.10 2001/08/28 20:33:42 hship Exp $
Author:
Howard Ship

Fields inherited from class com.primix.tapestry.AbstractComponent
id, page, specification, wrapped, wrappedCount
 
Fields inherited from interface com.primix.tapestry.components.IServiceLink
ATTRIBUTE_NAME
 
Constructor Summary
Action()
           
 
Method Summary
protected  java.lang.String[] getContext(IRequestCycle cycle)
          Invoked by AbstractServiceLink.render(IResponseWriter, IRequestCycle) if the component is enabled.
 IBinding getListenerBinding()
           
 boolean getRequiresSession()
          Returns true if the stateful parameter is bound to a true value.
protected  java.lang.String getServiceName(IRequestCycle cycle)
          Returns IEngineService.ACTION_SERVICE.
 IBinding getStatefulBinding()
           
 void setListenerBinding(IBinding value)
           
 void setStatefulBinding(IBinding value)
           
 
Methods inherited from class com.primix.tapestry.link.AbstractServiceLink
addEventHandler, buildURL, getAnchorBinding, getDisabledBinding, getPortBinding, getSchemeBinding, isDisabled, render, setAnchorBinding, setDisabledBinding, setPortBinding, setSchemeBinding, setup
 
Methods inherited from class com.primix.tapestry.AbstractComponent
addAsset, addComponent, addWrapped, cleanupAfterRender, cleanupComponent, finishLoad, finishLoad, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, fireObservedChange, generateAttributes, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getChangeObserver, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getListeners, getPage, getSpecification, prepareForRender, renderWrapped, reset, setBinding, setContainer, setId, setPage, setSpecification, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.primix.tapestry.IComponent
addAsset, addComponent, addWrapped, finishLoad, getAsset, getAssets, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainer, getExtendedId, getId, getIdPath, getPage, getSpecification, renderWrapped, setBinding, setContainer, setId, setPage, setSpecification
 
Methods inherited from interface com.primix.tapestry.IRender
render
 

Constructor Detail

Action

public Action()
Method Detail

getListenerBinding

public IBinding getListenerBinding()

setListenerBinding

public void setListenerBinding(IBinding value)

setStatefulBinding

public void setStatefulBinding(IBinding value)

getStatefulBinding

public IBinding getStatefulBinding()

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.
Specified by:
getRequiresSession in interface IAction

getServiceName

protected java.lang.String getServiceName(IRequestCycle cycle)
Returns IEngineService.ACTION_SERVICE.
Overrides:
getServiceName in class AbstractServiceLink
Following copied from class: com.primix.tapestry.link.AbstractServiceLink
See Also:
AbstractServiceLink.buildURL(IRequestCycle, String[])

getContext

protected java.lang.String[] getContext(IRequestCycle cycle)
                                 throws RequestCycleException
Description copied from class: AbstractServiceLink
Invoked by AbstractServiceLink.render(IResponseWriter, IRequestCycle) if the component is enabled. The default implementation returns null; other implementations can provide appropriate parameters as needed.
Overrides:
getContext in class AbstractServiceLink