Package org.opencms.acacia.client

Class CmsRenderer

java.lang.Object

org.opencms.acacia.client.CmsRenderer

All Implemented Interfaces:

I_CmsEntityRenderer

public class CmsRenderer
extends Object
implements I_CmsEntityRenderer

Renders the widgets for an in-line form.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CmsRenderer.TabSelectionHandler	Calls resize on tab selection on the tabs child hierarchy.
protected class	CmsRenderer.TabSizeHandler	Handles the size of a tabbed panel.
protected class	CmsRenderer.WidgetChangeHandler	The widget value change handler.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY_CLASS	The entity CSS class.
static final String	LABEL_CLASS	The attribute label CSS class.
static final String	RENDERER_NAME	The renderer name.
static final String	WIDGET_HOLDER_CLASS	The widget holder CSS class.

Constructor Summary

Constructors

Constructor	Description
CmsRenderer(I_CmsEntityBackend entityBackEnd, I_CmsWidgetService widgetService)	Constructor.

Method Summary

Modifier and Type	Method	Description
I_CmsEntityRenderer	configure(String configuration)	Returns a copy of this renderer which has been configured with the given configuration string.
protected org.opencms.acacia.shared.CmsEntityAttribute	createEmptyAttribute(org.opencms.acacia.shared.CmsEntity parentEntity, String attributeName, CmsAttributeHandler handler, int minOccurrence)	Creates an empty attribute.
static List<CmsChoiceMenuEntryBean>	getChoiceEntries(org.opencms.acacia.shared.CmsType attributeType, boolean startingAtChoiceAttribute)	Gets the paths of nested choice attributes starting from a given type.
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, 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, 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.
static void	setAttributeChoice(I_CmsWidgetService widgetService, CmsAttributeValueView valueWidget, org.opencms.acacia.shared.CmsType attributeType)	Sets the attribute choices if present.

Methods inherited from class java.lang.Object

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

Field Details

ENTITY_CLASS

public static final String ENTITY_CLASS

The entity CSS class.

LABEL_CLASS

public static final String LABEL_CLASS

The attribute label CSS class.

RENDERER_NAME

public static final String RENDERER_NAME

The renderer name.

See Also:

• Constant Field Values

WIDGET_HOLDER_CLASS

public static final String WIDGET_HOLDER_CLASS

The widget holder CSS class.

Constructor Details

CmsRenderer

public CmsRenderer(I_CmsEntityBackend entityBackEnd,
 I_CmsWidgetService widgetService)

Constructor.

Parameters:

entityBackEnd - the entity back end instance

widgetService - the widget service

Method Details

getChoiceEntries

public static List<CmsChoiceMenuEntryBean> getChoiceEntries(org.opencms.acacia.shared.CmsType attributeType,
 boolean startingAtChoiceAttribute)

Gets the paths of nested choice attributes starting from a given type.

Parameters:

attributeType - the type from which to start

startingAtChoiceAttribute - true if the attribute is a synthetic CHOICE_ATTRIBUTE

Returns:

the list of nested choice attribute name paths

setAttributeChoice

public static void setAttributeChoice(I_CmsWidgetService widgetService,
 CmsAttributeValueView valueWidget,
 org.opencms.acacia.shared.CmsType attributeType)

Sets the attribute choices if present.

Parameters:

widgetService - the widget service to use

valueWidget - the value widget

attributeType - the attribute type

configure

public I_CmsEntityRenderer configure(String configuration)

Description copied from interface: I_CmsEntityRenderer

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

Specified by:

configure in interface I_CmsEntityRenderer

Parameters:

configuration - the configuration string

Returns:

the configured copy of the renderer

See Also:

• I_CmsEntityRenderer.configure(java.lang.String)

getName

public String getName()

Description copied from interface: I_CmsEntityRenderer

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

Specified by:

getName in interface I_CmsEntityRenderer

Returns:

the renderer name

See Also:

• I_CmsEntityRenderer.getName()

renderAttributeValue

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

Description copied from interface: I_CmsEntityRenderer

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

Specified by:

renderAttributeValue in interface I_CmsEntityRenderer

Parameters:

parentEntity - the parent entity

attributeHandler - the attribute handler

attributeIndex - the value index

context - the parent widget

See Also:

• I_CmsEntityRenderer.renderAttributeValue(org.opencms.acacia.shared.CmsEntity, org.opencms.acacia.client.CmsAttributeHandler, int, com.google.gwt.user.client.ui.Panel)

renderForm

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

Description copied from interface: I_CmsEntityRenderer

Renders the given entity into a form with tabs.

Specified by:

renderForm in interface I_CmsEntityRenderer

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

See Also:

• I_CmsEntityRenderer.renderForm(org.opencms.acacia.shared.CmsEntity, java.util.List, com.google.gwt.user.client.ui.Panel, org.opencms.acacia.client.I_CmsAttributeHandler, int)

renderForm

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

Description copied from interface: I_CmsEntityRenderer

Renders the given entity into a form.

Specified by:

renderForm in interface I_CmsEntityRenderer

Parameters:

entity - the entity to render

context - the context widget panel

parentHandler - the parent attribute handler

attributeIndex - the attribute index

See Also:

• I_CmsEntityRenderer.renderForm(org.opencms.acacia.shared.CmsEntity, com.google.gwt.user.client.ui.Panel, org.opencms.acacia.client.I_CmsAttributeHandler, int)

renderInline

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

Description copied from interface: I_CmsEntityRenderer

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

Specified by:

renderInline in interface I_CmsEntityRenderer

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

See Also:

• I_CmsEntityRenderer.renderInline(org.opencms.acacia.shared.CmsEntity, org.opencms.acacia.client.I_CmsInlineFormParent, org.opencms.acacia.client.I_CmsInlineHtmlUpdateHandler, org.opencms.acacia.client.I_CmsAttributeHandler, int)

renderInline

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

Description copied from interface: I_CmsEntityRenderer

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

Specified by:

renderInline in interface I_CmsEntityRenderer

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

See Also:

• I_CmsEntityRenderer.renderInline(org.opencms.acacia.shared.CmsEntity, java.lang.String, org.opencms.acacia.client.I_CmsInlineFormParent, org.opencms.acacia.client.I_CmsInlineHtmlUpdateHandler, org.opencms.acacia.client.I_CmsAttributeHandler, int, int, int)

createEmptyAttribute

protected org.opencms.acacia.shared.CmsEntityAttribute createEmptyAttribute(org.opencms.acacia.shared.CmsEntity parentEntity,
 String attributeName,
 CmsAttributeHandler handler,
 int minOccurrence)

Creates an empty attribute.

Parameters:

parentEntity - the parent entity

attributeName - the attribute name

handler - the attribute handler

minOccurrence - the minimum occurrence of the attribute

Returns:

the entity attribute