Package org.opencms.acacia.client

Interface I_CmsEntityRenderer

All Known Implementing Classes:

CmsDataViewWidgetRenderer, CmsNativeComplexWidgetRenderer, CmsRenderer

public interface I_CmsEntityRenderer

Renders an entity into a widget.

Method Summary

Modifier and Type	Method	Description
I_CmsEntityRenderer	configure(java.lang.String configuration)	Returns a copy of this renderer which has been configured with the given configuration string.
java.lang.String	getName()	Gets the name of the renderer (should be unique for each renderer class).
void	renderAttributeValue(org.opencms.acacia.shared.CmsEntity parentEntity, CmsAttributeHandler attributeHandler, int attributeIndex, com.google.gwt.user.client.ui.Panel context)	Renders a single attribute value.
void	renderForm(org.opencms.acacia.shared.CmsEntity entity, com.google.gwt.user.client.ui.Panel context, I_CmsAttributeHandler parentHandler, int attributeIndex)	Renders the given entity into a form.
CmsTabbedPanel<com.google.gwt.user.client.ui.FlowPanel>	renderForm(org.opencms.acacia.shared.CmsEntity entity, java.util.List<org.opencms.acacia.shared.CmsTabInfo> tabInfos, com.google.gwt.user.client.ui.Panel context, I_CmsAttributeHandler parentHandler, int attributeIndex)	Renders the given entity into a form with tabs.
void	renderInline(org.opencms.acacia.shared.CmsEntity parentEntity, java.lang.String attributeName, I_CmsInlineFormParent formParent, I_CmsInlineHtmlUpdateHandler updateHandler, I_CmsAttributeHandler parentHandler, int attributeIndex, int minOccurrence, int maxOccurrence)	Injects editing widgets into the given DOM context to enable editing of the given entity attribute.
void	renderInline(org.opencms.acacia.shared.CmsEntity entity, I_CmsInlineFormParent formParent, I_CmsInlineHtmlUpdateHandler updateHandler, I_CmsAttributeHandler parentHandler, int attributeIndex)	Injects editing widgets into the given DOM context to enable editing of the given entity.

Method Detail

configure

I_CmsEntityRenderer configure(java.lang.String configuration)

Returns a copy of this renderer which has been configured with the given configuration string.

Parameters:

configuration - the configuration string

Returns:

the configured copy of the renderer

getName

java.lang.String getName()

Gets the name of the renderer (should be unique for each renderer class).

Returns:

the renderer name

renderAttributeValue

void renderAttributeValue(org.opencms.acacia.shared.CmsEntity parentEntity,
                          CmsAttributeHandler attributeHandler,
                          int attributeIndex,
                          com.google.gwt.user.client.ui.Panel context)

Renders a single attribute value. Used for inline editing to show a fragment of the form.

Parameters:

parentEntity - the parent entity

attributeHandler - the attribute handler

attributeIndex - the value index

context - the parent widget

renderForm

CmsTabbedPanel<com.google.gwt.user.client.ui.FlowPanel> renderForm(org.opencms.acacia.shared.CmsEntity entity,
                                                                   java.util.List<org.opencms.acacia.shared.CmsTabInfo> tabInfos,
                                                                   com.google.gwt.user.client.ui.Panel context,
                                                                   I_CmsAttributeHandler parentHandler,
                                                                   int attributeIndex)

Renders the given entity into a form with tabs.

Parameters:

entity - the entity to render

tabInfos - the tab infos

context - the context widget panel

parentHandler - the parent attribute handler

attributeIndex - the attribute index

Returns:

the tabbed panel

renderForm

void renderForm(org.opencms.acacia.shared.CmsEntity entity,
                com.google.gwt.user.client.ui.Panel context,
                I_CmsAttributeHandler parentHandler,
                int attributeIndex)

Renders the given entity into a form.

Parameters:

entity - the entity to render

context - the context widget panel

parentHandler - the parent attribute handler

attributeIndex - the attribute index

renderInline

void renderInline(org.opencms.acacia.shared.CmsEntity entity,
                  I_CmsInlineFormParent formParent,
                  I_CmsInlineHtmlUpdateHandler updateHandler,
                  I_CmsAttributeHandler parentHandler,
                  int attributeIndex)

Injects editing widgets into the given DOM context to enable editing of the given entity.

Parameters:

entity - the entity to render

formParent - formParent the form parent widget

updateHandler - handles updates on the HTML required due to entity data changes

parentHandler - the parent attribute handler

attributeIndex - the attribute index

renderInline

void renderInline(org.opencms.acacia.shared.CmsEntity parentEntity,
                  java.lang.String attributeName,
                  I_CmsInlineFormParent formParent,
                  I_CmsInlineHtmlUpdateHandler updateHandler,
                  I_CmsAttributeHandler parentHandler,
                  int attributeIndex,
                  int minOccurrence,
                  int maxOccurrence)

Injects editing widgets into the given DOM context to enable editing of the given entity attribute.

Parameters:

parentEntity - the parent entity

attributeName - the attribute name

formParent - the form parent widget

updateHandler - handles updates on the HTML required due to entity data changes

parentHandler - the parent attribute handler

attributeIndex - the attribute index

minOccurrence - the minimum occurrence of this attribute

maxOccurrence - the maximum occurrence of this attribute