001// Copyright 2011 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.internal.dynamic;
016
017import org.apache.tapestry5.MarkupWriter;
018import org.apache.tapestry5.runtime.RenderCommand;
019import org.apache.tapestry5.runtime.RenderQueue;
020import org.apache.tapestry5.services.dynamic.DynamicDelegate;
021import org.apache.tapestry5.services.dynamic.DynamicTemplate;
022
023/**
024 * A close cousin to {@link RenderCommand} used inside a {@link DynamicTemplate}.
025 * 
026 * @since 5.3
027 */
028public interface DynamicTemplateElement
029{
030    /**
031     * The element should perform whatever rendering it wants. When rendering elements, the queue
032     * is used to queue up rendering commands for the body of the element as well as a command to close
033     * the element started.
034     */
035    void render(MarkupWriter writer, RenderQueue queue, DynamicDelegate delegate);
036}