Class CockpitEditorContainer
- java.lang.Object
-
- org.zkoss.zk.ui.AbstractComponent
-
- org.zkoss.zk.ui.HtmlBasedComponent
-
- org.zkoss.zul.impl.XulElement
-
- org.zkoss.zul.Div
-
- de.hybris.platform.cockpit.components.editor.CockpitEditorContainer
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,org.zkoss.zk.ui.Component,org.zkoss.zk.ui.ext.Scope,org.zkoss.zk.ui.sys.ComponentCtrl
public class CockpitEditorContainer extends org.zkoss.zul.DivZK-Component class which allows to include cockpit editors into zul-files.
Example:
<div id="pageEditor" visible="false" action="onshow:anima.appear(#{self});" style="margin: 30px;" >
<div use="de.hybris.platform.cockpit.components.editor.CockpitEditorContainer" valueTypeCode="AbstractPage" editorCode="single"
onValueChange='setAttr("restrictedItem",self.getEditorValue())'>
<custom-attributes allowCreate="false"/>
</div>
</div>
The following attributes can be set:
- propertyQualifier: You can specify a property qualifier, e.g. "Item.pk". The editor will be set correctly according to the editor factory
- valueContainer: If you specify a value container, the changes within the editor will be stored there. If you don't set this attribute, a value container will be created internally.
- editorCode: You can set a particular editor code (like in editorArea UI component configuration)
- valueTypeCode: If you want to select or create an item without regard to an attribute, just set this property to an existing ComposedType code and don't set the propertyQualifier and valueContainer attributes
- onValueChange: Add your event callback EL here
the custom-attributes tag is used similar to the parameter tag in editorArea UI component configuration, i.e. all attributes are added to the parameters map passed toUIEditor.createViewComponent(Object, Map, EditorListener)- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CockpitEditorContainer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected EditorListenercreateEditorListener(PropertyDescriptor propertyDescriptor)java.lang.StringgetEditorCode()java.lang.ObjectgetEditorValue()protected java.lang.ObjectgetLocalizedValueIfMap(java.lang.Object value, java.lang.String isoCode)java.lang.StringgetPropertyQualifier()ObjectValueContainergetValueContainer()java.lang.StringgetValueTypeCode()voidinitialize()Initializes all property.booleanisLocalized()voidsetEditorCode(java.lang.String editorCode)voidsetEditorValue(java.lang.Object editorValue)protected voidsetEditorValue(java.lang.Object value, java.lang.String langIso)voidsetLocalized(boolean localized)voidsetPropertyQualifier(java.lang.String propertyQualifier)voidsetValueContainer(ObjectValueContainer valueContainer)voidsetValueTypeCode(java.lang.String valueTypeCode)voidupdate()-
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
focus, 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
-
-
-
-
Method Detail
-
update
public void update()
-
initialize
public void initialize()
Initializes all property. Is called in an "onCreate" event listener which is attached internally. If someone wants to add his custom "onCreate" listener, he must also call this method.
-
getLocalizedValueIfMap
protected java.lang.Object getLocalizedValueIfMap(java.lang.Object value, java.lang.String isoCode)
-
createEditorListener
protected EditorListener createEditorListener(PropertyDescriptor propertyDescriptor)
-
setValueContainer
public void setValueContainer(ObjectValueContainer valueContainer)
-
getValueContainer
public ObjectValueContainer getValueContainer()
-
setPropertyQualifier
public void setPropertyQualifier(java.lang.String propertyQualifier)
-
getPropertyQualifier
public java.lang.String getPropertyQualifier()
-
setEditorCode
public void setEditorCode(java.lang.String editorCode)
-
getEditorCode
public java.lang.String getEditorCode()
-
setEditorValue
public void setEditorValue(java.lang.Object editorValue)
-
getEditorValue
public java.lang.Object getEditorValue()
- Returns:
- the last value set by the cockpit editor
-
setEditorValue
protected void setEditorValue(java.lang.Object value, java.lang.String langIso)
-
setValueTypeCode
public void setValueTypeCode(java.lang.String valueTypeCode)
-
getValueTypeCode
public java.lang.String getValueTypeCode()
-
setLocalized
public void setLocalized(boolean localized)
-
isLocalized
public boolean isLocalized()
-
-