Package com.hybris.cockpitng.editor.defaultmap

Class DefaultMapEditorRenderer<K,V>

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<T>

com.hybris.cockpitng.editors.impl.AbstractPaginableEditorRenderer<java.util.Map<K,V>>

com.hybris.cockpitng.editor.defaultmap.DefaultMapEditorRenderer<K,V>

All Implemented Interfaces:

CockpitEditorRenderer<java.util.Map<K,V>>

public class DefaultMapEditorRenderer<K,V>
extends AbstractPaginableEditorRenderer<java.util.Map<K,V>>

Default renderer for map editors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DefaultMapEditorRenderer.InlineEditorMode
protected class	DefaultMapEditorRenderer.MapEditorListitemRenderer

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	CLEAR_EDITOR_IMG
protected org.zkoss.zul.Listbox	editorView
protected static java.lang.String	KEY_VALUE_SEPARATOR_IMG
protected static java.lang.String	MODE_CTX_PARAM
protected static java.lang.String	SAVE_EDITOR_IMG

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

CONFIRM_DELETE_PARAM, ITEM_INDEX_TO_CUT, LAST_EDITED_INDEX, LAST_EDITED_VALUE, NULL, ON_EDIT_EVENT, ON_INIT_EVENT, ON_UPDATE_EVENT, TRUE, YE_LIST_CONTAINER, YE_LIST_CONTENT, YE_LIST_INLINE, YE_LIST_INLINE_CANCEL, YE_LIST_INLINE_EDITOR, YE_LIST_INLINE_SAVE, YE_LIST_LINE_EDITOR, YE_LIST_LISTBOX, YE_LIST_TITLEBAR, YE_LIST_TITLEBAR_LABEL, YE_LIST_TITLEBAR_SPAN, YE_LIST_TITLEBAR_VALUE, YE_LIST_TOOLBAR, YE_LIST_TOOLBAR_ADDPOPUP, YE_LIST_TOOLBAR_ADDPOPUP_CHECKBOX, YE_LIST_TOOLBAR_BUTTON_EDIT, YE_LIST_Y_BTB_PRIMARY

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
DefaultMapEditorRenderer()

Method Summary

Modifier and Type	Method	Description
protected org.zkoss.zul.Popup	createAddPopup(org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener, EditorContext<java.util.Map<K,V>> context)
protected org.zkoss.zul.Listfooter	createFooter(EditorListener<java.util.Map<K,V>> listener, EditorContext<java.util.Map<K,V>> context)
protected org.zkoss.zul.Div	createFooterContent(EditorContext<java.util.Map<K,V>> context, EditorListener<java.util.Map<K,V>> listener, org.zkoss.zul.Listfooter footer)
protected org.zkoss.zul.Div	createInlineEditor(EditorContext<java.util.Map<K,V>> context, EditorListener<java.util.Map<K,V>> listener, org.zkoss.zul.Listitem listItem, java.util.Map.Entry<K,V> data)	Creates inline editor for list item.
protected org.zkoss.zul.ListitemRenderer<java.util.Map.Entry<K,V>>	createItemRenderer(EditorContext<java.util.Map<K,V>> context, EditorListener<java.util.Map<K,V>> listener)	Defines ListitemRenderer for the items in the list.
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	createSaveInlineValueListener(K key, Editor inlineEditorKey, Editor inlineEditorValue, EditorListener<java.util.Map<K,V>> listener, EditorContext<java.util.Map<K,V>> context)
protected void	deleteValueAtIndex(int idx, org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener)
protected void	editValue(K key, V value, org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener)
protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>	extractArguments(java.lang.String value)
protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String>	extractDefaultEditors(EditorContext<java.util.Map<K,V>> context)
protected java.lang.String	extractKeyEditorType(EditorContext<java.util.Map<K,V>> context)
protected java.lang.String	extractValueEditorType(EditorContext<java.util.Map<K,V>> context)
protected java.util.Map<K,V>	getCurrentContent(org.zkoss.zul.Listbox listbox)
protected int	getEditorTypeSeparatorPosition(java.lang.String value)
protected java.lang.String	getFooterContentImage()
protected org.zkoss.zk.ui.HtmlBasedComponent	getInlineEditorKeyComponent(java.lang.Object key)
protected LabelService	getLabelService()
protected org.zkoss.zul.ListModel<java.util.Map.Entry<K,V>>	getListModel(org.zkoss.zul.Listbox listbox)
protected java.lang.String	getObjectLabel(java.lang.Object key)
TypeFacade	getTypeFacade()
protected boolean	isCollectionOrMap(java.lang.Object obj)
protected EditorContext<java.util.Map<K,V>>	prepareNestedContext(EditorContext<java.util.Map<K,V>> context, java.lang.String editorType, java.lang.String valueType)
void	render(org.zkoss.zk.ui.Component parent, EditorContext<java.util.Map<K,V>> context, EditorListener<java.util.Map<K,V>> listener)	Creates a new editor component and attaches it to the specified Component component.
protected void	revert(DefaultMapEditorRenderer.InlineEditorMode mode, EditorListener<java.util.Map<K,V>> listener, EditorContext<java.util.Map<K,V>> context)
protected void	revertFooter(EditorContext<java.util.Map<K,V>> context, EditorListener<java.util.Map<K,V>> listener)
protected void	revertValue(org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener)
void	setLabelService(LabelService labelService)
void	setTypeFacade(TypeFacade typeFacade)
protected void	swapValues(org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener, org.zkoss.zul.Listitem swappableListitemYang, org.zkoss.zul.Listitem swappableListitemYing)
protected void	updateCurrentValue(org.zkoss.zul.Listbox listbox, EditorListener<java.util.Map<K,V>> listener, java.util.Map<K,V> newValue)

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

configurePaging, createAddButton, createDeleteButton, createEditor, getPageSize, selectionNotEmpty

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

SAVE_EDITOR_IMG

protected static final java.lang.String SAVE_EDITOR_IMG

See Also:

Constant Field Values

CLEAR_EDITOR_IMG

protected static final java.lang.String CLEAR_EDITOR_IMG

See Also:

Constant Field Values

KEY_VALUE_SEPARATOR_IMG

protected static final java.lang.String KEY_VALUE_SEPARATOR_IMG

See Also:

Constant Field Values

MODE_CTX_PARAM

protected static final java.lang.String MODE_CTX_PARAM

See Also:

Constant Field Values

editorView

protected org.zkoss.zul.Listbox editorView

Constructor Detail

DefaultMapEditorRenderer

public DefaultMapEditorRenderer()

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<java.util.Map<K,V>> context,
                   EditorListener<java.util.Map<K,V>> 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

createFooter

protected org.zkoss.zul.Listfooter createFooter(EditorListener<java.util.Map<K,V>> listener,
                                                EditorContext<java.util.Map<K,V>> context)

createFooterContent

protected org.zkoss.zul.Div createFooterContent(EditorContext<java.util.Map<K,V>> context,
                                                EditorListener<java.util.Map<K,V>> listener,
                                                org.zkoss.zul.Listfooter footer)

getFooterContentImage

protected java.lang.String getFooterContentImage()

swapValues

protected void swapValues(org.zkoss.zul.Listbox listbox,
                          EditorListener<java.util.Map<K,V>> listener,
                          org.zkoss.zul.Listitem swappableListitemYang,
                          org.zkoss.zul.Listitem swappableListitemYing)

createItemRenderer

protected org.zkoss.zul.ListitemRenderer<java.util.Map.Entry<K,V>> createItemRenderer(EditorContext<java.util.Map<K,V>> context,
                                                                                            EditorListener<java.util.Map<K,V>> listener)

Defines ListitemRenderer for the items in the list.

Parameters:

context - defines editor's environment

listener - reacts on editor's events

Returns:

ListitemRenderer

createInlineEditor

protected org.zkoss.zul.Div createInlineEditor(EditorContext<java.util.Map<K,V>> context,
                                               EditorListener<java.util.Map<K,V>> listener,
                                               org.zkoss.zul.Listitem listItem,
                                               java.util.Map.Entry<K,V> data)

Creates inline editor for list item.

Parameters:

context - - editor context

listener - - editor listener

listItem - - list item where the editor should be rendered

data - - initial data for the editor

Returns:

Div with the inline editor

getObjectLabel

protected java.lang.String getObjectLabel(java.lang.Object key)

isCollectionOrMap

protected boolean isCollectionOrMap(@Nullable
                                    java.lang.Object obj)

getInlineEditorKeyComponent

protected org.zkoss.zk.ui.HtmlBasedComponent getInlineEditorKeyComponent(java.lang.Object key)

createSaveInlineValueListener

protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> createSaveInlineValueListener(K key,
                                                                                                         Editor inlineEditorKey,
                                                                                                         Editor inlineEditorValue,
                                                                                                         EditorListener<java.util.Map<K,V>> listener,
                                                                                                         EditorContext<java.util.Map<K,V>> context)

revert

protected void revert(DefaultMapEditorRenderer.InlineEditorMode mode,
                      EditorListener<java.util.Map<K,V>> listener,
                      EditorContext<java.util.Map<K,V>> context)

revertValue

protected void revertValue(org.zkoss.zul.Listbox listbox,
                           EditorListener<java.util.Map<K,V>> listener)

updateCurrentValue

protected void updateCurrentValue(org.zkoss.zul.Listbox listbox,
                                  EditorListener<java.util.Map<K,V>> listener,
                                  java.util.Map<K,V> newValue)

revertFooter

protected void revertFooter(EditorContext<java.util.Map<K,V>> context,
                            EditorListener<java.util.Map<K,V>> listener)

extractKeyEditorType

protected java.lang.String extractKeyEditorType(EditorContext<java.util.Map<K,V>> context)

extractValueEditorType

protected java.lang.String extractValueEditorType(EditorContext<java.util.Map<K,V>> context)

extractArguments

protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> extractArguments(java.lang.String value)

getEditorTypeSeparatorPosition

protected int getEditorTypeSeparatorPosition(java.lang.String value)

createAddPopup

protected org.zkoss.zul.Popup createAddPopup(org.zkoss.zul.Listbox listbox,
                                             EditorListener<java.util.Map<K,V>> listener,
                                             EditorContext<java.util.Map<K,V>> context)

Specified by:

createAddPopup in class AbstractPaginableEditorRenderer<java.util.Map<K,V>>

prepareNestedContext

protected EditorContext<java.util.Map<K,V>> prepareNestedContext(EditorContext<java.util.Map<K,V>> context,
                                                                       java.lang.String editorType,
                                                                       java.lang.String valueType)

extractDefaultEditors

protected org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.String> extractDefaultEditors(EditorContext<java.util.Map<K,V>> context)

editValue

protected void editValue(K key,
                         V value,
                         org.zkoss.zul.Listbox listbox,
                         EditorListener<java.util.Map<K,V>> listener)

deleteValueAtIndex

protected void deleteValueAtIndex(int idx,
                                  org.zkoss.zul.Listbox listbox,
                                  EditorListener<java.util.Map<K,V>> listener)

getListModel

protected org.zkoss.zul.ListModel<java.util.Map.Entry<K,V>> getListModel(org.zkoss.zul.Listbox listbox)

getCurrentContent

protected java.util.Map<K,V> getCurrentContent(org.zkoss.zul.Listbox listbox)

getLabelService

protected LabelService getLabelService()

Returns:

the labelService

setLabelService

public void setLabelService(LabelService labelService)

getTypeFacade

public TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)