001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.cocoon.forms.formmodel;
018:
019: import org.apache.cocoon.forms.formmodel.library.Library;
020: import org.apache.cocoon.util.location.Locatable;
021: import org.apache.cocoon.util.location.Location;
022: import org.xml.sax.ContentHandler;
023: import org.xml.sax.SAXException;
024:
025: /**
026: * A WidgetDefinition holds all the static information about a Widget. It's
027: * function is a lot like that of the class in Java. Users of the Cocoon Forms framework
028: * usually won't have to bother with the WidgetDefinition's, but will rather use
029: * the Widget's themselves.
030: *
031: * @version $Id: WidgetDefinition.java 449149 2006-09-23 03:58:05Z crossley $
032: */
033: public interface WidgetDefinition extends Locatable {
034:
035: /**
036: * Initializes this definition with values from the given other definition
037: */
038: void initializeFrom(WidgetDefinition definition) throws Exception;
039:
040: /**
041: * Gets the {@link FormDefinition}.
042: */
043: FormDefinition getFormDefinition();
044:
045: /**
046: * Gets the Library object containing this definition
047: */
048: Library getEnclosingLibrary();
049:
050: /**
051: * Sets the Library object containing this definition (should only be used by Library itself!)
052: */
053: void setEnclosingLibrary(Library library);
054:
055: /**
056: * Sets the parent of this definition.
057: */
058: void setParent(WidgetDefinition definition);
059:
060: /**
061: * Gets source location of this widget definition.
062: */
063: Location getLocation();
064:
065: /**
066: * Gets id of this widget definition.
067: */
068: String getId();
069:
070: /**
071: * Gets an attribute that has been defined on the widget's definition.
072: *
073: * @param name the attribute name
074: * @return the attribute value, or null if it doesn't exist
075: */
076: Object getAttribute(String name);
077:
078: /**
079: * Validate a widget using the validators that were defined in its definition. If validation
080: * fails, the validator has set a validation error on the widget or one of its children.
081: *
082: * @param widget the widget
083: * @return <code>true</code> if validation was successful.
084: */
085: boolean validate(Widget widget);
086:
087: /**
088: * Checks whether this definition is complete since we are allowed to have partial
089: * definitions in libraries. Definitions need to be complete _before_ a call to
090: * createInstance() though.
091: */
092: void checkCompleteness() throws IncompletenessException;
093:
094: /**
095: * Creates and returns a widget based on this widget definition.
096: */
097: Widget createInstance();
098:
099: /**
100: * Generates SAX events for named display data.
101: */
102: void generateDisplayData(String name, ContentHandler contentHandler)
103: throws SAXException;
104:
105: /**
106: * Generates SAX events for display data.
107: */
108: void generateDisplayData(ContentHandler contentHandler)
109: throws SAXException;
110:
111: /**
112: * Generates SAX events for the label of this widget.
113: */
114: void generateLabel(ContentHandler contentHandler)
115: throws SAXException;
116: }
|