Class AbstractSectionMainAreaBrowserComponent
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.contentbrowser.AbstractBrowserComponent
de.hybris.platform.cockpit.components.contentbrowser.AbstractMainAreaBrowserComponent
de.hybris.platform.cockpit.components.contentbrowser.AbstractSectionMainAreaBrowserComponent
- All Implemented Interfaces:
BrowserComponent,CockpitComponent,DesktopRemovalAwareComponent,Serializable,Cloneable,org.zkoss.zk.ui.api.HtmlBasedComponent,org.zkoss.zk.ui.Component,org.zkoss.zk.ui.ext.Scope,org.zkoss.zk.ui.sys.ComponentCtrl,org.zkoss.zul.api.Div,org.zkoss.zul.impl.api.XulElement
- Direct Known Subclasses:
DefaultSectionMainAreaBrowserComponent
public abstract class AbstractSectionMainAreaBrowserComponent
extends AbstractMainAreaBrowserComponent
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrlNested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.AbstractComponent.Children -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanprotected org.zkoss.zkex.zul.Borderlayoutprotected Map<BrowserSectionModel,BrowserComponent> Fields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractMainAreaBrowserComponent
EMPTY_MESSAGE, lastResultType, listComponentModel, loginService, resultModel, typeService, uiConfigurationServiceFields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
ADV_QUERY_BTN_ACTIVE_IMG, ADV_QUERY_BTN_IMG, BROWSER_TOOLBAR_SCLASS, CLOSE_BTN_IMG, CONTENT_BROWSER_GB_SCLASS, CONTENT_BROWSER_STICKY_GB_SCLASS, DUPLICATE_BTN_IMG, MAIN_AREA_BL_SCLASS, MINIMIZE_BTN_IMG, SAVE_QUERY_BTN_IMG, SEARCH_MAGNIFIER_BTN_IMG, SPLIT_ACTIVE_BTN_IMG, SPLIT_INACTIVE_BTN_IMGFields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_zclassFields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPEFields 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
ConstructorsConstructorDescriptionAbstractSectionMainAreaBrowserComponent(SectionBrowserModel model, AbstractContentBrowser contentBrowser) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcleanup()protected org.zkoss.zkex.zul.Borderlayoutprotected Map<BrowserSectionModel,BrowserComponent> voiddesktopRemoved(org.zkoss.zk.ui.Desktop desktop) voiddetach()getModel()protected SectionModelListenerbooleanInitializes this browser component i.e.protected booleanprotected abstract voidlayoutSections(List<BrowserSectionModel> sectionModels, org.zkoss.zk.ui.HtmlBasedComponent parent) Responsible for laying out the different sections.voidresize()Notifies this browser component that it should resize itself if possible, since the view state might require it.voidsetActiveItem(TypedObject activeItem) Sets the active item of this browser component toactiveItem.voidsetParent(org.zkoss.zk.ui.Component parent) voidsetSectionModelListener(SectionModelListener sectionModelListener) Sets the section model listener to be used by this view component in order to keep its state up to date.booleanupdate()Updates this browser component i.e.voidRe-renders the currently active item(s).voidupdateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties) Re-renders the item.voidupdateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties, Object reason) Override if you want to react on the reason for the updatevoidupdateSection(BrowserSectionModel sectionModel) voidupdateSectionSelection(BrowserSectionModel sectionModel) Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractMainAreaBrowserComponent
createMainArea, createTableController, getCurrentItemView, getLoginService, getResultModel, getRootType, getTableModel, getTypeService, getUIConfigurationService, loadListModel, resetSelection, setTableModel, updateResult, updateSelectedItemsMethods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
getContentBrowser, setModelMethods inherited from class org.zkoss.zul.Div
getAlign, renderProperties, setAlignMethods inherited from class org.zkoss.zul.impl.XulElement
clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributesMethods 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, setZIndexDirectlyMethods 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, 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, 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, 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, willSerializeMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverrideMethods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
invalidatePartialMethods inherited from interface org.zkoss.zul.api.Div
getAlign, setAlignMethods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndexMethods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttributeMethods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
-
Field Details
-
sectionMap
-
mainArea
protected transient org.zkoss.zkex.zul.Borderlayout mainArea -
initialized
protected boolean initialized
-
-
Constructor Details
-
AbstractSectionMainAreaBrowserComponent
public AbstractSectionMainAreaBrowserComponent(SectionBrowserModel model, AbstractContentBrowser contentBrowser)
-
-
Method Details
-
initialize
public boolean initialize()Description copied from class:AbstractBrowserComponentInitializes this browser component i.e. creates all required components, adds event listeners etc. Implementation note: Remember to set theinitializedflag totrueafter this method has been called. Note: This method is automatically called when a model or browser controller is set.- Specified by:
initializein interfaceCockpitComponent- Overrides:
initializein classAbstractMainAreaBrowserComponent- Returns:
trueif initialization was successful,falseotherwise- See Also:
-
createMainBorderLayout
protected org.zkoss.zkex.zul.Borderlayout createMainBorderLayout() -
layoutSections
protected abstract void layoutSections(List<BrowserSectionModel> sectionModels, org.zkoss.zk.ui.HtmlBasedComponent parent) Responsible for laying out the different sections.- Parameters:
sectionModels- the sections to be renderedparent- the parent component to which the sections should be added
-
update
public boolean update()Description copied from class:AbstractBrowserComponentUpdates this browser component i.e. synchronizes its view width the underlying model.- Specified by:
updatein interfaceCockpitComponent- Specified by:
updatein classAbstractBrowserComponent- Returns:
trueif this browser was successfully updated,falseotherwise
-
getModel
- Specified by:
getModelin interfaceBrowserComponent- Overrides:
getModelin classAbstractMainAreaBrowserComponent
-
updateItem
Description copied from class:AbstractBrowserComponentOverride if you want to react on the reason for the update- Overrides:
updateItemin classAbstractBrowserComponentreason- the reason for the update
-
updateItem
Description copied from class:AbstractBrowserComponentRe-renders the item.- Specified by:
updateItemin interfaceCockpitComponent- Overrides:
updateItemin classAbstractMainAreaBrowserComponent- Parameters:
item- the item to be re-renderedmodifiedProperties- modified properties
-
updateSection
-
updateSectionSelection
-
resize
public void resize()Description copied from class:AbstractBrowserComponentNotifies this browser component that it should resize itself if possible, since the view state might require it. This is typically only necessary for ZK'sBorderlayoutcomponents.- Overrides:
resizein classAbstractMainAreaBrowserComponent
-
setActiveItem
Description copied from class:AbstractBrowserComponentSets the active item of this browser component toactiveItem.- Specified by:
setActiveItemin interfaceCockpitComponent- Overrides:
setActiveItemin classAbstractMainAreaBrowserComponent- Parameters:
activeItem- the new active item
-
updateActiveItems
public void updateActiveItems()Description copied from class:AbstractBrowserComponentRe-renders the currently active item(s).- Specified by:
updateActiveItemsin interfaceCockpitComponent- Overrides:
updateActiveItemsin classAbstractMainAreaBrowserComponent
-
createSections
-
setSectionModelListener
Sets the section model listener to be used by this view component in order to keep its state up to date. Note: This listener should be used internally for updating this view components state when the underlying model changes.- Parameters:
sectionModelListener-
-
getSectionModelListener
-
isInitialized
protected boolean isInitialized()- Overrides:
isInitializedin classorg.zkoss.zk.ui.AbstractComponent
-
setParent
public void setParent(org.zkoss.zk.ui.Component parent) - Specified by:
setParentin interfaceorg.zkoss.zk.ui.Component- Overrides:
setParentin classAbstractMainAreaBrowserComponent
-
detach
public void detach()- Specified by:
detachin interfaceorg.zkoss.zk.ui.Component- Overrides:
detachin classAbstractMainAreaBrowserComponent
-
desktopRemoved
public void desktopRemoved(org.zkoss.zk.ui.Desktop desktop) - Specified by:
desktopRemovedin interfaceDesktopRemovalAwareComponent- Overrides:
desktopRemovedin classAbstractMainAreaBrowserComponent
-
cleanup
protected void cleanup()- Specified by:
cleanupin classAbstractMainAreaBrowserComponent
-