Package org.apache.tapestry5.internal
Interface InternalComponentResources
- All Superinterfaces:
ComponentResources,ComponentResourcesCommon,InternalComponentResourcesCommon,Locatable,RenderCommand
- All Known Implementing Classes:
InternalComponentResourcesImpl
public interface InternalComponentResources
extends ComponentResources, InternalComponentResourcesCommon, RenderCommand
An extension of
ComponentResources that represents additional
methods that are private
to the framework and not exposed in any public APIs.-
Method Summary
Modifier and TypeMethodDescriptionvoidaddPageResetListener(PageResetListener listener) getFieldChange(String fieldName) Get the current persisted value of the field.getParameterConduit(String parameterName) Gets a previously stored ParameterConduit, allowing PCs to be shared between a component and a mixin of that component.getPropertyName(String parameterName) Returns the name of the bound property ifPropBindingis used and the expression points to a property on a bean (e.g.booleanhasFieldChange(String fieldName) Checks to see if there is a value stored for the indicated field.voidpersistFieldChange(String fieldName, Object newValue) Posts a change to a persistent field.voidAllows the resources to cleanup any render-time only data.voidsetParameterConduit(String parameterName, ParameterConduit conduit) Stores a ParameterConduit for later access.Methods inherited from interface org.apache.tapestry5.ComponentResources
addPageLifecycleListener, discardPersistentFieldChanges, getAnnotationProvider, getBaseResource, getBlockParameter, getBoundGenericType, getBoundType, getComponent, getComponentModel, getContainer, getContainerMessages, getContainerResources, getElementName, getEmbeddedComponent, getInformalParameter, getInformalParameterNames, getMessages, getPage, getPageLifecycleCallbackHub, getParameterAnnotation, getRenderVariable, isBound, isMixin, removePageLifecycleListener, renderInformalParameters, storeRenderVariableMethods inherited from interface org.apache.tapestry5.ComponentResourcesCommon
createEventLink, createFormEventLink, findBlock, getBlock, getBody, getCompleteId, getElementName, getId, getLocale, getLogger, getNestedId, getPageName, getResourceSelector, hasBody, isRendering, triggerContextEvent, triggerEventMethods inherited from interface org.apache.tapestry5.internal.InternalComponentResourcesCommon
bindParameter, getBinding, getInformalParameterBindings, getMixinByClassName, isLoadedMethods inherited from interface org.apache.tapestry5.commons.Locatable
getLocationMethods inherited from interface org.apache.tapestry5.runtime.RenderCommand
render
-
Method Details
-
getFieldChange
Get the current persisted value of the field.- Parameters:
fieldName- the name of the field to access- Returns:
- the value stored for the field, or null if no value is currently stored
-
hasFieldChange
Checks to see if there is a value stored for the indicated field. -
persistFieldChange
Posts a change to a persistent field. If the component is still loading, then this change is ignored. Otherwise, it is propagated, via thepageto thePersistentFieldManager. -
postRenderCleanup
void postRenderCleanup()Allows the resources to cleanup any render-time only data. -
addPageResetListener
- Parameters:
listener- to register
-
getParameterConduit
Gets a previously stored ParameterConduit, allowing PCs to be shared between a component and a mixin of that component.- Since:
- 5.2.0
-
setParameterConduit
Stores a ParameterConduit for later access. Tthis occurs inside a component'sPageLifecycleListener.containingPageDidLoad()lifecycle method.- Since:
- 5.2.0
-
getPropertyName
Returns the name of the bound property ifPropBindingis used and the expression points to a property on a bean (e.g. user.name). Otherwise this method returns null.- Parameters:
parameterName- name of the parameter- Since:
- 5.2.0
-