Class DefaultAdvancedContentBrowser
- 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.AbstractContentBrowser
-
- de.hybris.platform.cockpit.components.contentbrowser.AbstractContentContextBrowser
-
- de.hybris.platform.cockpit.components.contentbrowser.DefaultAdvancedContentBrowser
-
- All Implemented Interfaces:
DesktopRemovalAwareComponent,java.io.Serializable,java.lang.Cloneable,org.zkoss.zk.ui.Component,org.zkoss.zk.ui.ext.Scope,org.zkoss.zk.ui.sys.ComponentCtrl
- Direct Known Subclasses:
BundleNavigationNodeContentBrowser,CategoryTreeContentBrowser,DefaultPageableContentBrowser,DefaultSearchContentBrowser,ImportCockpitWelcomeContentBrowser,MappingContentBrowser
public class DefaultAdvancedContentBrowser extends AbstractContentContextBrowser
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractContentBrowser
AbstractContentBrowser.BrowserFocusDiv
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.StringCOCKPIT_ID_BROWSERAREA_ITEMS_TOTALprotected booleandesktopInvalidprotected static java.lang.StringDND_IDprotected org.zkoss.zkex.zul.BorderlayoutmainBorderlayoutprotected java.util.Map<java.lang.String,MainAreaComponentFactory>viewModeMapping-
Fields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractContentBrowser
captionComponent, CONTENT_BROWSER_CHANGE, contextAreaComponent, DEFAULT_OVERLAY_SCLASS, DEFAULT_SCLASS, FOCUSED_OVERLAY_SCLASS, FOCUSED_SCLASS, initialized, mainAreaComponent, statusBar, toolbarComponent
-
-
Constructor Summary
Constructors Constructor Description DefaultAdvancedContentBrowser()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AbstractBrowserComponentcreateCaptionComponent()Creates and returns the caption component of this content browser.protected AbstractBrowserComponentcreateContextAreaComponent()Creates and returns the context area component of this content browser.org.zkoss.zk.ui.HtmlBasedComponentcreateCustomPager(PageableBrowserModel pageableModel)protected AbstractBrowserComponentcreateDefaultViewModeComponent()protected AbstractBrowserComponentcreateMainAreaComponent()Creates and returns the main area component of this content browser.org.zkoss.zk.ui.HtmlBasedComponentcreatePageSizeCombobox(PageableBrowserModel pageableModel)protected AbstractBrowserComponentcreateToolbarComponent()Creates and returns the toolbar component of this content browser.booleancurrentViewHasOwnModel()voiddesktopRemoved(org.zkoss.zk.ui.Desktop desktop)protected java.lang.StringgetDefaultPagingMold()AdvancedBrowserModelgetModel()java.util.Map<java.lang.String,MainAreaComponentFactory>getViewModes()protected booleaninitialize()Initializes this content browser i.e.voidresize()voidsetModel(BrowserModel model)protected voidshowContextArea()booleanupdate()Updates this content browser i.e.voidupdateActivation()This method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.voidupdateActiveItems()This method makes it possible to force the view to re-render the items which are considered "active".voidupdateCaption()voidupdateContextArea()voidupdateContextArea(boolean cleanContextHeader)voidupdateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties, java.lang.Object reason)This method makes it possible to force the view to re-render a list of items.voidupdateMainArea()voidupdateSelectedItems()This method makes it possible to force the view to re-render the items which are considered "selected".voidupdateStatusBar()voidupdateToolbar()voidupdateViewMode()-
Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractContentBrowser
cleanup, detach, getActionConfiguration, getCaptionComponent, getContentBrowserComponent, getContextAreaComponent, getDDWrapper, getFocusComponent, getMainAreaComponent, getToolbarComponent, isActiveWhenUnfocused, isInitialized, setActiveWhenUnfocused, setContentBrowserComponent, setFocus, setFocusComponent, setParent, setRealSclass, setSclass, updateItem
-
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, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, 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, 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, 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
-
-
-
-
Field Detail
-
viewModeMapping
protected java.util.Map<java.lang.String,MainAreaComponentFactory> viewModeMapping
-
DND_ID
protected static final java.lang.String DND_ID
- See Also:
- Constant Field Values
-
COCKPIT_ID_BROWSERAREA_ITEMS_TOTAL
protected static final java.lang.String COCKPIT_ID_BROWSERAREA_ITEMS_TOTAL
- See Also:
- Constant Field Values
-
mainBorderlayout
protected transient org.zkoss.zkex.zul.Borderlayout mainBorderlayout
-
desktopInvalid
protected boolean desktopInvalid
-
-
Method Detail
-
setModel
public void setModel(BrowserModel model)
- Overrides:
setModelin classAbstractContentBrowser
-
getModel
public AdvancedBrowserModel getModel()
- Overrides:
getModelin classAbstractContentBrowser
-
resize
public void resize()
- Specified by:
resizein classAbstractContentBrowser
-
initialize
protected boolean initialize()
Description copied from class:AbstractContentBrowserInitializes this content browser i.e. creates all required components, adds event listeners etc. Note: This method is automatically called when amodelis set. Implementation note: Do not forget to set theAbstractContentBrowser.initializedflag before returning.- Specified by:
initializein classAbstractContentBrowser- Returns:
trueif initialization was successful,falseotherwise- See Also:
AbstractContentBrowser.setModel(BrowserModel)
-
updateActiveItems
public void updateActiveItems()
Description copied from class:AbstractContentBrowserThis method makes it possible to force the view to re-render the items which are considered "active". Note: This will not affect which items are considered active or not.- Specified by:
updateActiveItemsin classAbstractContentBrowser- See Also:
AbstractContentBrowser.updateActivation()
-
updateSelectedItems
public void updateSelectedItems()
Description copied from class:AbstractContentBrowserThis method makes it possible to force the view to re-render the items which are considered "selected".- Specified by:
updateSelectedItemsin classAbstractContentBrowser
-
updateItem
public void updateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties, java.lang.Object reason)
Description copied from class:AbstractContentBrowserThis method makes it possible to force the view to re-render a list of items.- Specified by:
updateItemin classAbstractContentBrowser- Parameters:
item- the item which should be re-renderedmodifiedProperties- set of modified propertiesreason- the object that causes the update, can be null
-
update
public boolean update()
Description copied from class:AbstractContentBrowserUpdates this content browser i.e. synchronizes its view width the underlying model.- Specified by:
updatein classAbstractContentBrowser- Returns:
trueif this browser was successfully updated,falseotherwise
-
updateStatusBar
public void updateStatusBar()
- Overrides:
updateStatusBarin classAbstractContentBrowser
-
updateActivation
public void updateActivation()
Description copied from class:AbstractContentBrowserThis method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.- Specified by:
updateActivationin classAbstractContentBrowser- See Also:
AbstractContentBrowser.updateActiveItems()
-
showContextArea
protected void showContextArea()
-
updateContextArea
public void updateContextArea()
- Specified by:
updateContextAreain classAbstractContentBrowser
-
updateContextArea
public void updateContextArea(boolean cleanContextHeader)
- Specified by:
updateContextAreain classAbstractContentContextBrowser
-
updateViewMode
public void updateViewMode()
- Specified by:
updateViewModein classAbstractContentBrowser
-
updateMainArea
public void updateMainArea()
- Specified by:
updateMainAreain classAbstractContentBrowser
-
createCaptionComponent
protected AbstractBrowserComponent createCaptionComponent()
Creates and returns the caption component of this content browser. The default implementation returns a newCaptionBrowserComponentinstance.- Returns:
- the caption component of this browser component
-
createToolbarComponent
protected AbstractBrowserComponent createToolbarComponent()
Creates and returns the toolbar component of this content browser. The default implementation returnsnull.- Returns:
- the toolbar component of this browser
-
getViewModes
public java.util.Map<java.lang.String,MainAreaComponentFactory> getViewModes()
-
createDefaultViewModeComponent
protected AbstractBrowserComponent createDefaultViewModeComponent()
-
createMainAreaComponent
protected AbstractBrowserComponent createMainAreaComponent()
Creates and returns the main area component of this content browser. The default implementation returns a newAbstractMainAreaBrowserComponentinstance.- Returns:
- the main area component of this browser
-
createContextAreaComponent
protected AbstractBrowserComponent createContextAreaComponent()
Creates and returns the context area component of this content browser. The default implementation returns a newContextAreaBrowserComponentinstance.- Returns:
- the context area component of this browser
-
createCustomPager
public org.zkoss.zk.ui.HtmlBasedComponent createCustomPager(PageableBrowserModel pageableModel)
-
createPageSizeCombobox
public org.zkoss.zk.ui.HtmlBasedComponent createPageSizeCombobox(PageableBrowserModel pageableModel)
-
getDefaultPagingMold
protected java.lang.String getDefaultPagingMold()
-
currentViewHasOwnModel
public boolean currentViewHasOwnModel()
-
updateCaption
public void updateCaption()
- Specified by:
updateCaptionin classAbstractContentBrowser
-
updateToolbar
public void updateToolbar()
- Specified by:
updateToolbarin classAbstractContentBrowser
-
desktopRemoved
public void desktopRemoved(org.zkoss.zk.ui.Desktop desktop)
- Specified by:
desktopRemovedin interfaceDesktopRemovalAwareComponent- Overrides:
desktopRemovedin classAbstractContentBrowser
-
-