org.riotfamily.riot.editor
Interface EditorDefinition

All Known Subinterfaces:

ObjectEditorDefinition

All Known Implementing Classes:

AbstractEditorDefinition, AbstractObjectEditorDefinition, CustomEditorDefinition, FormChooserDefinition, FormDefinition, GroupDefinition, IntermediateDefinition, ListDefinition, TreeDefinition, ViewDefinition

public interface EditorDefinition

Method Summary

void	addReference(List<EditorReference> refs, EditorDefinition parentDef, Object parent, MessageResolver messageResolver)
EditorReference	createEditorPath(Object bean, MessageResolver messageResolver) Returns a PathComponent for the given bean that represents the complete path to the editor.
EditorReference	createEditorPath(String objectId, String parentId, String parentEditorId, MessageResolver messageResolver) Returns a PathComponent for the given objectId and parentId that represents the complete path to the editor.
EditorReference	createReference(String parentId, MessageResolver messageResolver) Creates a reference to an editor.
Class<?>	getBeanClass()
String	getEditorType()
String	getEditorUrl(String objectId, String parentId, String parentEditorId)
String	getId()
String	getLabel(Object bean, MessageResolver messageResolver)
EditorDefinition	getParentEditorDefinition()
boolean	isHidden() Editors that are only used in choosers may return true in order to be excluded from group views.
void	setParentEditorDefinition(EditorDefinition parent)
boolean	show(Object parent)

Method Detail

getId

String getId()

getEditorType

String getEditorType()

getBeanClass

Class<?> getBeanClass()

getLabel

String getLabel(Object bean,
                MessageResolver messageResolver)

setParentEditorDefinition

void setParentEditorDefinition(EditorDefinition parent)

getParentEditorDefinition

EditorDefinition getParentEditorDefinition()

createEditorPath

EditorReference createEditorPath(String objectId,
                                 String parentId,
                                 String parentEditorId,
                                 MessageResolver messageResolver)

Returns a PathComponent for the given objectId and parentId that represents the complete path to the editor. This method is invoked by the PathController for the current (active) editor in order to build a breadcrumb navigation.

createEditorPath

EditorReference createEditorPath(Object bean,
                                 MessageResolver messageResolver)

Returns a PathComponent for the given bean that represents the complete path to the editor. This method is usually invoked by descendant editors to create a complete path recursively.

createReference

EditorReference createReference(String parentId,
                                MessageResolver messageResolver)

Creates a reference to an editor. The method is used by the EditorGroupController.

addReference

void addReference(List<EditorReference> refs,
                  EditorDefinition parentDef,
                  Object parent,
                  MessageResolver messageResolver)

getEditorUrl

String getEditorUrl(String objectId,
                    String parentId,
                    String parentEditorId)

isHidden

boolean isHidden()

Editors that are only used in choosers may return true in order to be excluded from group views.

See Also:

EditorGroupController

show

boolean show(Object parent)