org.apache.tapestry.form
Class Button

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.form.AbstractFormComponent
              org.apache.tapestry.form.Button

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IFormComponent, IComponent, IDirectEvent, IRender

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

getCanTakeFocus, getForm, getIdParameter, getName, getRenderBodyOnRewind, 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, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString, triggerEvent

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, getEventInvoker, 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 class: AbstractComponent

Returns the component's client-side element id. This has traditionally been an IFormComponent only binding but now applies to all components. The method should check to see if any id parameter/property has been set already and use that above all others, falling back to IComponent.getId() if nothing else is found.

Specified by:

getClientId in interface IFormComponent

Specified by:

getClientId in interface IComponent

Overrides:

getClientId in class AbstractComponent

Returns:

the id, or null if the component doesn't support a client 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()