KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > forms > Editor


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the
11  * License.
12  *
13  * The Original Code is Riot.
14  *
15  * The Initial Developer of the Original Code is
16  * Neteye GmbH.
17  * Portions created by the Initial Developer are Copyright (C) 2006
18  * the Initial Developer. All Rights Reserved.
19  *
20  * Contributor(s):
21  * Felix Gnass [fgnass at neteye dot de]
22  *
23  * ***** END LICENSE BLOCK ***** */

24 package org.riotfamily.forms;
25
26 /**
27  * Interface to be implemented by form elements that are capable of editing
28  * a property value.
29  */

30 public interface Editor extends Element {
31
32     /**
33      * Sets the (initial) value, typically retrieved from a backing object.
34      */

35     public void setValue(Object JavaDoc value);
36     
37     /**
38      * Returns the value.
39      */

40     public Object JavaDoc getValue();
41         
42     /**
43      * Returns the label.
44      */

45     public String JavaDoc getLabel();
46
47     public void setEditorBinding(EditorBinding binding);
48     
49     /**
50      * Implementors must return the binding set via
51      * {@link #setEditorBinding(EditorBinding) setEditorBinding()}.
52      */

53     public EditorBinding getEditorBinding();
54     
55     /**
56      * Sets the fieldName that is used to build error codes.
57      * If <code>null</code>, {@link EditorBinding#getPropertyPath()} is used.
58      * You should only use this method for unbound elements that are part
59      * of complex (composite) widgets.
60      */

61     public void setFieldName(String JavaDoc fieldName);
62     
63     /**
64      * Returns the set (or computed) fieldName.
65      */

66     public String JavaDoc getFieldName();
67     
68 }
69
Popular Tags