Class BaseClientElement
- java.lang.Object
-
- org.apache.tapestry5.corelib.base.BaseClientElement
-
- All Implemented Interfaces:
ClientElement
- Direct Known Subclasses:
Alerts
public abstract class BaseClientElement extends java.lang.Object implements ClientElement
Provides support for elements that will optionally render a uniqueid
attribute, but only if it is requested. Subclasses should invokestoreElement(org.apache.tapestry5.dom.Element)
when they begin an element that requires an id.- Since:
- 5.4
-
-
Field Summary
Fields Modifier and Type Field Description protected JavaScriptSupport
javaScriptSupport
protected ComponentResources
resources
-
Constructor Summary
Constructors Constructor Description BaseClientElement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.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.protected void
storeElement(Element element)
Invoked (usually from aBeginRender
phase method) to assign the element, and clear the clientId (only relevant for components that render in a loop).
-
-
-
Field Detail
-
resources
@Inject protected ComponentResources resources
-
javaScriptSupport
@Environmental protected JavaScriptSupport javaScriptSupport
-
-
Constructor Detail
-
BaseClientElement
public BaseClientElement()
-
-
Method Detail
-
storeElement
protected void storeElement(Element element)
Invoked (usually from aBeginRender
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 java.lang.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 interfaceClientElement
- 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.
-
-