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:
Serializable, 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.Div
ZK-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 to UIEditor.createViewComponent(Object, Map, EditorListener)
    See Also:
    • Nested Class Summary

      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 inherited from class org.zkoss.zk.ui.HtmlBasedComponent

      _zclass

      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

      AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
    • Constructor Summary

      Constructors
      Constructor
      Description
       
    • Method Summary

      Modifier and Type
      Method
      Description
      protected EditorListener
       
       
       
      protected Object
       
       
       
       
      void
      Initializes all property.
      boolean
       
      void
      setEditorCode(String editorCode)
       
      void
      setEditorValue(Object editorValue)
       
      protected void
      setEditorValue(Object value, String langIso)
       
      void
      setLocalized(boolean localized)
       
      void
      setPropertyQualifier(String propertyQualifier)
       
      void
       
      void
      setValueTypeCode(String valueTypeCode)
       
      void
       

      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

      addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, 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, 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, invalidatePartial, isChildable, isInitialized, 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

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

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

      invalidatePartial
    • Constructor Details

      • CockpitEditorContainer

        public CockpitEditorContainer()
    • Method Details

      • 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 Object getLocalizedValueIfMap(Object value, String isoCode)
      • createEditorListener

        protected EditorListener createEditorListener(PropertyDescriptor propertyDescriptor)
      • setValueContainer

        public void setValueContainer(ObjectValueContainer valueContainer)
      • getValueContainer

        public ObjectValueContainer getValueContainer()
      • setPropertyQualifier

        public void setPropertyQualifier(String propertyQualifier)
      • getPropertyQualifier

        public String getPropertyQualifier()
      • setEditorCode

        public void setEditorCode(String editorCode)
      • getEditorCode

        public String getEditorCode()
      • setEditorValue

        public void setEditorValue(Object editorValue)
      • getEditorValue

        public Object getEditorValue()
        Returns:
        the last value set by the cockpit editor
      • setEditorValue

        protected void setEditorValue(Object value, String langIso)
      • setValueTypeCode

        public void setValueTypeCode(String valueTypeCode)
      • getValueTypeCode

        public String getValueTypeCode()
      • setLocalized

        public void setLocalized(boolean localized)
      • isLocalized

        public boolean isLocalized()