KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > woody > formmodel > ContainerDefinition


1 /*
2  * Copyright 1999-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.woody.formmodel;
17
18 import java.util.Collection JavaDoc;
19 import java.util.List JavaDoc;
20
21 /**
22  * Interface to be implemented by WidgetDefinitions for Widgets which contain other widgets.
23  *
24  * @author Timothy Larson
25  * @version $Id: ContainerDefinition.java 30932 2004-07-29 17:35:38Z vgritsenko $
26  */

27 public interface ContainerDefinition extends WidgetDefinition {
28
29     /**
30      * Resolve references to widget definition classes
31      */

32     public void resolve(List JavaDoc parents, WidgetDefinition parent) throws Exception JavaDoc;
33
34     /**
35      * Create a widget from a contained widget definition.
36      */

37     public void createWidget(Widget parent, String JavaDoc id);
38
39     /**
40      * Create widgets from the contained widget definitions.
41      */

42     public void createWidgets(Widget parent);
43
44     /**
45      * Adds a (sub) widget definition to this definition.
46      */

47     public void addWidgetDefinition(WidgetDefinition definition) throws Exception JavaDoc, DuplicateIdException;
48
49     /**
50      * Check if this definition contains the named definition.
51      */

52     public boolean hasWidget(String JavaDoc id);
53
54     /**
55      * Gets a (sub) widget definition from this definition.
56      */

57     public WidgetDefinition getWidgetDefinition(String JavaDoc id);
58
59     /**
60      * Gets the collection of (sub) widget definition from this definition.
61      */

62     public Collection JavaDoc getWidgetDefinitions();
63 }
64
Popular Tags