org.riotfamily.riot.editor
Class ListDefinition

java.lang.Object
  org.riotfamily.riot.editor.AbstractEditorDefinition
      org.riotfamily.riot.editor.ListDefinition

All Implemented Interfaces:

EditorDefinition

Direct Known Subclasses:

TreeDefinition

public class ListDefinition
extends AbstractEditorDefinition

Field Summary

protected static String

TYPE_LIST

Constructor Summary

ListDefinition(EditorRepository repository)

ListDefinition(ListDefinition prototype, EditorRepository repository)

Method Summary

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 the list.
protected EditorReference	createReference(String parentId, String parentEditorId, MessageResolver messageResolver)
Class<?>	getBeanClass()
RiotDao	getDao()
protected String	getDefaultName()
ObjectEditorDefinition	getDisplayDefinition()
String	getEditorType()
String	getEditorUrl(String objectId, String parentId, String parentEditorId)
String	getLabel(Object object, MessageResolver messageResolver)
ListConfig	getListConfig()
String	getListId()
void	setDisplayDefinition(ObjectEditorDefinition editorDef)
void	setListId(String listId)

Methods inherited from class org.riotfamily.riot.editor.AbstractEditorDefinition

addReference, equals, getEditorRepository, getIcon, getId, getLabel, getMessageKey, getName, getParentEditorDefinition, hashCode, isHidden, setEditorRepository, setHidden, setIcon, setId, setName, setParentEditorDefinition, show

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_LIST

protected static final String TYPE_LIST

See Also:

Constant Field Values

Constructor Detail

ListDefinition

public ListDefinition(EditorRepository repository)

ListDefinition

public ListDefinition(ListDefinition prototype,
                      EditorRepository repository)

Method Detail

getEditorType

public String getEditorType()

getListId

public String getListId()

getDefaultName

protected String getDefaultName()

Overrides:

getDefaultName in class AbstractEditorDefinition

setListId

public void setListId(String listId)

getLabel

public String getLabel(Object object,
                       MessageResolver messageResolver)

Specified by:

getLabel in interface EditorDefinition

Overrides:

getLabel in class AbstractEditorDefinition

getBeanClass

public Class<?> getBeanClass()

Specified by:

getBeanClass in interface EditorDefinition

Overrides:

getBeanClass in class AbstractEditorDefinition

getDisplayDefinition

public ObjectEditorDefinition getDisplayDefinition()

setDisplayDefinition

public void setDisplayDefinition(ObjectEditorDefinition editorDef)

createEditorPath

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

Description copied from interface: EditorDefinition

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

public EditorReference createEditorPath(Object bean,
                                        MessageResolver messageResolver)

Description copied from interface: EditorDefinition

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

public EditorReference createReference(String parentId,
                                       MessageResolver messageResolver)

Creates a reference to the list. The method is used by the FormController to create links pointing to the child lists.

createReference

protected EditorReference createReference(String parentId,
                                          String parentEditorId,
                                          MessageResolver messageResolver)

getListConfig

public ListConfig getListConfig()

getDao

public RiotDao getDao()

getEditorUrl

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