com.hybris.cockpitng.components

Class Editor

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Div

com.hybris.cockpitng.components.AbstractCockpitComponent

com.hybris.cockpitng.components.Editor

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.AfterCompose, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl

public class Editor
extends AbstractCockpitComponent
implements org.zkoss.zk.ui.ext.AfterCompose, org.zkoss.zk.ui.IdSpace

Cockpit NG editor component. Holds an instance of a cockpit NG editor. It uses the EditorRegistry to look up the editor for the specified type. If the property attribute is specified it connects the editor with the widget model's property of that name and loads an stores the value automatically.

See Also:

EditorRegistry, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Editor.CockpitEditorRendererFactory

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COCKPIT_EDITOR_CLASS_INSTANCE_PARAM
protected static String	CURRENT_OBJECT
static String	DATA_TYPE
static String	DEFAULT_FOCUS_COMPONENT_ID
static String	EDITOR_INSTANCE_REFERENCE
static String	EDITOR_PROPERTY
static String	MODEL_PREFIX
static String	ON_EDITOR_EVENT
static String	ON_VALUE_CHANGED
static String	PARENT_OBJECT
static String	VALIDATION_RESULT_KEY
static String	VALUE_EDITOR
static String	WIDGET_INSTANCE_MANAGER
protected static String	YW_LOCEDITOR_CAPTION_SPACER

Fields inherited from class com.hybris.cockpitng.components.AbstractCockpitComponent

COCKPIT_COMPONENTS_ATTIBUTE, initialized, modelObserver, widgetInstanceManager

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from class org.zkoss.zk.ui.AbstractComponent

AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Editor()
Editor(EditorContext<?> editorContext)

Method Summary

Modifier and Type	Method and Description
void	addParameter(String key, Object val)
void	addParameters(Map<String,Object> parameters)
void	afterCompose()
protected void	applyCssStyleForEditor(org.zkoss.zk.ui.Component viewComponent)
protected void	buildEditor(CockpitEditorRenderer<Object> editorRenderer, EditorDefinition editorDefinition, EditorContext<Object> editorContext)
void	clearInitialValue() Clears editor's initial value.
protected boolean	containsLocalization(String code) Deprecated. since 6.4
protected EditorListener<Object>	createEditorListener(EditorContext<Object> ctx)
void	destroy()
void	editorValidationChanged()
void	focus()
String	getComponentID()
ComponentWidgetAdapter	getComponentWidgetAdapter()
String	getDefaultEditor()
org.zkoss.zk.ui.Component	getDefaultFocusComponent()
protected EditorDefinition	getEditorDefinition()
String	getEditorLabel()
CockpitEditorRenderer	getEditorRenderer()
LabelService	getLabelService()
protected ModelObserver	getModelObserver()
Map<String,Object>	getParameters()
Map<String,Object>	getParametersParsed() Safer version of getParameters().
String	getProperty() Editors may be used to manipulate with values of particular attributes.
Set<Locale>	getReadableLocales()
String	getRelatedProperty() Editors may be used to manipulate with values of particular attributes.
String	getSuccessNotificationId()
String	getType()
Object	getValue()
List<ComponentWidgetAdapterAware>	getWidgetAdaptersAwareIfPresent()
WidgetInstanceManager	getWidgetInstanceManager()
Set<Locale>	getWritableLocales()
protected boolean	handlesLocalization()
void	initialize()
void	initValidation(ValidatableContainer validatableContainer, ValidationHandler handler)
boolean	isAtomic()
boolean	isLocalized() Deprecated. since 6.6
boolean	isNestedObjectCreationDisabled()
boolean	isOptional() This field can be provided via ZUL view.
boolean	isOrdered()
boolean	isPartOf()
boolean	isPrimitive()
boolean	isReadOnly()
protected boolean	isValueChanged(Object currentValue, Object changedValue)
protected void	notifyChange(Object changedValue)
protected CockpitEditorRenderer	prepareEditorRenderer(EditorDefinition definition, String tag)
void	reload()
void	removeParameter(String key)
protected void	renderEditor(CockpitEditorRenderer<Object> editorRenderer, EditorDefinition editorDefinition, EditorContext<Object> editorContext)
void	setAtomic(boolean atomic)
void	setDefaultEditor(String defaultEditor)
void	setEditorLabel(String editorLabel)
void	setInitialValue(Object value) Sets editor's initial value.
void	setLocalized(boolean localized) Deprecated. since 6.6
void	setNestedObjectCreationDisabled(boolean nestedObjectCreationDisabled)
void	setOptional(boolean optional) This field can be provided via ZUL view.
void	setOrdered(boolean ordered)
void	setParameters(Map<String,Object> parameters)
void	setPartOf(boolean partOf)
void	setPrimitive(boolean primitive)
void	setProperty(String property)
void	setReadableLocales(Set<Locale> readableLocales)
void	setReadOnly(boolean readOnly)
void	setSuccessNotificationId(String successNotificationId)
void	setType(String type)
void	setValidatableContainer(ValidatableContainer validatableContainer)
void	setValue(Object value)
void	setWritableLocales(Set<Locale> writableLocales)
protected boolean	shouldReloadEditorOnCurrentObjectChange(String property)
protected void	verifyLocalizedEditor()

Methods inherited from class com.hybris.cockpitng.components.AbstractCockpitComponent

getComponentDefinitionService, initializeComponentWidgetAdapter, isInitialized, setComponentDefinitionService, setWidgetInstanceManager, unregisterObserver, unregisterWidgetStubInstance

Methods inherited from class org.zkoss.zul.Div

getAlign, renderProperties, setAlign

Methods inherited from class org.zkoss.zul.impl.XulElement

clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.IdSpace

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeScopeListener, setAttribute, setAttribute

Field Detail

DATA_TYPE

public static final String DATA_TYPE

See Also:

Constant Field Values

MODEL_PREFIX

public static final String MODEL_PREFIX

See Also:

Constant Field Values

EDITOR_PROPERTY

public static final String EDITOR_PROPERTY

See Also:

Constant Field Values

ON_VALUE_CHANGED

public static final String ON_VALUE_CHANGED

See Also:

Constant Field Values

ON_EDITOR_EVENT

public static final String ON_EDITOR_EVENT

See Also:

Constant Field Values

DEFAULT_FOCUS_COMPONENT_ID

public static final String DEFAULT_FOCUS_COMPONENT_ID

See Also:

Constant Field Values

VALUE_EDITOR

public static final String VALUE_EDITOR

See Also:

Constant Field Values

WIDGET_INSTANCE_MANAGER

public static final String WIDGET_INSTANCE_MANAGER

See Also:

Constant Field Values

EDITOR_INSTANCE_REFERENCE

public static final String EDITOR_INSTANCE_REFERENCE

See Also:

Constant Field Values

VALIDATION_RESULT_KEY

public static final String VALIDATION_RESULT_KEY

See Also:

Constant Field Values

PARENT_OBJECT

public static final String PARENT_OBJECT

See Also:

Constant Field Values

YW_LOCEDITOR_CAPTION_SPACER

protected static final String YW_LOCEDITOR_CAPTION_SPACER

See Also:

Constant Field Values

COCKPIT_EDITOR_CLASS_INSTANCE_PARAM

protected static final String COCKPIT_EDITOR_CLASS_INSTANCE_PARAM

See Also:

Constant Field Values

CURRENT_OBJECT

protected static final String CURRENT_OBJECT

See Also:

Constant Field Values

Constructor Detail

Editor

public Editor()

Editor

public Editor(EditorContext<?> editorContext)

Method Detail

reload

public void reload()

afterCompose

public void afterCompose()

Specified by:

afterCompose in interface org.zkoss.zk.ui.ext.AfterCompose

initialize

public void initialize()

verifyLocalizedEditor

protected void verifyLocalizedEditor()

containsLocalization

@Deprecated
protected boolean containsLocalization(String code)

Deprecated. since 6.4

See Also:

EditorDefinition.getHandlesLocalization(), handlesLocalization()

handlesLocalization

protected boolean handlesLocalization()

getEditorRenderer

public CockpitEditorRenderer getEditorRenderer()

prepareEditorRenderer

protected CockpitEditorRenderer prepareEditorRenderer(EditorDefinition definition,
                                                      String tag)

getEditorDefinition

protected EditorDefinition getEditorDefinition()

buildEditor

protected void buildEditor(CockpitEditorRenderer<Object> editorRenderer,
                           EditorDefinition editorDefinition,
                           EditorContext<Object> editorContext)

getModelObserver

protected ModelObserver getModelObserver()

shouldReloadEditorOnCurrentObjectChange

protected boolean shouldReloadEditorOnCurrentObjectChange(String property)

renderEditor

protected void renderEditor(CockpitEditorRenderer<Object> editorRenderer,
                            EditorDefinition editorDefinition,
                            EditorContext<Object> editorContext)

getWidgetInstanceManager

public WidgetInstanceManager getWidgetInstanceManager()

Overrides:

getWidgetInstanceManager in class AbstractCockpitComponent

applyCssStyleForEditor

protected void applyCssStyleForEditor(org.zkoss.zk.ui.Component viewComponent)

createEditorListener

protected EditorListener<Object> createEditorListener(EditorContext<Object> ctx)

isValueChanged

protected boolean isValueChanged(Object currentValue,
                                 Object changedValue)

notifyChange

protected void notifyChange(Object changedValue)

getProperty

public String getProperty()

Editors may be used to manipulate with values of particular attributes. Then they are able to provide information about, what exact attribute is being manipulated by them. In some cases editors are used to manipulate some subvalue of an attribute (i.e. an editor of a value for a specified localization in localized attribute). Then getProperty() would return null, but getRelatedProperty() would still return name of a property which subvalue is being manipulated by this editor.

Returns:

exact name of a property related to current editor or null if editor is not bound to any property or manipulates a subvalue of property

See Also:

getRelatedProperty()

setProperty

public void setProperty(String property)

getRelatedProperty

public String getRelatedProperty()

Editors may be used to manipulate with values of particular attributes. Then they are able to provide information about, what exact attribute is being manipulated by them. In some cases editors are used to manipulate some subvalue of an attribute (i.e. an editor of a value for a specified localization in localized attribute). Then getProperty() would return null, but getRelatedProperty() would still return name of a property which subvalue is being manipulated by this editor.

Returns:

name of a property related to current editor (even if editor manipulates it's subvalue) or null if editor is not bound to any property

See Also:

getProperty()

getDefaultEditor

public String getDefaultEditor()

setDefaultEditor

public void setDefaultEditor(String defaultEditor)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

isNestedObjectCreationDisabled

public boolean isNestedObjectCreationDisabled()

setNestedObjectCreationDisabled

public void setNestedObjectCreationDisabled(boolean nestedObjectCreationDisabled)

getSuccessNotificationId

public String getSuccessNotificationId()

setSuccessNotificationId

public void setSuccessNotificationId(String successNotificationId)

isOptional

public boolean isOptional()

This field can be provided via ZUL view.

Returns:

value of editor's corresponding attribute provided in the ZUL view.

setOptional

public void setOptional(boolean optional)

This field can be provided via ZUL view.

Parameters:

optional - value of editor's corresponding attribute

getType

public String getType()

setType

public void setType(String type)

getValue

public Object getValue()

setValue

public void setValue(Object value)

setInitialValue

public void setInitialValue(Object value)

Sets editor's initial value. The difference from setValue(Object) is that if editor has property set getProperty() the value will be used as initial value and property accessor won't be called to obtain it during initialization.

clearInitialValue

public void clearInitialValue()

Clears editor's initial value. If editor has property set getProperty() the initial value will be obtained using property accessor during initialization.

getEditorLabel

public String getEditorLabel()

setEditorLabel

public void setEditorLabel(String editorLabel)

focus

public void focus()

Overrides:

focus in class org.zkoss.zk.ui.HtmlBasedComponent

getDefaultFocusComponent

public org.zkoss.zk.ui.Component getDefaultFocusComponent()

getLabelService

public LabelService getLabelService()

Returns:

the labelService

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

getParametersParsed

public Map<String,Object> getParametersParsed()

Safer version of getParameters(). If a parameter is an editor setting defined in definition.xml, then it tries to parse it into the appropriate setting type, if possible.

addParameter

public void addParameter(String key,
                         Object val)

addParameters

public void addParameters(Map<String,Object> parameters)

removeParameter

public void removeParameter(String key)

getComponentWidgetAdapter

public ComponentWidgetAdapter getComponentWidgetAdapter()

Overrides:

getComponentWidgetAdapter in class AbstractCockpitComponent

getComponentID

public String getComponentID()

Specified by:

getComponentID in class AbstractCockpitComponent

getWidgetAdaptersAwareIfPresent

public List<ComponentWidgetAdapterAware> getWidgetAdaptersAwareIfPresent()

Specified by:

getWidgetAdaptersAwareIfPresent in class AbstractCockpitComponent

getReadableLocales

public Set<Locale> getReadableLocales()

setReadableLocales

public void setReadableLocales(Set<Locale> readableLocales)

getWritableLocales

public Set<Locale> getWritableLocales()

setWritableLocales

public void setWritableLocales(Set<Locale> writableLocales)

isLocalized

@Deprecated
public boolean isLocalized()

Deprecated. since 6.6

Returns:

the localized

setLocalized

@Deprecated
public void setLocalized(boolean localized)

Deprecated. since 6.6

Parameters:

localized - the localized to set

isOrdered

public boolean isOrdered()

setOrdered

public void setOrdered(boolean ordered)

isPartOf

public boolean isPartOf()

setPartOf

public void setPartOf(boolean partOf)

isPrimitive

public boolean isPrimitive()

setPrimitive

public void setPrimitive(boolean primitive)

initValidation

public void initValidation(ValidatableContainer validatableContainer,
                           ValidationHandler handler)

editorValidationChanged

public void editorValidationChanged()

setValidatableContainer

public void setValidatableContainer(ValidatableContainer validatableContainer)

destroy

public void destroy()

Overrides:

destroy in class AbstractCockpitComponent

isAtomic

public boolean isAtomic()

setAtomic

public void setAtomic(boolean atomic)