LayoutFactory


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;
17  
18  import java.util.List  ;
19  
20  import org.apache.cocoon.ProcessingException;
21  
22  /**
23   * This factory is for creating and managing layout objects
24   * 
25   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
26   * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
27   * 
28   * @version CVS $Id: LayoutFactory.java 30932 2004-07-29 17:35:38Z vgritsenko $
29   */
30  public interface LayoutFactory  {
31      
32      String   ROLE = LayoutFactory.class.getName();
33      
34      /**
35       * This method is invoked for a newly loaded profile
36       */
37      void prepareLayout(Layout layout)
38      throws ProcessingException;
39      
40      /**
41       * Create a new layout instance.
42       * The instance is also registered at the profile manager.
43       */
44      Layout newInstance(String   name)
45      throws ProcessingException;
46      
47      /**
48       * Remove the layout instance.
49       * The instance (and all childs) will also be unregistered from
50       * the profile manager.
51       */
52      void remove(Layout layout)
53      throws ProcessingException;
54      
55      List   getLayoutDescriptions();
56      
57  }
58
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags