de.hybris.platform.cscockpit.widgets.renderers.impl

Class AbstractCsWidgetRenderer<T extends Widget>

java.lang.Object

de.hybris.platform.cscockpit.widgets.renderers.impl.AbstractCsWidgetRenderer<T>

All Implemented Interfaces:

WidgetRenderer<T>

Direct Known Subclasses:

AbstractCheckoutAddressWidgetRenderer, AbstractCockpitEditorWidgetRenderer, AbstractCreateWidgetRenderer, AbstractCsListboxWidgetRenderer, AbstractOrderTotalsWidgetRenderer, BasketSearchWidgetRenderer, CallContextWidgetRenderer, EndCallWidgetRenderer, HelpWidgetRenderer, OrderDetailsAddressWidgetRenderer, OrderDetailsOrderPaymentWidgetRenderer, OrderDetailsWidgetRenderer, OrderManagementActionsWidgetRenderer, PlaceOrderWidgetRenderer, TicketCloseWidgetRenderer, TicketHeaderWidgetRenderer, TicketPriorityChangeWidgetRenderer, TicketStateChangeWidgetRenderer

public abstract class AbstractCsWidgetRenderer<T extends Widget>
extends java.lang.Object
implements WidgetRenderer<T>

Abstract class intended to be used as a base class for WidgetRenderers in the CS Cockpit application.

Creates standard caption and content containers to be used throughout the CS Cockpit application for UI consistency purposes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractCsWidgetRenderer.ConfirmBeforeCompletingRequestEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CSS_WIDGET_CAPTION
protected static java.lang.String	CSS_WIDGET_CONTENT

Constructor Summary

Constructors

Constructor and Description
AbstractCsWidgetRenderer()

Method Summary

Modifier and Type	Method and Description
HtmlBasedComponent	createCaption(T widget) Creates and returns the widget's caption component.
protected EventListener	createConfirmBeforeCompletingRequestEventListener(T widget, EventListener innerEvent)
HtmlBasedComponent	createContent(T widget) Creates and returns the widget's (main) content component.
protected abstract HtmlBasedComponent	createContentInternal(T widget, HtmlBasedComponent rootContainer) Responsible for creating the actual content.
protected TypeService	getCockpitTypeService()
protected LabelService	getLabelService()
protected PropertyEditorHelper	getPropertyEditorHelper()
protected PropertyRendererHelper	getPropertyRendererHelper()
protected SystemService	getSystemService()
protected void	handleConfirmBeforeCompletingRequestEvent(T widget, Event event, EventListener innerEvent)
void	setCockpitTypeService(TypeService typeService)
void	setLabelService(LabelService labelService)
void	setPropertyEditorHelper(PropertyEditorHelper propertyEditorHelper)
void	setPropertyRendererHelper(PropertyRendererHelper propertyRendererHelper)
void	setSystemService(SystemService systemService)

Methods inherited from class java.lang.Object

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

Field Detail

CSS_WIDGET_CAPTION

protected static final java.lang.String CSS_WIDGET_CAPTION

See Also:

Constant Field Values

CSS_WIDGET_CONTENT

protected static final java.lang.String CSS_WIDGET_CONTENT

See Also:

Constant Field Values

Constructor Detail

AbstractCsWidgetRenderer

public AbstractCsWidgetRenderer()

Method Detail

getCockpitTypeService

protected TypeService getCockpitTypeService()

setCockpitTypeService

public void setCockpitTypeService(TypeService typeService)

getLabelService

protected LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getSystemService

protected SystemService getSystemService()

setSystemService

public void setSystemService(SystemService systemService)

getPropertyRendererHelper

protected PropertyRendererHelper getPropertyRendererHelper()

setPropertyRendererHelper

public void setPropertyRendererHelper(PropertyRendererHelper propertyRendererHelper)

getPropertyEditorHelper

protected PropertyEditorHelper getPropertyEditorHelper()

setPropertyEditorHelper

public void setPropertyEditorHelper(PropertyEditorHelper propertyEditorHelper)

createCaption

public HtmlBasedComponent createCaption(T widget)

Description copied from interface: WidgetRenderer

Creates and returns the widget's caption component.

Note: The renderer is not responsible for attaching the caption component to the passed widget instance. This is handled automatically during the widget initialization process.

Specified by:

createCaption in interface WidgetRenderer<T extends Widget>

Parameters:

widget - the widget component

Returns:

the created caption component

createContent

public HtmlBasedComponent createContent(T widget)

Description copied from interface: WidgetRenderer

Creates and returns the widget's (main) content component.

Note: The renderer is not responsible for attaching the content component to the passed widget instance. This is handled automatically during the widget initialization process.
However, some widgets (e.g. InputWidget) need to be able to access specific content components (e.g. input component) for updating purposes etc, which means that the renderer needs to pass those components to the widget directly. Please see InputWidget#setInputComponent(org.zkoss.zul.impl.api.InputElement) for an example.

Specified by:

createContent in interface WidgetRenderer<T extends Widget>

Parameters:

widget - the widget component

Returns:

the created content component

createContentInternal

protected abstract HtmlBasedComponent createContentInternal(T widget,
                                                            HtmlBasedComponent rootContainer)

Responsible for creating the actual content. The AbstractCsWidgetRenderer provides a default implementation for creating the content container itself (see createContent(Widget)).

Parameters:

widget - the widget

rootContainer - the root html component that will be set as the content of the widget

Returns:

the widget's content

createConfirmBeforeCompletingRequestEventListener

protected EventListener createConfirmBeforeCompletingRequestEventListener(T widget,
                                                                          EventListener innerEvent)

handleConfirmBeforeCompletingRequestEvent

protected void handleConfirmBeforeCompletingRequestEvent(T widget,
                                                         Event event,
                                                         EventListener innerEvent)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception