com.hybris.cockpitng.widgets.summaryview.renderer

Class AbstractSummaryViewItemWithIconRenderer<DATA>

java.lang.Object

com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,DATA>

com.hybris.cockpitng.widgets.summaryview.renderer.AbstractSummaryViewItemWithIconRenderer<DATA>

All Implemented Interfaces:

NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,DATA>, WidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,DATA>

Direct Known Subclasses:

DefaultSummaryViewAssetsRenderer, DefaultSummaryViewAttributeRenderer

public abstract class AbstractSummaryViewItemWithIconRenderer<DATA>
extends AbstractWidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,DATA>

Constructor Summary

Constructors

Constructor and Description
AbstractSummaryViewItemWithIconRenderer()

Method Summary

Modifier and Type	Method and Description
protected boolean	canHandle(DATA data, DataType dataType) Check whether renderer supports given data
protected org.zkoss.zk.ui.HtmlBasedComponent	createContainer(org.zkoss.zk.ui.Component parent, Attribute attributeConfiguration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected org.zkoss.zk.ui.HtmlBasedComponent	createIcon(org.zkoss.zk.ui.Component parent, Attribute attributeConfiguration, DATA data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected AttributeLabelResolver	getAttributeLabelResolver()
protected abstract String	getIconStatusSClass(org.zkoss.zk.ui.HtmlBasedComponent iconContainer, Attribute attributeConfiguration, DATA data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager) Use SCLASS_PATTERN_ICON as a template for building icon's css class name such as yw-summaryview-online-status-Online.
protected String	getIconStatusSClass(String iconGroup, String iconName) Provides css class for icon element.
protected LabelService	getLabelService()
protected PermissionFacade	getPermissionFacade()
protected boolean	hasAttributePermission(DATA data, DataAttribute dataAttribute) Check whether there are enough permissions for a renderer to render an attribute.
protected boolean	hasPermission(DATA data, DataType dataType) Check whether there are enough permissions for a renderer to render an attribute.
void	render(org.zkoss.zk.ui.Component parent, Attribute attributeConfiguration, DATA data, DataType dataType, WidgetInstanceManager widgetInstanceManager) Renders a component inside parent, representing given data and complying to given ui configuration.
protected void	renderIcon(org.zkoss.zk.ui.Component parent, Attribute attributeConfiguration, DATA data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected void	renderInvalidDataLabel(org.zkoss.zk.ui.Component parent, WidgetInstanceManager widgetInstanceManager)
protected void	renderLabel(org.zkoss.zul.Div attributeContainer, Attribute attributeConfiguration, DATA data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager)
protected void	renderNoReadAccess(org.zkoss.zk.ui.Component parent, DATA data)
protected abstract void	renderValue(org.zkoss.zul.Div attributeContainer, Attribute attributeConfiguration, DATA data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager) Used by render(Component, Attribute, Object, DataType, WidgetInstanceManager) method for obtaining attribute representation.
void	setAttributeLabelResolver(AttributeLabelResolver attributeLabelResolver)
void	setLabelService(LabelService labelService)
void	setPermissionFacade(PermissionFacade permissionFacade)

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

AbstractSummaryViewItemWithIconRenderer

public AbstractSummaryViewItemWithIconRenderer()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   Attribute attributeConfiguration,
                   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

attributeConfiguration - 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

createContainer

protected org.zkoss.zk.ui.HtmlBasedComponent createContainer(org.zkoss.zk.ui.Component parent,
                                                             Attribute attributeConfiguration,
                                                             DATA data,
                                                             DataType dataType,
                                                             WidgetInstanceManager widgetInstanceManager)

canHandle

protected boolean canHandle(DATA data,
                            DataType dataType)

Check whether renderer supports given data

Parameters:

data - data

dataType - type of data

Returns:

true if given data is supported

createIcon

protected org.zkoss.zk.ui.HtmlBasedComponent createIcon(org.zkoss.zk.ui.Component parent,
                                                        Attribute attributeConfiguration,
                                                        DATA data,
                                                        DataAttribute dataAttribute,
                                                        DataType dataType,
                                                        WidgetInstanceManager widgetInstanceManager)

renderIcon

protected void renderIcon(org.zkoss.zk.ui.Component parent,
                          Attribute attributeConfiguration,
                          DATA data,
                          DataAttribute dataAttribute,
                          DataType dataType,
                          WidgetInstanceManager widgetInstanceManager)

hasPermission

protected boolean hasPermission(DATA data,
                                DataType dataType)

Check whether there are enough permissions for a renderer to render an attribute. By default it checks whether given object's type and given instance can be read.

Parameters:

data - data

dataType - type of data

Returns:

true if renderer can access given data and given typeCode.

hasAttributePermission

protected boolean hasAttributePermission(DATA data,
                                         DataAttribute dataAttribute)

Check whether there are enough permissions for a renderer to render an attribute. By default it checks whether property of given given object and data attribute can be read.

Parameters:

data - data

dataAttribute - attribute of data

Returns:

true if renderer can access property of data for a given dataAttribute.

getIconStatusSClass

protected String getIconStatusSClass(String iconGroup,
                                     String iconName)

Provides css class for icon element.

Method provided for convenience to be used in scope of getIconStatusSClass(HtmlBasedComponent, Attribute, Object, DataAttribute, DataType, WidgetInstanceManager)

Parameters:

iconGroup - group of icons (in most cases it is strictly bound to name of renderer)

iconName - particular icon from provided group

Returns:

css class to be set in icon element

getIconStatusSClass

protected abstract String getIconStatusSClass(org.zkoss.zk.ui.HtmlBasedComponent iconContainer,
                                              Attribute attributeConfiguration,
                                              DATA data,
                                              DataAttribute dataAttribute,
                                              DataType dataType,
                                              WidgetInstanceManager widgetInstanceManager)

Use SCLASS_PATTERN_ICON as a template for building icon's css class name such as yw-summaryview-online-status-Online.

Parameters:

iconContainer - component that will be marked with returned class

attributeConfiguration - configuration of rendering

data - data

dataAttribute - attribute to be rendered

dataType - type code of data

widgetInstanceManager - instance manager of widget on which rendering takes place

Returns:

css class which is added to each item's icon container

See Also:

getIconStatusSClass(String, String)

renderValue

protected abstract void renderValue(org.zkoss.zul.Div attributeContainer,
                                    Attribute attributeConfiguration,
                                    DATA data,
                                    DataAttribute dataAttribute,
                                    DataType dataType,
                                    WidgetInstanceManager widgetInstanceManager)

Used by render(Component, Attribute, Object, DataType, WidgetInstanceManager) method for obtaining attribute representation.

Parameters:

attributeContainer - attribute representation can be appended to this container

attributeConfiguration - configuration of rendering

data - data

dataAttribute - attribute to be rendered

dataType - type code of data

widgetInstanceManager - widget instance manager

renderLabel

protected void renderLabel(org.zkoss.zul.Div attributeContainer,
                           Attribute attributeConfiguration,
                           DATA data,
                           DataAttribute dataAttribute,
                           DataType dataType,
                           WidgetInstanceManager widgetInstanceManager)

renderInvalidDataLabel

protected void renderInvalidDataLabel(org.zkoss.zk.ui.Component parent,
                                      WidgetInstanceManager widgetInstanceManager)

renderNoReadAccess

protected void renderNoReadAccess(org.zkoss.zk.ui.Component parent,
                                  DATA data)

getLabelService

protected LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getPermissionFacade

protected PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getAttributeLabelResolver

protected AttributeLabelResolver getAttributeLabelResolver()

setAttributeLabelResolver

public void setAttributeLabelResolver(AttributeLabelResolver attributeLabelResolver)