001// Copyright 2006, 2007, 2008 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.services;
016
017import org.apache.tapestry5.ContentType;
018import org.apache.tapestry5.MarkupWriter;
019
020/**
021 * Source for {@link org.apache.tapestry5.MarkupWriter} instances.
022 */
023public interface MarkupWriterFactory
024{
025    /**
026     * Creates a markup writer for a particular content type.
027     *
028     * @param contentType type of content generated by the markup write; used to control the type of {@link
029     *                    org.apache.tapestry5.dom.MarkupModel} used with the {@link org.apache.tapestry5.dom.Document}
030     *                    the backs the markup writer.
031     */
032    MarkupWriter newMarkupWriter(ContentType contentType);
033
034    /**
035     * Creates a markup writer for a particular content type, configured for <em>partial page rendering</em> (i.e., for
036     * a response to an Ajax request).
037     *
038     * @param contentType type of content generated by the markup write; used to control the type of {@link
039     *                    org.apache.tapestry5.dom.MarkupModel} used with the {@link org.apache.tapestry5.dom.Document}
040     *                    the backs the markup writer.
041     */
042    MarkupWriter newPartialMarkupWriter(ContentType contentType);
043
044    /**
045     * Obtains a markup writer that will render the content for the provided logical page name.
046     *
047     * @param pageName logical page name
048     * @return writer configured for the page
049     */
050    MarkupWriter newMarkupWriter(String pageName);
051}