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.Iterator;
20:
21: /**
22: * Interface to be implemented by Widgets which contain other widgets. So all
23: * widgets together form a widget tree, with its root being the {@link Form}
24: * widget, the {@link ContainerWidget}s being the branches/forks, and the
25: * {@link Widget}s with values being the leaves.
26: *
27: * @version $Id: ContainerWidget.java 449149 2006-09-23 03:58:05Z crossley $
28: */
29: public interface ContainerWidget extends Widget {
30:
31: /**
32: * Adds a child widget.
33: */
34: public void addChild(Widget widget);
35:
36: //TODO: check to remove since we have no removeChild
37:
38: /**
39: * Checks if there is a child widget with the given id.
40: */
41: public boolean hasChild(String id);
42:
43: /**
44: * Gets the child widget with the given id.
45: * @return null if there is no child with the given id.
46: */
47: public Widget getChild(String id);
48:
49: /**
50: * @return an iterator over the widgets this object contains
51: */
52: public Iterator getChildren();
53:
54: }
|