001// Copyright 2005 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.tapestry; 016 017/** 018 * A writer that is created by, and nested within, another markup writer. This is used by many 019 * components that need to render their bodies to fully determine how to write the markup before 020 * their bodies; the markup is stored inside the nested markup writer until needed. 021 * 022 * @author Howard M. Lewis Ship 023 * @since 4.0 024 * @see org.apache.tapestry.IMarkupWriter#getNestedWriter() 025 */ 026public interface NestedMarkupWriter extends IMarkupWriter 027{ 028 /** 029 * Returns any makrup so far accumulated by the nested markup writer. When the nested markup 030 * writer is closed, it invokes {@link org.apache.tapestry.IMarkupWriter#printRaw(String)}, 031 * with this content, on its parent markup writer. 032 * <p> 033 * Getting the buffer will <em>close</em> the writer. 034 */ 035 036 public String getBuffer(); 037}