org.apache.tapestry5.internal
Interface InternalComponentResources

All Superinterfaces:
ComponentResources, ComponentResourcesCommon, InternalComponentResourcesCommon, Locatable
All Known Implementing Classes:
InternalComponentResourcesImpl

public interface InternalComponentResources
extends ComponentResources, InternalComponentResourcesCommon

An extension of ComponentResources that represents additional methods that are private to the framework and not exposed in any public APIs.


Method Summary
 Object getFieldChange(String fieldName)
          Get the current persisted value of the field.
 ParameterAccess getParameterAccess(String parameterName)
          Gets access object for the parameter.
 boolean hasFieldChange(String fieldName)
          Checks to see if there is a value stored for the indicated field.
 void persistFieldChange(String fieldName, Object newValue)
          Posts a change to a persistent field.
 void postRenderCleanup()
          Allows the resources to cleanup any render-time only data.
 void queueRender(RenderQueue queue)
          Invoked to make the receiver queue itself to be rendered.
 
Methods inherited from interface org.apache.tapestry5.ComponentResources
addPageLifecycleListener, discardPersistentFieldChanges, getAnnotationProvider, getBaseResource, getBlockParameter, getBoundType, getComponent, getComponentModel, getContainer, getContainerMessages, getContainerResources, getElementName, getEmbeddedComponent, getInformalParameter, getInformalParameterNames, getMessages, getPage, getParameterAnnotation, getRenderVariable, isBound, renderInformalParameters, storeRenderVariable
 
Methods inherited from interface org.apache.tapestry5.ComponentResourcesCommon
createActionLink, createEventLink, createFormEventLink, createPageLink, createPageLink, findBlock, getBlock, getBody, getCompleteId, getElementName, getId, getLocale, getLogger, getNestedId, getPageName, hasBody, isRendering, triggerContextEvent, triggerEvent
 
Methods inherited from interface org.apache.tapestry5.ioc.Locatable
getLocation
 
Methods inherited from interface org.apache.tapestry5.internal.InternalComponentResourcesCommon
bindParameter, getBinding, getInformalParameterBindings, getMixinByClassName, isLoaded
 

Method Detail

getFieldChange

Object getFieldChange(String fieldName)
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

boolean hasFieldChange(String fieldName)
Checks to see if there is a value stored for the indicated field.


persistFieldChange

void persistFieldChange(String fieldName,
                        Object newValue)
Posts a change to a persistent field. If the component is still loading, then this change is ignored. Otherwise, it is propagated, via the page to the PersistentFieldManager.


postRenderCleanup

void postRenderCleanup()
Allows the resources to cleanup any render-time only data.


queueRender

void queueRender(RenderQueue queue)
Invoked to make the receiver queue itself to be rendered.


getParameterAccess

ParameterAccess getParameterAccess(String parameterName)
Gets access object for the parameter.

Parameters:
parameterName -
Returns:
object used to read and update the parameter


Copyright © 2006-2009 Apache Software Foundation. All Rights Reserved.