RendererAspectContext


1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.portal.layout.renderer.aspect;
17  
18  import java.util.Map  ;
19  
20  import org.apache.cocoon.portal.PortalService;
21  import org.apache.cocoon.portal.layout.Layout;
22  import org.xml.sax.ContentHandler  ;
23  import org.xml.sax.SAXException  ;
24  
25  /**
26   * The renderer aspect context is passed to every renderer aspect.
27   * Using this context, a renderer aspect can get it's configuration
28   * and it can invoke (if wanted) the next aspect in the aspect chain.
29   *
30   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
31   * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
32   * 
33   * @version CVS $Id: RendererAspectContext.java 330865 2005-11-04 18:54:05Z rgoers $
34   */
35  public interface RendererAspectContext {
36      
37      /**
38       * Stream out raw layout 
39       */
40      void invokeNext(Layout layout, PortalService service, ContentHandler   handler)
41      throws SAXException  ;
42  
43      /** 
44       * Get the "compiled" configuration of the aspect.
45       */
46      Object   getAspectConfiguration();
47      
48      /**
49       * Set an attribute
50       */
51      void setAttribute(String   key, Object   attribute);
52  
53      /**
54       * Get an attribute
55       */
56      Object   getAttribute(String   key);
57  
58      /**
59       * Remove an attribute
60       */
61      void removeAttribute(String   key);
62      
63      /**
64       * Get the object model
65       */
66      Map   getObjectModel();
67  
68      /**
69       * Return whether rendering is enabled for this chain.
70       * @return true if rendering is enabled, false otherwise.
71       */
72      boolean isRendering();
73  }
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags