Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
NestedMarkupWriter |
|
| 1.0;1 |
1 | // Copyright 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry; | |
16 | ||
17 | /** | |
18 | * A writer that is created by, and nested within, another markup writer. This is used by many | |
19 | * components that need to render their bodies to fully determine how to write the markup before | |
20 | * their bodies; the markup is stored inside the nested markup writer until needed. | |
21 | * | |
22 | * @author Howard M. Lewis Ship | |
23 | * @since 4.0 | |
24 | * @see org.apache.tapestry.IMarkupWriter#getNestedWriter() | |
25 | */ | |
26 | public interface NestedMarkupWriter extends IMarkupWriter | |
27 | { | |
28 | /** | |
29 | * Returns any makrup so far accumulated by the nested markup writer. When the nested markup | |
30 | * writer is closed, it invokes {@link org.apache.tapestry.IMarkupWriter#printRaw(String)}, | |
31 | * with this content, on its parent markup writer. | |
32 | * <p> | |
33 | * Getting the buffer will <em>close</em> the writer. | |
34 | */ | |
35 | ||
36 | String getBuffer(); | |
37 | } |