org.apache.tapestry.form
Class Button

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

public abstract class Button
extends AbstractFormComponent

Implements a component that manages an HTML <input type=button> form element. [ Component Reference ]

This component is useful for attaching JavaScript onclick event handlers.

Author:
Howard Lewis Ship, Paul Geerts, Malcolm Edgar, Paul Ferraro

Constructor Summary
Button()
           
 
Method Summary
 java.lang.String getClientId()
          Returns the component's client-side element id.
 java.lang.String getDisplayName()
          May be implemented to return a user-presentable, localized name for the component, which is used in labels or error messages.
abstract  java.lang.String getLabel()
           
 boolean isDisabled()
          Returns true if the component is disabled.
protected  void renderFormComponent(IMarkupWriter writer, IRequestCycle cycle)
           
protected  void rewindFormComponent(IMarkupWriter writer, IRequestCycle cycle)
           
 
Methods inherited from class org.apache.tapestry.form.AbstractFormComponent
getAlwaysRenderBodyOnRewind, getCanTakeFocus, 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, cleanupAfterRender, 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, prepareForRender, 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.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
 

Constructor Detail

Button

public Button()
Method Detail

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)
Specified by:
rewindFormComponent in class AbstractFormComponent
See Also:
AbstractFormComponent.rewindFormComponent(org.apache.tapestry.IMarkupWriter, org.apache.tapestry.IRequestCycle)

getClientId

public java.lang.String getClientId()
Description copied from interface: IFormComponent
Returns the component's client-side element id. Typically, this is specified using an id parameter on the component and is passed through IRequestCycle.getUniqueId(String) to ensure that it is unique. The component is expected to write an id attribute (if it has a non null id). As with IFormComponent.getName(), if a component renders more than once (such as inside a loop) then on each render it will have a different clientId.

Returns:
the id, or null if the component doesn't support an id.
See Also:
IFormComponent.getClientId()

getDisplayName

public java.lang.String getDisplayName()
Description copied from interface: IFormComponent
May be implemented to return a user-presentable, localized name for the component, which is used in labels or error messages. Most components simply return null.

See Also:
IFormComponent.getDisplayName()

isDisabled

public 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.

See Also:
IFormComponent.isDisabled()

getLabel

public abstract java.lang.String getLabel()