org.riotfamily.forms
Interface Editor

All Superinterfaces:
Element
All Known Subinterfaces:
SelectElement, ValueWrapperEditor
All Known Implementing Classes:
AbstractChooser, AbstractFileUpload, AbstractMultiSelectElement, AbstractSelectElement, AbstractSingleSelectElement, AbstractTextElement, AutocompleteTextField, Calendar, Checkbox, CheckboxGroup, ColorPicker, ContentListEditor, ContentMapEditor, ElementSwitch, FileUpload, ImageCheckbox, ImageCheckboxGroup, ImageRadioButtonGroup, ListEditor, MapEditor, MultiSelectBox, NestedForm, NumberField, ObjectChooser, PagePropertiesEditor, PasswordField, RadioButtonGroup, SelectBox, SitePropertiesEditor, Textarea, TextField, TinyMCE

public interface Editor
extends Element

Interface to be implemented by form elements that are capable of editing a property value.


Method Summary
 void addChangeListener(ChangeListener listener)
           
 EditorBinding getEditorBinding()
          Implementors must return the binding set via setEditorBinding().
 String getFieldName()
          Returns the set (or computed) fieldName.
 String getLabel()
          Returns the label.
 Object getValue()
          Returns the value.
 void setEditorBinding(EditorBinding binding)
           
 void setFieldName(String fieldName)
          Sets the fieldName that is used to build error codes.
 void setValue(Object value)
          Sets the (initial) value, typically retrieved from a backing object.
 
Methods inherited from interface org.riotfamily.forms.Element
focus, getEventTriggerId, getForm, getFormContext, getId, getParent, getStyleClass, isCompositeElement, isEnabled, isRequired, isVisible, processRequest, render, setEnabled, setForm, setFormContext, setId, setParent, setRequired
 

Method Detail

setValue

void setValue(Object value)
Sets the (initial) value, typically retrieved from a backing object.


getValue

Object getValue()
Returns the value.


getLabel

String getLabel()
Returns the label.


setEditorBinding

void setEditorBinding(EditorBinding binding)

getEditorBinding

EditorBinding getEditorBinding()
Implementors must return the binding set via setEditorBinding().


setFieldName

void setFieldName(String fieldName)
Sets the fieldName that is used to build error codes. If null, EditorBinding.getPropertyPath() is used. You should only use this method for unbound elements that are part of complex (composite) widgets.


getFieldName

String getFieldName()
Returns the set (or computed) fieldName.


addChangeListener

void addChangeListener(ChangeListener listener)