01: // Copyright 2006 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // 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.services;
16:
17: import org.apache.tapestry.MarkupWriter;
18: import org.apache.tapestry.dom.Document;
19:
20: /**
21: * Page render commands are invoked at the start of the page render cycle and at the end. This
22: * allows them to perform initial startup or final cleanup (or both).
23: * <p>
24: * When commands are invoked (by the default {@link PageRenderInitializer}), the
25: * {@link MarkupWriter} and {@link Document} will have already been set. Most commands deal with
26: * storing new environmental services into the Environment.
27: *
28: * @see PageRenderInitializer
29: */
30: public interface PageRenderCommand {
31: /** Invoked to perform an initial setup. */
32: void setup(Environment environment);
33:
34: /** Invoked to peform final cleanup. */
35: void cleanup(Environment environment);
36: }
|