KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > outerj > daisy > frontend > editor > FieldEditor


1 /*
2  * Copyright 2004 Outerthought bvba and Schaubroeck nv
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.outerj.daisy.frontend.editor;
17
18 import org.apache.cocoon.forms.formmodel.Form;
19 import org.apache.cocoon.forms.formmodel.Widget;
20 import org.apache.cocoon.forms.validation.ValidationError;
21 import org.apache.excalibur.xml.sax.XMLizable;
22 import org.outerj.daisy.repository.Document;
23 import org.outerj.daisy.repository.Repository;
24 import org.outerj.daisy.repository.Field;
25 import org.outerj.daisy.repository.schema.FieldType;
26
27 public interface FieldEditor {
28     public XMLizable getFormDefinitionFragment();
29
30     /**
31      * Get the name of the XSL template responsible for rendering this type of field.
32      */

33     public String JavaDoc getTemplateName();
34
35     public FieldType getFieldType();
36
37     public void setValidationError(ValidationError error, Widget widget);
38
39     /**
40      * Returns true if this field has a value (used for field-requiredness validation).
41      */

42     public boolean hasValue(Widget widget);
43
44     public void init(Widget widget, DocumentEditorForm documentEditorForm);
45
46     public void load(Form form, Field field, Document document, Repository repository) throws Exception JavaDoc;
47
48     public void save(Form form, Document document, Repository repository) throws Exception JavaDoc;
49 }
50
Popular Tags