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.woody.formmodel;
18:
19: import org.xml.sax.ContentHandler;
20: import org.xml.sax.SAXException;
21:
22: /**
23: * A WidgetDefinition holds all the static information about a Widget. It's
24: * function is a lot like that of the class in Java. Users of the Woody framework
25: * usually won't have to bother with the WidgetDefinition's, but will rather use
26: * the Widget's themselves.
27: *
28: * @version CVS $Id: WidgetDefinition.java 433543 2006-08-22 06:22:54Z crossley $
29: */
30: public interface WidgetDefinition {
31:
32: /**
33: * Gets the {@link FormDefinition}.
34: */
35: public FormDefinition getFormDefinition();
36:
37: /**
38: * Sets the parent of this definition
39: */
40: public void setParent(WidgetDefinition definition);
41:
42: /**
43: * Gets source location of this widget definition.
44: */
45: public String getLocation();
46:
47: /**
48: * Gets id of this widget definition.
49: */
50: public String getId();
51:
52: /**
53: * Creates and returns a widget based on this widget definition.
54: */
55: public Widget createInstance();
56:
57: /**
58: * Generates SAX events for named display data.
59: */
60: public void generateDisplayData(String name,
61: ContentHandler contentHandler) throws SAXException;
62:
63: /**
64: * Generates SAX events for display data.
65: */
66: public void generateDisplayData(ContentHandler contentHandler)
67: throws SAXException;
68:
69: /**
70: * Generates SAX events for the label of this widget.
71: */
72: public void generateLabel(ContentHandler contentHandler)
73: throws SAXException;
74: }
|