01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.forms.formmodel;
18:
19: import java.util.Collection;
20: import java.util.List;
21:
22: /**
23: * Interface to be implemented by WidgetDefinitions for Widgets which contain other widgets.
24: *
25: * @version $Id: ContainerDefinition.java 449149 2006-09-23 03:58:05Z crossley $
26: */
27: public interface ContainerDefinition extends WidgetDefinition {
28:
29: /**
30: * Resolve references to widget definition classes
31: */
32: public void resolve(List parents, WidgetDefinition parent)
33: throws Exception;
34:
35: /**
36: * Create a widget from a contained widget definition.
37: */
38: public void createWidget(Widget parent, String id);
39:
40: /**
41: * Create widgets from the contained widget definitions.
42: */
43: public void createWidgets(Widget parent);
44:
45: /**
46: * Adds a (sub) widget definition to this definition.
47: */
48: public void addWidgetDefinition(WidgetDefinition definition)
49: throws Exception, DuplicateIdException;
50:
51: /**
52: * Check if this definition contains the named definition.
53: */
54: public boolean hasWidget(String id);
55:
56: /**
57: * Gets a (sub) widget definition from this definition.
58: */
59: public WidgetDefinition getWidgetDefinition(String id);
60:
61: /**
62: * Gets the collection of (sub) widget definition from this definition.
63: */
64: public Collection getWidgetDefinitions();
65: }
|