com.hybris.cockpitng.common.renderer

Class AbstractCustomMenuActionRenderer<PARENT extends org.zkoss.zk.ui.HtmlBasedComponent,CONFIG,DATA>

java.lang.Object

com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer<PARENT,CONFIG,DATA>

com.hybris.cockpitng.common.renderer.AbstractCustomMenuActionRenderer<PARENT,CONFIG,DATA>

Type Parameters:

PARENT - type of parent component on which thee dots might be rendered

CONFIG - type of configuration object (passed directly to menu renderers)

DATA - type of data rendered (passed directly to menu renderers)

All Implemented Interfaces:

NotifyingWidgetComponentRenderer<PARENT,CONFIG,DATA>, WidgetComponentRenderer<PARENT,CONFIG,DATA>

public abstract class AbstractCustomMenuActionRenderer<PARENT extends org.zkoss.zk.ui.HtmlBasedComponent,CONFIG,DATA>
extends AbstractWidgetComponentRenderer<PARENT,CONFIG,DATA>

So called "three dots renderer". It is a renderer that add a button with three dots to DOM. Whenever a user clicks it a popup menu is displayed.

Content of popup menu is rendered by all renderers returned from abstract method

Constructor Summary

Constructors

Constructor and Description
AbstractCustomMenuActionRenderer()

Method Summary

Modifier and Type	Method and Description
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	createClickListener(org.zkoss.zul.Menupopup parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.OpenEvent>	createMenuOpenListener(org.zkoss.zk.ui.HtmlBasedComponent menuAction, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected List<WidgetComponentRenderer<org.zkoss.zul.Menupopup,CONFIG,DATA>>	getActionRenderers()
protected String	getMenuPopupSclass()
protected MenupopupPosition	getPopupPosition()
protected void	onActionClick(org.zkoss.zul.Menupopup parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
void	render(PARENT parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager) Renders a component inside parent, representing given data and complying to given ui configuration.
protected org.zkoss.zk.ui.HtmlBasedComponent	renderMenuAction(PARENT parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected org.zkoss.zul.Menupopup	renderMenuPopup(PARENT parent, CONFIG configuration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
void	setActionRenderers(List<WidgetComponentRenderer<org.zkoss.zul.Menupopup,CONFIG,DATA>> actionRenderers)
void	setMenupopupPosition(MenupopupPosition menupopupPosition)
void	setMenupopupSclass(String menupopupSclass)

Methods inherited from class com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer

addRendererListener, fireComponentRendered, fireComponentRendered, fireComponentRendered, removeRendererListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.widgets.common.WidgetComponentRenderer

render

Constructor Detail

AbstractCustomMenuActionRenderer

public AbstractCustomMenuActionRenderer()

Method Detail

render

public void render(PARENT parent,
                   CONFIG configuration,
                   DATA data,
                   DataType dataType,
                   WidgetInstanceManager widgetInstanceManager)

Description copied from interface: WidgetComponentRenderer

Renders a component inside parent, representing given data and complying to given ui configuration. The data should be of give dataType. The renderer implementation could communicate with underlying widget via widgetInstanceManager.

Parameters:

parent - parent component on which to render

configuration - configuration of renderer

data - data to be rendered

dataType - meta information about type of data provided

widgetInstanceManager - widget manager in scope of which renderer is used

renderMenuAction

protected org.zkoss.zk.ui.HtmlBasedComponent renderMenuAction(PARENT parent,
                                                              CONFIG configuration,
                                                              DATA data,
                                                              DataType dataType,
                                                              WidgetInstanceManager widgetInstanceManager)

renderMenuPopup

protected org.zkoss.zul.Menupopup renderMenuPopup(PARENT parent,
                                                  CONFIG configuration,
                                                  DATA data,
                                                  DataType dataType,
                                                  WidgetInstanceManager widgetInstanceManager)

setActionRenderers

public void setActionRenderers(List<WidgetComponentRenderer<org.zkoss.zul.Menupopup,CONFIG,DATA>> actionRenderers)

getActionRenderers

protected List<WidgetComponentRenderer<org.zkoss.zul.Menupopup,CONFIG,DATA>> getActionRenderers()

createMenuOpenListener

protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.OpenEvent> createMenuOpenListener(org.zkoss.zk.ui.HtmlBasedComponent menuAction,
                                                                                                      CONFIG configuration,
                                                                                                      DATA data,
                                                                                                      DataType dataType,
                                                                                                      WidgetInstanceManager widgetInstanceManager)

createClickListener

protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> createClickListener(org.zkoss.zul.Menupopup parent,
                                                                                               CONFIG configuration,
                                                                                               DATA data,
                                                                                               DataType dataType,
                                                                                               WidgetInstanceManager widgetInstanceManager)

onActionClick

protected void onActionClick(org.zkoss.zul.Menupopup parent,
                             CONFIG configuration,
                             DATA data,
                             DataType dataType,
                             WidgetInstanceManager widgetInstanceManager)

setMenupopupSclass

public void setMenupopupSclass(String menupopupSclass)

setMenupopupPosition

public void setMenupopupPosition(MenupopupPosition menupopupPosition)

getPopupPosition

protected MenupopupPosition getPopupPosition()

getMenuPopupSclass

protected String getMenuPopupSclass()