Package com.hybris.cockpitng.editor.instant

Class InstantEditorRenderer

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<java.lang.Object>

com.hybris.cockpitng.editor.decorated.AbstractEditorRendererWrapper

com.hybris.cockpitng.editor.instant.InstantEditorRenderer

All Implemented Interfaces:

CockpitEditorRenderer<java.lang.Object>

public class InstantEditorRenderer
extends AbstractEditorRendererWrapper

Editor wrapper for all types of editors. Presents its value as a label, which can be clicked to display the underlying editor.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EDITOR_ID	Editor ID of Instant Editor
protected static java.lang.String	ICONSCLASS_CANCEL_BUTTON
protected static java.lang.String	ICONSCLASS_CONFIRM_BUTTON
static java.lang.String	LABEL_KEY_NO_VALUE	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	PARAM_LABEL_NO_VALUE_KEY	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	PARAM_LABEL_NO_VALUE_STYLE	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	PARAM_LABEL_PROVIDER_BEAN	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	PARAM_LABEL_RENDERER_BEAN	editor-parameter which can be used to change list of label providers to be used
protected static java.lang.String	YE_INSTANT_EDITOR_ATTRIBUTE_LABEL
protected static java.lang.String	YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_CONTAINER
protected static java.lang.String	YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_MANDATORY
protected static java.lang.String	YE_INSTANT_EDITOR_BUTTON_CANCEL
protected static java.lang.String	YE_INSTANT_EDITOR_BUTTON_CONFIRM
protected static java.lang.String	YE_INSTANT_EDITOR_BUTTONS_CONTAINER
static java.lang.String	YE_INSTANT_EDITOR_COMPONENT_HIDDEN
static java.lang.String	YE_INSTANT_EDITOR_COMPONENT_VISIBLE
protected static java.lang.String	YE_INSTANT_EDITOR_EDITOR_CONTAINER
protected static java.lang.String	YE_INSTANT_EDITOR_LABEL_CONTAINER
protected static java.lang.String	YE_INSTANT_EDITOR_LABEL_EDITABLE
protected static java.lang.String	YE_INSTANT_EDITOR_LABEL_NO_VALUE	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected static java.lang.String	YE_INSTANT_EDITOR_LABEL_READONLY

Fields inherited from class com.hybris.cockpitng.editor.decorated.AbstractEditorRendererWrapper

DECORATED_EDITORS_EMBEDDED_CONTENT, DECORATED_EDITORS_PATTERN

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT, YW_EDITOR_AREA_LABEL_CONTAINER

Fields inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
InstantEditorRenderer()

Method Summary

Modifier and Type	Method	Description
protected org.zkoss.zul.Div	createAttributeLabel(EditorContext<?> context)
protected org.zkoss.zul.Button	createButton(java.lang.String sclass, java.lang.String iconSclass, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.MouseEvent> onClickListener)
protected EditorListener<java.lang.Object>	createChangedValueSuppressingEditorListenerProxy(EditorListener<java.lang.Object> listener)
protected org.zkoss.zul.Div	createEditorButtons(org.zkoss.zul.Div editorContainer, Editor editor, EditorListener<java.lang.Object> listener, org.zkoss.zk.ui.HtmlBasedComponent label, Executable labelUpdate)
protected org.zkoss.zul.Div	createEditorButtons(org.zkoss.zul.Div editorContainer, Editor editor, EditorListener<java.lang.Object> listener, org.zkoss.zul.Label label, InstantEditorLabelProvider labelProvider)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected org.zkoss.zul.Div	createEditorContainer(Editor editor, EditorListener<java.lang.Object> listener, org.zkoss.zk.ui.HtmlBasedComponent label, Executable labelUpdate)
protected org.zkoss.zul.Div	createEditorContainer(Editor editor, EditorListener<java.lang.Object> listener, org.zkoss.zul.Label label, InstantEditorLabelProvider labelProvider)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected Editor	createNestedEditor(EditorContext<java.lang.Object> context, EditorListener<java.lang.Object> listener)
protected java.lang.IllegalStateException	createNoLabelProviderFoundException(Editor editor, java.lang.String labelProviderBeanId)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected org.zkoss.zk.ui.HtmlBasedComponent	createValueLabel(EditorContext<java.lang.Object> context, EditorListener<java.lang.Object> listener, CockpitEditorRenderer<java.lang.Object> labelRenderer)
protected java.lang.String	getEditorTypeFromContext(EditorContext<java.lang.Object> context)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected java.util.List<InstantEditorLabelProvider>	getInstantEditorLabelProviders()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
void	render(org.zkoss.zk.ui.Component parent, EditorContext<java.lang.Object> context, EditorListener<java.lang.Object> listener)	Creates a new editor component and attaches it to the specified Component component.
protected java.util.Optional<InstantEditorLabelProvider>	resolveLabelProvider(java.lang.String editorType, java.lang.String labelProviderBeanId)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected CockpitEditorRenderer<java.lang.Object>	resolveLabelRenderer(EditorContext<java.lang.Object> context)
void	setInstantEditorLabelProviders(java.util.List<InstantEditorLabelProvider> instantEditorLabelProviders)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected void	updateValueLabel(org.zkoss.zk.ui.HtmlBasedComponent labelContainer, EditorContext<java.lang.Object> context, EditorListener<java.lang.Object> listener, java.lang.Object value, CockpitEditorRenderer<java.lang.Object> labelRenderer)
protected void	updateValueLabel(org.zkoss.zul.Label label, Editor editor, InstantEditorLabelProvider labelProvider)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6

Methods inherited from class com.hybris.cockpitng.editor.decorated.AbstractEditorRendererWrapper

createEditor, extractDecoratedEditorContent, extractDefinitions, getEditorTypeFromContext, prepareNestedContext

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

extractEmbeddedEditor, extractEmbeddedType, findAncestorEditor, findEmbeddedEditors, getInitialEditString, getL10nDecorator

Methods inherited from class java.lang.Object

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

Field Detail

EDITOR_ID

public static final java.lang.String EDITOR_ID

Editor ID of Instant Editor

See Also:

Constant Field Values

PARAM_LABEL_RENDERER_BEAN

public static final java.lang.String PARAM_LABEL_RENDERER_BEAN

editor-parameter which can be used to change list of label providers to be used

See Also:

Constant Field Values

PARAM_LABEL_PROVIDER_BEAN

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

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

since 6.6

See Also:

DefaultInstantEditorLabelRenderer.PARAM_LABEL_PROVIDER_BEAN, Constant Field Values

PARAM_LABEL_NO_VALUE_KEY

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

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

since 6.6

See Also:

AbstractInstantEditorLabelRenderer.PARAM_LABEL_NO_VALUE_KEY, Constant Field Values

PARAM_LABEL_NO_VALUE_STYLE

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

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

since 6.6

See Also:

AbstractInstantEditorLabelRenderer.PARAM_LABEL_NO_VALUE_STYLE, Constant Field Values

LABEL_KEY_NO_VALUE

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

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

since 6.6

See Also:

AbstractInstantEditorLabelRenderer.LABEL_KEY_NO_VALUE, Constant Field Values

YE_INSTANT_EDITOR_COMPONENT_VISIBLE

public static final java.lang.String YE_INSTANT_EDITOR_COMPONENT_VISIBLE

See Also:

Constant Field Values

YE_INSTANT_EDITOR_COMPONENT_HIDDEN

public static final java.lang.String YE_INSTANT_EDITOR_COMPONENT_HIDDEN

See Also:

Constant Field Values

YE_INSTANT_EDITOR_LABEL_NO_VALUE

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

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

since 6.6

See Also:

AbstractInstantEditorLabelRenderer.SCLASS_NO_VALUE, Constant Field Values

YE_INSTANT_EDITOR_LABEL_CONTAINER

protected static final java.lang.String YE_INSTANT_EDITOR_LABEL_CONTAINER

See Also:

Constant Field Values

YE_INSTANT_EDITOR_LABEL_EDITABLE

protected static final java.lang.String YE_INSTANT_EDITOR_LABEL_EDITABLE

See Also:

Constant Field Values

YE_INSTANT_EDITOR_LABEL_READONLY

protected static final java.lang.String YE_INSTANT_EDITOR_LABEL_READONLY

See Also:

Constant Field Values

YE_INSTANT_EDITOR_EDITOR_CONTAINER

protected static final java.lang.String YE_INSTANT_EDITOR_EDITOR_CONTAINER

See Also:

Constant Field Values

YE_INSTANT_EDITOR_BUTTONS_CONTAINER

protected static final java.lang.String YE_INSTANT_EDITOR_BUTTONS_CONTAINER

See Also:

Constant Field Values

YE_INSTANT_EDITOR_BUTTON_CANCEL

protected static final java.lang.String YE_INSTANT_EDITOR_BUTTON_CANCEL

See Also:

Constant Field Values

YE_INSTANT_EDITOR_BUTTON_CONFIRM

protected static final java.lang.String YE_INSTANT_EDITOR_BUTTON_CONFIRM

See Also:

Constant Field Values

YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_CONTAINER

protected static final java.lang.String YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_CONTAINER

See Also:

Constant Field Values

YE_INSTANT_EDITOR_ATTRIBUTE_LABEL

protected static final java.lang.String YE_INSTANT_EDITOR_ATTRIBUTE_LABEL

See Also:

Constant Field Values

YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_MANDATORY

protected static final java.lang.String YE_INSTANT_EDITOR_ATTRIBUTE_LABEL_MANDATORY

See Also:

Constant Field Values

ICONSCLASS_CANCEL_BUTTON

protected static final java.lang.String ICONSCLASS_CANCEL_BUTTON

See Also:

Constant Field Values

ICONSCLASS_CONFIRM_BUTTON

protected static final java.lang.String ICONSCLASS_CONFIRM_BUTTON

See Also:

Constant Field Values

Constructor Detail

InstantEditorRenderer

public InstantEditorRenderer()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<java.lang.Object> context,
                   EditorListener<java.lang.Object> listener)

Description copied from interface: CockpitEditorRenderer

Creates a new editor component and attaches it to the specified Component component.

Parameters:

parent - parent component the editor should be attached to

context - the context for the editor creation

listener - the listener to notify the rest of the world about value changes and other events

createNestedEditor

protected Editor createNestedEditor(EditorContext<java.lang.Object> context,
                                    EditorListener<java.lang.Object> listener)

getEditorTypeFromContext

@Deprecated(since="6.6",
            forRemoval=true)
protected java.lang.String getEditorTypeFromContext(EditorContext<java.lang.Object> context)

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

since 6.6

See Also:

AbstractEditorRendererWrapper.getEditorTypeFromContext(EditorContext, int)

createChangedValueSuppressingEditorListenerProxy

protected EditorListener<java.lang.Object> createChangedValueSuppressingEditorListenerProxy(EditorListener<java.lang.Object> listener)

resolveLabelRenderer

protected CockpitEditorRenderer<java.lang.Object> resolveLabelRenderer(EditorContext<java.lang.Object> context)

resolveLabelProvider

@Deprecated(since="6.6",
            forRemoval=true)
protected java.util.Optional<InstantEditorLabelProvider> resolveLabelProvider(java.lang.String editorType,
                                                                              java.lang.String labelProviderBeanId)

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

since 6.6

See Also:

DefaultInstantEditorLabelRenderer.resolveLabelProvider(List, String, String)

createNoLabelProviderFoundException

@Deprecated(since="6.6",
            forRemoval=true)
protected java.lang.IllegalStateException createNoLabelProviderFoundException(Editor editor,
                                                                              java.lang.String labelProviderBeanId)

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

since 6.6

See Also:

DefaultInstantEditorLabelRenderer.resolveLabelProvider(List, String, String)

createValueLabel

protected org.zkoss.zk.ui.HtmlBasedComponent createValueLabel(EditorContext<java.lang.Object> context,
                                                              EditorListener<java.lang.Object> listener,
                                                              CockpitEditorRenderer<java.lang.Object> labelRenderer)

updateValueLabel

protected void updateValueLabel(org.zkoss.zk.ui.HtmlBasedComponent labelContainer,
                                EditorContext<java.lang.Object> context,
                                EditorListener<java.lang.Object> listener,
                                java.lang.Object value,
                                CockpitEditorRenderer<java.lang.Object> labelRenderer)

updateValueLabel

@Deprecated(since="6.6",
            forRemoval=true)
protected void updateValueLabel(org.zkoss.zul.Label label,
                                Editor editor,
                                InstantEditorLabelProvider labelProvider)

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

since 6.6

See Also:

updateValueLabel(HtmlBasedComponent, EditorContext, EditorListener, Object, CockpitEditorRenderer)

createEditorContainer

protected org.zkoss.zul.Div createEditorContainer(Editor editor,
                                                  EditorListener<java.lang.Object> listener,
                                                  org.zkoss.zk.ui.HtmlBasedComponent label,
                                                  Executable labelUpdate)

createEditorContainer

@Deprecated(since="6.6",
            forRemoval=true)
protected org.zkoss.zul.Div createEditorContainer(Editor editor,
                                                  EditorListener<java.lang.Object> listener,
                                                  org.zkoss.zul.Label label,
                                                  InstantEditorLabelProvider labelProvider)

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

since 6.6

See Also:

AbstractEditorRendererWrapper.createEditor(EditorContext, EditorListener, String, String), DefaultInstantEditorLabelRenderer

createEditorButtons

protected org.zkoss.zul.Div createEditorButtons(org.zkoss.zul.Div editorContainer,
                                                Editor editor,
                                                EditorListener<java.lang.Object> listener,
                                                org.zkoss.zk.ui.HtmlBasedComponent label,
                                                Executable labelUpdate)

createEditorButtons

@Deprecated(since="6.6",
            forRemoval=true)
protected org.zkoss.zul.Div createEditorButtons(org.zkoss.zul.Div editorContainer,
                                                Editor editor,
                                                EditorListener<java.lang.Object> listener,
                                                org.zkoss.zul.Label label,
                                                InstantEditorLabelProvider labelProvider)

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

since 6.6

See Also:

createEditorButtons(Div, Editor, EditorListener, HtmlBasedComponent, Executable), DefaultInstantEditorLabelRenderer

createButton

protected org.zkoss.zul.Button createButton(java.lang.String sclass,
                                            java.lang.String iconSclass,
                                            org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.MouseEvent> onClickListener)

createAttributeLabel

protected org.zkoss.zul.Div createAttributeLabel(EditorContext<?> context)

getInstantEditorLabelProviders

@Deprecated(since="6.6",
            forRemoval=true)
protected java.util.List<InstantEditorLabelProvider> getInstantEditorLabelProviders()

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

since 6.6

See Also:

DefaultInstantEditorLabelRenderer.getInstantEditorLabelProviders()

setInstantEditorLabelProviders

@Deprecated(since="6.6",
            forRemoval=true)
public void setInstantEditorLabelProviders(java.util.List<InstantEditorLabelProvider> instantEditorLabelProviders)

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

since 6.6

See Also:

DefaultInstantEditorLabelRenderer.setInstantEditorLabelProviders(List)