Package com.hybris.cockpitng.widgets.summaryview.renderer

Class DefaultSummaryViewAttributeRenderer

java.lang.Object

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

com.hybris.cockpitng.widgets.summaryview.renderer.AbstractSummaryViewItemWithIconRenderer<java.lang.Object>

com.hybris.cockpitng.widgets.summaryview.renderer.DefaultSummaryViewAttributeRenderer

All Implemented Interfaces:

NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,java.lang.Object>, WidgetComponentRenderer<org.zkoss.zk.ui.Component,Attribute,java.lang.Object>

public class DefaultSummaryViewAttributeRenderer
extends AbstractSummaryViewItemWithIconRenderer<java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	DEFAULT_EDITOR_WRAPPER_TEMPLATE
protected static java.lang.String	SETTING_DEFAULT_EDITOR_WRAPPER_TEMPLATE	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6

Constructor Summary

Constructors

Constructor	Description
DefaultSummaryViewAttributeRenderer()

Method Summary

Modifier and Type	Method	Description
protected Editor	buildEditor(Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, EditorBuilder editorBuilder)
protected Editor	createAttributeEditor(Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, java.lang.String typeCode, WidgetInstanceManager widgetInstanceManager)
protected EditorBuilder	createEditorBuilder(Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, java.lang.String typeCode, WidgetInstanceManager widgetInstanceManager)
protected EditorBuilder	createEditorBuilder(WidgetInstanceManager widgetInstanceManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected EditorWrappingUtils	getEditorWrappingUtils()
protected java.lang.String	getIconStatusSClass(org.zkoss.zk.ui.HtmlBasedComponent iconContainer, Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager)	Use AbstractSummaryViewItemWithIconRenderer.SCLASS_PATTERN_ICON as a template for building icon's css class name such as yw-summaryview-online-status-Online.
protected static boolean	isEditorWrappingEnabled(TypedSettingsMap widgetSettings)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected Parameter	mapParameter(Parameter parameter)
protected java.util.Collection<Parameter>	mapParameters(java.util.Collection<Parameter> parameters)
protected void	renderAttributeEditor(org.zkoss.zul.Div attributeContainer, Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, java.lang.String typeCode, WidgetInstanceManager widgetInstanceManager)
protected void	renderValue(org.zkoss.zul.Div attributeContainer, Attribute attributeConfiguration, java.lang.Object data, DataAttribute dataAttribute, DataType dataType, WidgetInstanceManager widgetInstanceManager)	Used by AbstractSummaryViewItemWithIconRenderer.render(Component, Attribute, Object, DataType, WidgetInstanceManager) method for obtaining attribute representation.
void	setEditorWrappingUtils(EditorWrappingUtils editorWrappingUtils)
protected java.lang.String	wrapEditorIfNecessary(java.lang.String editor, TypedSettingsMap widgetSettings)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6

Methods inherited from class com.hybris.cockpitng.widgets.summaryview.renderer.AbstractSummaryViewItemWithIconRenderer

canHandle, createContainer, createIcon, getAttributeLabelResolver, getIconStatusSClass, getLabelService, getPermissionFacade, hasAttributePermission, hasPermission, render, renderIcon, renderInvalidDataLabel, renderLabel, renderNoReadAccess, setAttributeLabelResolver, setLabelService, setPermissionFacade

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

Field Detail

SETTING_DEFAULT_EDITOR_WRAPPER_TEMPLATE

@Deprecated(since="6.6",
            forRemoval=true)
protected static final java.lang.String SETTING_DEFAULT_EDITOR_WRAPPER_TEMPLATE

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

DefaultEditorWrappingUtils, Constant Field Values

DEFAULT_EDITOR_WRAPPER_TEMPLATE

protected static final java.lang.String DEFAULT_EDITOR_WRAPPER_TEMPLATE

Constructor Detail

DefaultSummaryViewAttributeRenderer

public DefaultSummaryViewAttributeRenderer()

Method Detail

getIconStatusSClass

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

Description copied from class: AbstractSummaryViewItemWithIconRenderer

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

Specified by:

getIconStatusSClass in class AbstractSummaryViewItemWithIconRenderer<java.lang.Object>

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:

AbstractSummaryViewItemWithIconRenderer.getIconStatusSClass(String, String)

renderValue

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

Description copied from class: AbstractSummaryViewItemWithIconRenderer

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

Specified by:

renderValue in class AbstractSummaryViewItemWithIconRenderer<java.lang.Object>

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

renderAttributeEditor

protected void renderAttributeEditor(org.zkoss.zul.Div attributeContainer,
                                     Attribute attributeConfiguration,
                                     java.lang.Object data,
                                     DataAttribute dataAttribute,
                                     java.lang.String typeCode,
                                     WidgetInstanceManager widgetInstanceManager)

createAttributeEditor

protected Editor createAttributeEditor(Attribute attributeConfiguration,
                                       java.lang.Object data,
                                       DataAttribute dataAttribute,
                                       java.lang.String typeCode,
                                       WidgetInstanceManager widgetInstanceManager)

mapParameters

protected java.util.Collection<Parameter> mapParameters(java.util.Collection<Parameter> parameters)

mapParameter

protected Parameter mapParameter(Parameter parameter)

createEditorBuilder

@Deprecated(since="6.6",
            forRemoval=true)
protected EditorBuilder createEditorBuilder(WidgetInstanceManager widgetInstanceManager)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

createEditorBuilder(Attribute, Object, DataAttribute, String, WidgetInstanceManager)

createEditorBuilder

protected EditorBuilder createEditorBuilder(Attribute attributeConfiguration,
                                            java.lang.Object data,
                                            DataAttribute dataAttribute,
                                            java.lang.String typeCode,
                                            WidgetInstanceManager widgetInstanceManager)

buildEditor

protected Editor buildEditor(Attribute attributeConfiguration,
                             java.lang.Object data,
                             DataAttribute dataAttribute,
                             EditorBuilder editorBuilder)

wrapEditorIfNecessary

@Deprecated(since="6.6",
            forRemoval=true)
protected java.lang.String wrapEditorIfNecessary(java.lang.String editor,
                                                 TypedSettingsMap widgetSettings)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

EditorWrappingUtils

isEditorWrappingEnabled

@Deprecated(since="6.6",
            forRemoval=true)
protected static boolean isEditorWrappingEnabled(TypedSettingsMap widgetSettings)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

EditorWrappingUtils

getEditorWrappingUtils

protected EditorWrappingUtils getEditorWrappingUtils()

setEditorWrappingUtils

public void setEditorWrappingUtils(EditorWrappingUtils editorWrappingUtils)