Class BaseClientElement

java.lang.Object
org.apache.tapestry5.corelib.base.BaseClientElement
All Implemented Interfaces:
ClientElement
Direct Known Subclasses:
Alerts

public abstract class BaseClientElement extends Object implements ClientElement
Provides support for elements that will optionally render a unique id attribute, but only if it is requested. Subclasses should invoke storeElement(org.apache.tapestry5.dom.Element) when they begin an element that requires an id.
Since:
5.4
  • Field Details

  • Constructor Details

  • Method Details

    • storeElement

      protected void storeElement(Element element)
      Invoked (usually from a BeginRender phase method) to assign the element, and clear the clientId (only relevant for components that render in a loop).
      Parameters:
      element - the element to store
    • getClientId

      public String getClientId()
      When invoked the first time (per request), a unique id is assigned and and id attribute added to the element for the component.
      Specified by:
      getClientId in interface ClientElement
      Returns:
      a unique id for the element. This value will be unique for any given rendering of a page. This value is intended for use as the id attribute of the client-side element, and will be used with any DHTML/Ajax related JavaScript.