// Copyright 2006, 2007, 2008, 2009, 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.apache.tapestry5.internal.structure;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.tapestry5.Binding;
import org.apache.tapestry5.Block;
import org.apache.tapestry5.BlockNotFoundException;
import org.apache.tapestry5.ComponentEventCallback;
import org.apache.tapestry5.ComponentResources;
import org.apache.tapestry5.EventContext;
import org.apache.tapestry5.Link;
import org.apache.tapestry5.MarkupWriter;
import org.apache.tapestry5.Renderable;
import org.apache.tapestry5.SymbolConstants;
import org.apache.tapestry5.TapestryMarkers;
import org.apache.tapestry5.annotations.AfterRender;
import org.apache.tapestry5.annotations.AfterRenderBody;
import org.apache.tapestry5.annotations.AfterRenderTemplate;
import org.apache.tapestry5.annotations.BeforeRenderTemplate;
import org.apache.tapestry5.annotations.BeginRender;
import org.apache.tapestry5.annotations.CleanupRender;
import org.apache.tapestry5.annotations.SetupRender;
import org.apache.tapestry5.dom.Element;
import org.apache.tapestry5.internal.AbstractEventContext;
import org.apache.tapestry5.internal.InternalComponentResources;
import org.apache.tapestry5.internal.InternalConstants;
import org.apache.tapestry5.internal.services.ComponentEventImpl;
import org.apache.tapestry5.internal.services.Instantiator;
import org.apache.tapestry5.internal.util.NamedSet;
import org.apache.tapestry5.internal.util.NotificationEventCallback;
import org.apache.tapestry5.ioc.BaseLocatable;
import org.apache.tapestry5.ioc.Invokable;
import org.apache.tapestry5.ioc.Location;
import org.apache.tapestry5.ioc.internal.util.CollectionFactory;
import org.apache.tapestry5.ioc.internal.util.InternalUtils;
import org.apache.tapestry5.ioc.internal.util.Orderer;
import org.apache.tapestry5.ioc.internal.util.TapestryException;
import org.apache.tapestry5.ioc.services.PerThreadValue;
import org.apache.tapestry5.ioc.services.SymbolSource;
import org.apache.tapestry5.ioc.util.AvailableValues;
import org.apache.tapestry5.ioc.util.UnknownValueException;
import org.apache.tapestry5.model.ComponentModel;
import org.apache.tapestry5.model.ParameterModel;
import org.apache.tapestry5.runtime.Component;
import org.apache.tapestry5.runtime.ComponentEvent;
import org.apache.tapestry5.runtime.ComponentEventException;
import org.apache.tapestry5.runtime.Event;
import org.apache.tapestry5.runtime.PageLifecycleListener;
import org.apache.tapestry5.runtime.RenderCommand;
import org.apache.tapestry5.runtime.RenderQueue;
import org.apache.tapestry5.services.Request;
import org.apache.tapestry5.services.pageload.ComponentResourceSelector;
import org.slf4j.Logger;
/**
* Implements {@link RenderCommand} and represents a component within an overall page. Much of a
* component page
* element's behavior is delegated to user code, via a {@link org.apache.tapestry5.runtime.Component} instance.
* <p/>
* Once instantiated, a ComponentPageElement should be registered as a
* {@linkplain org.apache.tapestry5.internal.structure.Page#addLifecycleListener(org.apache.tapestry5.runtime.PageLifecycleListener)
* lifecycle listener}. This could be done inside the constructors, but that tends to complicate unit tests, so its done
* by {@link org.apache.tapestry5.internal.services.PageElementFactoryImpl}. There's still a bit of refactoring in this
* class (and its many inner classes) that can improve overall efficiency.
* <p>
* Modified for Tapestry 5.2 to adjust for the no-pooling approach (shared instances with externalized mutable state).
*/
public class ComponentPageElementImpl extends BaseLocatable implements ComponentPageElement, PageLifecycleListener
{
/**
* Placeholder for the body used when the component has no real content.
*/
private static class PlaceholderBlock implements Block, Renderable
{
public void render(MarkupWriter writer)
{
}
@Override
public String toString()
{
return "<PlaceholderBlock>";
}
}
private static final Block PLACEHOLDER_BLOCK = new PlaceholderBlock();
private static final ComponentCallback RESTORE_STATE_BEFORE_PAGE_ATTACH = new LifecycleNotificationComponentCallback()
{
public void run(Component component)
{
component.restoreStateBeforePageAttach();
}
};
private static final ComponentCallback CONTAINING_PAGE_DID_ATTACH = new LifecycleNotificationComponentCallback()
{
public void run(Component component)
{
component.containingPageDidAttach();
}
};
private static final ComponentCallback CONTAINING_PAGE_DID_DETACH = new LifecycleNotificationComponentCallback()
{
public void run(Component component)
{
component.containingPageDidDetach();
}
};
private static final ComponentCallback CONTAINING_PAGE_DID_LOAD = new LifecycleNotificationComponentCallback()
{
public void run(Component component)
{
component.containingPageDidLoad();
}
};
private static final ComponentCallback POST_RENDER_CLEANUP = new LifecycleNotificationComponentCallback()
{
public void run(Component component)
{
component.postRenderCleanup();
}
};
// For the moment, every component will have a template, even if it consists of
// just a page element to queue up a BeforeRenderBody phase.
private static void pushElements(RenderQueue queue, List<RenderCommand> list)
{
int count = size(list);
for (int i = count - 1; i >= 0; i--)
queue.push(list.get(i));
}
private static int size(List<?> list)
{
return list == null ? 0 : list.size();
}
private abstract class AbstractPhase implements RenderCommand
{
private final String name;
private final boolean reverse;
AbstractPhase(String name)
{
this(name, false);
}
AbstractPhase(String name, boolean reverse)
{
this.name = name;
this.reverse = reverse;
}
@Override
public String toString()
{
return phaseToString(name);
}
void invoke(MarkupWriter writer, Event event)
{
try
{
if (components == null)
{
invokeComponent(coreComponent, writer, event);
return;
}
// Multiple components (i.e., some mixins).
Iterator<Component> i = reverse ? InternalUtils.reverseIterator(components) : components.iterator();
while (i.hasNext())
{
invokeComponent(i.next(), writer, event);
if (event.isAborted())
break;
}
}
catch (RuntimeException ex)
{
throw new TapestryException(ex.getMessage(), getLocation(), ex);
}
}
/**
* Each concrete class implements this method to branch to the corresponding method
* of {@link Component}.
*/
protected abstract void invokeComponent(Component component, MarkupWriter writer, Event event);
}
private class SetupRenderPhase extends AbstractPhase
{
public SetupRenderPhase()
{
super("SetupRender");
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.setupRender(writer, event);
}
public void render(MarkupWriter writer, RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, event.getResult(), beginRenderPhase, cleanupRenderPhase);
event.reset();
}
}
private class BeginRenderPhase extends AbstractPhase
{
private BeginRenderPhase()
{
super("BeginRender");
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
if (isRenderTracingEnabled())
writer.comment("BEGIN " + component.getComponentResources().getCompleteId() + " (" + getLocation()
+ ")");
component.beginRender(writer, event);
}
public void render(final MarkupWriter writer, final RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, afterRenderPhase);
push(queue, event.getResult(), beforeRenderTemplatePhase, null);
event.reset();
}
}
/**
* Replaces {@link org.apache.tapestry5.internal.structure.ComponentPageElementImpl.BeginRenderPhase} when there is
* a handler for AfterRender but not BeginRender.
*/
private class OptimizedBeginRenderPhase implements RenderCommand
{
public void render(MarkupWriter writer, RenderQueue queue)
{
push(queue, afterRenderPhase);
push(queue, beforeRenderTemplatePhase);
}
@Override
public String toString()
{
return phaseToString("OptimizedBeginRenderPhase");
}
}
/**
* Reponsible for rendering the component's template. Even a component that doesn't have a
* template goes through
* this phase, as a synthetic template (used to trigger the rendering of the component's body)
* will be supplied.
*/
private class BeforeRenderTemplatePhase extends AbstractPhase
{
private BeforeRenderTemplatePhase()
{
super("BeforeRenderTemplate");
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.beforeRenderTemplate(writer, event);
}
public void render(final MarkupWriter writer, final RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, afterRenderTemplatePhase);
if (event.getResult())
pushElements(queue, template);
event.reset();
}
}
/**
* Alternative version of BeforeRenderTemplatePhase used when the BeforeRenderTemplate render
* phase is not handled.
*/
private class RenderTemplatePhase implements RenderCommand
{
public void render(MarkupWriter writer, RenderQueue queue)
{
push(queue, afterRenderTemplatePhase);
pushElements(queue, template);
}
@Override
public String toString()
{
return phaseToString("RenderTemplate");
}
}
private class BeforeRenderBodyPhase extends AbstractPhase
{
private BeforeRenderBodyPhase()
{
super("BeforeRenderBody");
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.beforeRenderBody(writer, event);
}
public void render(final MarkupWriter writer, RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, afterRenderBodyPhase);
if (event.getResult() && bodyBlock != null)
queue.push(bodyBlock);
event.reset();
}
}
private class AfterRenderBodyPhase extends AbstractPhase
{
private AfterRenderBodyPhase()
{
super("AfterRenderBody", true);
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.afterRenderBody(writer, event);
}
public void render(final MarkupWriter writer, RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, event.getResult(), null, beforeRenderBodyPhase);
event.reset();
}
}
private class AfterRenderTemplatePhase extends AbstractPhase
{
private AfterRenderTemplatePhase()
{
super("AfterRenderTemplate", true);
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.afterRenderTemplate(writer, event);
}
public void render(final MarkupWriter writer, final RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, event.getResult(), null, beforeRenderTemplatePhase);
event.reset();
}
}
private class AfterRenderPhase extends AbstractPhase
{
private AfterRenderPhase()
{
super("AfterRender", true);
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.afterRender(writer, event);
if (isRenderTracingEnabled())
writer.comment("END " + component.getComponentResources().getCompleteId());
}
public void render(final MarkupWriter writer, RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, event.getResult(), cleanupRenderPhase, beginRenderPhase);
event.reset();
}
}
private class CleanupRenderPhase extends AbstractPhase
{
private CleanupRenderPhase()
{
super("CleanupRender", true);
}
protected void invokeComponent(Component component, MarkupWriter writer, Event event)
{
component.cleanupRender(writer, event);
}
public void render(final MarkupWriter writer, RenderQueue queue)
{
RenderPhaseEvent event = createRenderEvent(queue);
invoke(writer, event);
push(queue, event.getResult(), null, setupRenderPhase);
event.reset();
}
}
private class PostRenderCleanupPhase implements RenderCommand
{
/**
* Used to detect mismatches calls to {@link MarkupWriter#element(String, Object[])} and
* {@link org.apache.tapestry5.MarkupWriter#end()}. The expectation is that any element(s)
* begun by this component
* during rendering will be balanced by end() calls, resulting in the current element
* reverting to its initial
* value.
*/
private final Element expectedElementAtCompletion;
PostRenderCleanupPhase(Element expectedElementAtCompletion)
{
this.expectedElementAtCompletion = expectedElementAtCompletion;
}
public void render(MarkupWriter writer, RenderQueue queue)
{
rendering.set(false);
Element current = writer.getElement();
if (current != expectedElementAtCompletion)
throw new TapestryException(StructureMessages.unbalancedElements(completeId), getLocation(), null);
invoke(false, POST_RENDER_CLEANUP);
queue.endComponent();
}
@Override
public String toString()
{
return phaseToString("PostRenderCleanup");
}
}
private NamedSet<Block> blocks;
private BlockImpl bodyBlock;
private List<ComponentPageElement> children;
private final String elementName;
private final Logger eventLogger;
private final String completeId;
// The user-provided class, with runtime code enhancements. In a component with mixins, this
// is the component to which the mixins are attached.
private final Component coreComponent;
/**
* Component lifecycle instances for all mixins; the core component is added to this list during
* page load. This is only used in the case that a component has mixins (in which case, the core component is
* listed last).
*/
private List<Component> components = null;
private final ComponentPageElementResources elementResources;
private final ComponentPageElement container;
private final InternalComponentResources coreResources;
private final String id;
private Orderer<Component> mixinBeforeOrderer;
private Orderer<Component> mixinAfterOrderer;
private boolean loaded;
/**
* Map from mixin id (the simple name of the mixin class) to resources for the mixin. Created
* when first mixin is added.
*/
private NamedSet<InternalComponentResources> mixinIdToComponentResources;
private final String nestedId;
private final Page page;
private final PerThreadValue<RenderPhaseEvent> renderEvent;
private final PerThreadValue<Boolean> rendering;
// should be okay since it's a shadow service object
private final Request request;
private final SymbolSource symbolSource;
private final boolean productionMode;
private final boolean componentTracingEnabled;
// We know that, at the very least, there will be an element to force the component to render
// its body, so there's no reason to wait to initialize the list.
private final List<RenderCommand> template = CollectionFactory.newList();
private RenderCommand setupRenderPhase, beginRenderPhase, beforeRenderTemplatePhase, beforeRenderBodyPhase,
afterRenderBodyPhase, afterRenderTemplatePhase, afterRenderPhase, cleanupRenderPhase;
/**
* Constructor for other components embedded within the root component or at deeper levels of
* the hierarchy.
*
* @param page
* ultimately containing this component
* @param container
* component immediately containing this component (may be null for a root component)
* @param id
* unique (within the container) id for this component (may be null for a root
* component)
* @param elementName
* the name of the element which represents this component in the template, or null
* for
* <comp> element or a page component
* @param instantiator
* used to create the new component instance and access the component's model
* @param location
* location of the element (within a template), used as part of exception reporting
* @param elementResources
* Provides access to common methods of various services
*/
ComponentPageElementImpl(Page page, ComponentPageElement container, String id, String nestedId, String completeId,
String elementName, Instantiator instantiator, Location location,
ComponentPageElementResources elementResources, Request request, SymbolSource symbolSource)
{
super(location);
this.page = page;
this.container = container;
this.id = id;
this.nestedId = nestedId;
this.completeId = completeId;
this.elementName = elementName;
this.elementResources = elementResources;
this.request = request;
this.symbolSource = symbolSource;
// evaluate this once because it gets referenced a lot during rendering
this.productionMode = "true".equals(symbolSource.valueForSymbol(SymbolConstants.PRODUCTION_MODE));
this.componentTracingEnabled = "true".equals(symbolSource
.valueForSymbol(SymbolConstants.COMPONENT_RENDER_TRACING_ENABLED));
ComponentResources containerResources = container == null ? null : container.getComponentResources();
coreResources = new InternalComponentResourcesImpl(this.page, this, containerResources, this.elementResources,
completeId, nestedId, instantiator, false);
coreComponent = coreResources.getComponent();
eventLogger = elementResources.getEventLogger(coreResources.getLogger());
renderEvent = elementResources.createPerThreadValue();
rendering = elementResources.createPerThreadValue();
}
/**
* Constructor for the root component of a page.
*/
public ComponentPageElementImpl(Page page, Instantiator instantiator,
ComponentPageElementResources elementResources, Request request, SymbolSource symbolSource)
{
this(page, null, null, null, page.getName(), null, instantiator, null, elementResources, request, symbolSource);
}
private void initializeRenderPhases()
{
setupRenderPhase = new SetupRenderPhase();
beginRenderPhase = new BeginRenderPhase();
beforeRenderTemplatePhase = new BeforeRenderTemplatePhase();
beforeRenderBodyPhase = new BeforeRenderBodyPhase();
afterRenderBodyPhase = new AfterRenderBodyPhase();
afterRenderTemplatePhase = new AfterRenderTemplatePhase();
afterRenderPhase = new AfterRenderPhase();
cleanupRenderPhase = new CleanupRenderPhase();
// Now the optimization, where we remove, replace and collapse unused phases. We use
// the component models to determine which phases have handler methods for the
// render phases.
Set<Class> handled = coreResources.getComponentModel().getHandledRenderPhases();
for (ComponentResources r : NamedSet.getValues(mixinIdToComponentResources))
{
handled.addAll(r.getComponentModel().getHandledRenderPhases());
}
if (!handled.contains(CleanupRender.class))
cleanupRenderPhase = null;
// Now, work back to front.
if (!handled.contains(AfterRender.class))
afterRenderPhase = cleanupRenderPhase;
if (!handled.contains(AfterRenderTemplate.class))
afterRenderTemplatePhase = null;
if (!handled.contains(AfterRenderBody.class))
afterRenderBodyPhase = null;
if (!handled.contains(BeforeRenderTemplate.class))
beforeRenderTemplatePhase = new RenderTemplatePhase();
if (!handled.contains(BeginRender.class))
{
RenderCommand replacement = afterRenderPhase != null ? new OptimizedBeginRenderPhase()
: beforeRenderTemplatePhase;
beginRenderPhase = replacement;
}
if (!handled.contains(SetupRender.class))
setupRenderPhase = beginRenderPhase;
}
public ComponentPageElement newChild(String id, String nestedId, String completeId, String elementName,
Instantiator instantiator, Location location)
{
ComponentPageElementImpl child = new ComponentPageElementImpl(page, this, id, nestedId, completeId,
elementName, instantiator, location, elementResources, request, symbolSource);
addEmbeddedElement(child);
return child;
}
void push(RenderQueue queue, boolean forward, RenderCommand forwardPhase, RenderCommand backwardPhase)
{
push(queue, forward ? forwardPhase : backwardPhase);
}
void push(RenderQueue queue, RenderCommand nextPhase)
{
if (nextPhase != null)
queue.push(nextPhase);
}
void addEmbeddedElement(ComponentPageElement child)
{
if (children == null)
children = CollectionFactory.newList();
String childId = child.getId();
for (ComponentPageElement existing : children)
{
if (existing.getId().equalsIgnoreCase(childId))
throw new TapestryException(StructureMessages.duplicateChildComponent(this, childId), child,
new TapestryException(StructureMessages.originalChildComponent(this, childId,
existing.getLocation()), existing, null));
}
children.add(child);
}
public void addMixin(String mixinId, Instantiator instantiator, String... order)
{
if (mixinIdToComponentResources == null)
{
mixinIdToComponentResources = NamedSet.create();
components = CollectionFactory.newList();
}
String mixinExtension = "$" + mixinId.toLowerCase();
InternalComponentResourcesImpl resources = new InternalComponentResourcesImpl(page, this, coreResources,
elementResources, completeId + mixinExtension, nestedId + mixinExtension, instantiator, true);
mixinIdToComponentResources.put(mixinId, resources);
// note that since we're using explicit ordering now,
// we don't add anything to components until we page load; instead, we add
// to the orderers.
if (order == null)
order = InternalConstants.EMPTY_STRING_ARRAY;
if (resources.getComponentModel().isMixinAfter())
{
if (mixinAfterOrderer == null)
mixinAfterOrderer = new Orderer<Component>(getLogger());
mixinAfterOrderer.add(mixinId, resources.getComponent(), order);
}
else
{
if (mixinBeforeOrderer == null)
mixinBeforeOrderer = new Orderer<Component>(getLogger());
mixinBeforeOrderer.add(mixinId, resources.getComponent(), order);
}
}
public void bindMixinParameter(String mixinId, String parameterName, Binding binding)
{
InternalComponentResources mixinResources = NamedSet.get(mixinIdToComponentResources, mixinId);
mixinResources.bindParameter(parameterName, binding);
}
public Binding getBinding(String parameterName)
{
return coreResources.getBinding(parameterName);
}
public void bindParameter(String parameterName, Binding binding)
{
coreResources.bindParameter(parameterName, binding);
}
public void addToBody(RenderCommand element)
{
if (bodyBlock == null)
bodyBlock = new BlockImpl(getLocation(), "Body of " + getCompleteId());
bodyBlock.addToBody(element);
}
public void addToTemplate(RenderCommand element)
{
template.add(element);
}
private void addUnboundParameterNames(String prefix, List<String> unbound, InternalComponentResources resource)
{
ComponentModel model = resource.getComponentModel();
for (String name : model.getParameterNames())
{
if (resource.isBound(name))
continue;
ParameterModel parameterModel = model.getParameterModel(name);
if (parameterModel.isRequired())
{
String fullName = prefix == null ? name : prefix + "." + name;
unbound.add(fullName);
}
}
}
public void restoreStateBeforePageAttach()
{
invoke(false, RESTORE_STATE_BEFORE_PAGE_ATTACH);
}
public void containingPageDidAttach()
{
invoke(false, CONTAINING_PAGE_DID_ATTACH);
}
public void containingPageDidDetach()
{
invoke(false, CONTAINING_PAGE_DID_DETACH);
}
public void containingPageDidLoad()
{
// If this component has mixins, order them according to:
// mixins.
if (components != null)
{
List<Component> ordered = CollectionFactory.newList();
if (mixinBeforeOrderer != null)
ordered.addAll(mixinBeforeOrderer.getOrdered());
ordered.add(coreComponent);
// Add the remaining, late executing mixins
if (mixinAfterOrderer != null)
ordered.addAll(mixinAfterOrderer.getOrdered());
components = ordered;
// no need to keep the orderers around.
mixinBeforeOrderer = null;
mixinAfterOrderer = null;
}
// For some parameters, bindings (from defaults) are provided inside the callback method, so
// that is invoked first, before we check for unbound parameters.
invoke(false, CONTAINING_PAGE_DID_LOAD);
verifyRequiredParametersAreBound();
// We assume that by the time we start to render, the structure (i.e., mixins) is nailed
// down. We could add a lock, but that seems wasteful.
initializeRenderPhases();
loaded = true;
}
public void enqueueBeforeRenderBody(RenderQueue queue)
{
if (bodyBlock != null)
push(queue, beforeRenderBodyPhase);
}
public String getCompleteId()
{
return completeId;
}
public Component getComponent()
{
return coreComponent;
}
public InternalComponentResources getComponentResources()
{
return coreResources;
}
public ComponentPageElement getContainerElement()
{
return container;
}
public Page getContainingPage()
{
return page;
}
public ComponentPageElement getEmbeddedElement(String embeddedId)
{
ComponentPageElement embeddedElement = null;
if (children != null)
{
for (ComponentPageElement child : children)
{
if (child.getId().equalsIgnoreCase(embeddedId))
{
embeddedElement = child;
break;
}
}
}
if (embeddedElement == null)
{
Set<String> ids = CollectionFactory.newSet();
if (children != null)
{
for (ComponentPageElement child : children)
{
ids.add(child.getId());
}
}
throw new UnknownValueException(String.format("Component %s does not contain embedded component '%s'.",
getCompleteId(), embeddedId), new AvailableValues("Embedded components", ids));
}
return embeddedElement;
}
public String getId()
{
return id;
}
public Logger getLogger()
{
return coreResources.getLogger();
}
public Component getMixinByClassName(String mixinClassName)
{
Component result = mixinForClassName(mixinClassName);
if (result == null)
throw new TapestryException(StructureMessages.unknownMixin(completeId, mixinClassName), getLocation(), null);
return result;
}
private Component mixinForClassName(String mixinClassName)
{
if (mixinIdToComponentResources == null)
return null;
for (InternalComponentResources resources : NamedSet.getValues(mixinIdToComponentResources))
{
if (resources.getComponentModel().getComponentClassName().equals(mixinClassName)) { return resources
.getComponent(); }
}
return null;
}
public ComponentResources getMixinResources(String mixinId)
{
ComponentResources result = NamedSet.get(mixinIdToComponentResources, mixinId);
if (result == null)
throw new IllegalArgumentException(String.format("Unable to locate mixin '%s' for component '%s'.",
mixinId, completeId));
return result;
}
public String getNestedId()
{
return nestedId;
}
public boolean dispatchEvent(ComponentEvent event)
{
if (components == null)
return coreComponent.dispatchComponentEvent(event);
// Otherwise, iterate over mixins + core component
boolean result = false;
for (Component component : components)
{
result |= component.dispatchComponentEvent(event);
if (event.isAborted())
break;
}
return result;
}
/**
* Invokes a callback on the component instances (the core component plus any mixins).
*
* @param reverse
* if true, the callbacks are in the reverse of the normal order (this is associated
* with AfterXXX
* phases)
* @param callback
* the object to receive each component instance
*/
private void invoke(boolean reverse, ComponentCallback callback)
{
try
{ // Optimization: In the most general case (just the one component, no mixins)
// invoke the callback on the component and be done ... no iterators, no nothing.
if (components == null)
{
callback.run(coreComponent);
return;
}
Iterator<Component> i = reverse ? InternalUtils.reverseIterator(components) : components.iterator();
while (i.hasNext())
{
callback.run(i.next());
if (callback.isEventAborted())
return;
}
}
catch (RuntimeException ex)
{
throw new TapestryException(ex.getMessage(), getLocation(), ex);
}
}
public boolean isLoaded()
{
return loaded;
}
public boolean isRendering()
{
return rendering.get(false);
}
/**
* Generate a toString() for the inner classes that represent render phases.
*/
private String phaseToString(String phaseName)
{
return String.format("%s[%s]", phaseName, completeId);
}
/**
* Pushes the SetupRender phase state onto the queue.
*/
public final void render(MarkupWriter writer, RenderQueue queue)
{
// TODO: An error if the render flag is already set (recursive rendering not
// allowed or advisable).
// TODO: Check for recursive rendering.
rendering.set(true);
queue.startComponent(coreResources);
queue.push(new PostRenderCleanupPhase(writer.getElement()));
push(queue, setupRenderPhase);
}
@Override
public String toString()
{
return String.format("ComponentPageElement[%s]", completeId);
}
public boolean triggerEvent(String eventType, Object[] contextValues, ComponentEventCallback callback)
{
return triggerContextEvent(eventType, createParameterContext(contextValues == null ? new Object[0]
: contextValues), callback);
}
private EventContext createParameterContext(final Object... values)
{
return new AbstractEventContext()
{
public int getCount()
{
return values.length;
}
public <T> T get(Class<T> desiredType, int index)
{
return elementResources.coerce(values[index], desiredType);
}
};
}
public boolean triggerContextEvent(final String eventType, final EventContext context,
final ComponentEventCallback callback)
{
assert InternalUtils.isNonBlank(eventType);
assert context != null;
String description = String.format("Triggering event '%s' on %s", eventType, completeId);
return elementResources.invoke(description, new Invokable<Boolean>()
{
public Boolean invoke()
{
return processEventTriggering(eventType, context, callback);
}
});
}
@SuppressWarnings("all")
private boolean processEventTriggering(String eventType, EventContext context, ComponentEventCallback callback)
{
boolean result = false;
ComponentPageElement component = this;
String componentId = "";
// Provide a default handler for when the provided handler is null.
final ComponentEventCallback providedHandler = callback == null ? new NotificationEventCallback(eventType,
completeId) : callback;
ComponentEventCallback wrapped = new ComponentEventCallback()
{
public boolean handleResult(Object result)
{
// Boolean value is not passed to the handler; it will be true (abort event)
// or false (continue looking for event handlers).
if (result instanceof Boolean)
return (Boolean) result;
return providedHandler.handleResult(result);
}
};
RuntimeException rootException = null;
// Because I don't like to reassign parameters.
String currentEventType = eventType;
EventContext currentContext = context;
// Track the location of the original component for the event, even as we work our way up
// the hierarchy. This may not be ideal if we trigger an "exception" event ... or maybe
// it's right (it's the location of the originally thrown exception).
Location location = component.getComponentResources().getLocation();
while (component != null)
{
try
{
Logger logger = component.getEventLogger();
ComponentEvent event = new ComponentEventImpl(currentEventType, componentId, currentContext, wrapped,
elementResources, logger);
logger.debug(TapestryMarkers.EVENT_DISPATCH, "Dispatch event: {}", event);
result |= component.dispatchEvent(event);
if (event.isAborted())
return result;
}
catch (RuntimeException ex)
{
// An exception in an event handler method
// while we're trying to handle a previous exception!
if (rootException != null)
throw rootException;
// We know component is not null and therefore has a component resources that
// should have a location.
// Wrap it up to help ensure that a location is available to the event handler
// method or,
// more likely, to the exception report page.
rootException = new ComponentEventException(ex.getMessage(), eventType, context, location, ex);
// Switch over to triggering an "exception" event, starting in the component that
// threw the exception.
currentEventType = "exception";
currentContext = createParameterContext(rootException);
continue;
}
// On each bubble up, make the event appear to come from the previous component
// in which the event was triggered.
componentId = component.getId();
component = component.getContainerElement();
}
// If there was a handler for the exception event, it is required to return a non-null (and
// non-boolean) value
// to tell Tapestry what to do. Since that didn't happen, we have no choice but to rethrow
// the (wrapped)
// exception.
if (rootException != null)
throw rootException;
return result;
}
private void verifyRequiredParametersAreBound()
{
List<String> unbound = CollectionFactory.newList();
addUnboundParameterNames(null, unbound, coreResources);
List<String> sortedNames = CollectionFactory.newList(NamedSet.getNames(mixinIdToComponentResources));
Collections.sort(sortedNames);
for (String name : sortedNames)
{
addUnboundParameterNames(name, unbound, mixinIdToComponentResources.get(name));
}
if (unbound.isEmpty())
return;
throw new TapestryException(StructureMessages.missingParameters(unbound, this), this, null);
}
public Locale getLocale()
{
return page.getSelector().locale;
}
public String getElementName(String defaultElementName)
{
return elementName != null ? elementName : defaultElementName;
}
public Block getBlock(String id)
{
Block result = findBlock(id);
if (result == null)
throw new BlockNotFoundException(StructureMessages.blockNotFound(completeId, id), getLocation());
return result;
}
public Block findBlock(String id)
{
assert InternalUtils.isNonBlank(id);
return NamedSet.get(blocks, id);
}
public void addBlock(String blockId, Block block)
{
if (blocks == null)
blocks = NamedSet.create();
if (!blocks.putIfNew(blockId, block))
throw new TapestryException(StructureMessages.duplicateBlock(this, blockId), block, null);
}
public String getPageName()
{
return page.getName();
}
public boolean hasBody()
{
return bodyBlock != null;
}
public Block getBody()
{
return bodyBlock == null ? PLACEHOLDER_BLOCK : bodyBlock;
}
public Map<String, Binding> getInformalParameterBindings()
{
return coreResources.getInformalParameterBindings();
}
public Logger getEventLogger()
{
return eventLogger;
}
public Link createEventLink(String eventType, Object... context)
{
return elementResources.createComponentEventLink(coreResources, eventType, false, context);
}
public Link createActionLink(String eventType, boolean forForm, Object... context)
{
return elementResources.createComponentEventLink(coreResources, eventType, forForm, context);
}
public Link createFormEventLink(String eventType, Object... context)
{
return elementResources.createComponentEventLink(coreResources, eventType, true, context);
}
public Link createPageLink(String pageName, boolean override, Object... context)
{
return elementResources.createPageRenderLink(pageName, override, context);
}
public Link createPageLink(Class pageClass, boolean override, Object... context)
{
return elementResources.createPageRenderLink(pageClass, override, context);
}
protected RenderPhaseEvent createRenderEvent(RenderQueue queue)
{
RenderPhaseEvent result = renderEvent.get();
if (result != null)
return result;
// Create a per-thread value to use until the end of the render.
// This assumes that the queue will not change during the current request,
// which should be valid.
result = new RenderPhaseEvent(new RenderPhaseEventHandler(queue), eventLogger);
renderEvent.set(result);
return result;
}
boolean isRenderTracingEnabled()
{
return !productionMode && (componentTracingEnabled || "true".equals(request.getParameter("t:component-trace")));
}
public ComponentResourceSelector getResourceSelector()
{
return page.getSelector();
}
}