001    // Copyright 2007, 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    
015    package org.apache.tapestry5.services;
016    
017    import org.apache.tapestry5.MarkupWriter;
018    import org.apache.tapestry5.json.JSONObject;
019    
020    /**
021     * A filter (the main interface being {@link PartialMarkupRenderer}) applied when performing a partial page render as
022     * part of an Ajax-oriented request. This is similar to {@link org.apache.tapestry5.services.MarkupRendererFilter} and
023     * filters are often in place so as to contribute {@link org.apache.tapestry5.annotations.Environmental} services to the
024     * pages and components that render.
025     * 
026     * @see org.apache.tapestry5.services.TapestryModule#contributePartialMarkupRenderer(org.apache.tapestry5.ioc.OrderedConfiguration,
027     *      org.apache.tapestry5.Asset, org.apache.tapestry5.services.javascript.JavaScriptStackSource,
028     *      org.apache.tapestry5.internal.services.javascript.JavaScriptStackPathConstructor,
029     *      org.apache.tapestry5.ioc.services.SymbolSource, AssetSource)
030     */
031    public interface PartialMarkupRendererFilter
032    {
033        /**
034         * Implementations should perform work before or after passing the writer to the renderer.
035         * 
036         * @param writer
037         *            to which markup should be written
038         * @param reply
039         *            JSONObject which will contain the partial response
040         * @param renderer
041         *            delegate to which the writer should be passed
042         */
043        void renderMarkup(MarkupWriter writer, JSONObject reply, PartialMarkupRenderer renderer);
044    }