Class ContextAreaBrowserComponent
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.AbstractContextBrowserComponent
de.hybris.platform.cockpit.components.contentbrowser.ContextAreaBrowserComponent
- 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
public class ContextAreaBrowserComponent
extends AbstractContextBrowserComponent
implements DesktopRemovalAwareComponent
Context area browser component.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classprotected classNested 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 static final Stringprotected booleanprotected ColumnModelListenerListener that keeps track of visibility changes of columns and persists those changes.protected static final Stringprotected org.zkoss.zk.ui.HtmlBasedComponentprotected org.zkoss.zul.Divprotected org.zkoss.zul.Labelprotected final DefaultListModel<TypedObject>protected static final Stringprotected org.zkoss.zk.ui.event.EventListenerprotected Stringprotected booleanprotected Stringprotected ObjectTemplateprotected static final Stringprotected UIListViewprotected LoginServiceprotected org.zkoss.zul.Divprotected org.zkoss.zul.Comboboxprotected org.zkoss.zul.Pagingprotected TypedObjectprotected SystemServiceprotected ContextAreaTableControllerprotected org.zkoss.zul.Divprotected TypeServiceprotected UIAccessRightServiceprotected 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, initialized, 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
ConstructorsConstructorDescriptionContextAreaBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcleanup()protected org.zkoss.zul.ToolbarbuttoncreateCloseButton(String closeBtnImg) protected org.zkoss.zk.ui.HtmlBasedComponentprotected org.zkoss.zul.Groupboxprotected Stringprotected org.zkoss.zul.Divprotected TableModelListenerprotected ListViewConfigurationvoiddesktopRemoved(org.zkoss.zk.ui.Desktop desktop) voiddetach()protected ColumnModelListenerA columnModelListener to keep track of visibility changes of the ListModel columns.protected DefaultListModel<TypedObject>protected ObjectTemplateprotected MutableTableModelprotected Collection<org.zkoss.zk.ui.HtmlBasedComponent>protected Collection<org.zkoss.zk.ui.HtmlBasedComponent>protected MutableListModelprotected ListViewHelper.ListenerHandlerprotected ListViewConfigurationgetListViewConfiguration(ObjectTemplate objectTemplate, String code) protected LoginServicegetModel()protected AbstractPageableBrowserModelprotected Set<PropertyDescriptor>getRequiredPropertyDescriptors(ObjectTemplate template) protected SystemServiceprotected TypeServiceprotected UIAccessRightServiceprotected UIConfigurationServiceprotected ObjectValueContainergetValueContainer(ObjectTemplate template) booleanInitializes this browser component i.e.protected booleanisContextPagingEnabled(AbstractPageableBrowserModel browserModel) protected UIListViewprotected ListViewConfigurationload the list view configurationvoidresize()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.protected voidsetContextTableModel(MutableTableModel tableModel) voidsetParent(org.zkoss.zk.ui.Component parent) protected voidprotected voidprotected voidbooleanupdate()Updates this browser component i.e.booleanupdate(boolean cleanContextHeader) Updates this browser component i.e.voidRe-renders the currently active item(s).protected voidvoidupdateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties) Re-renders the item.protected voidupdateMultiSelectAction(ListViewAction.Context context, ListViewAction action) protected voidprotected voidvoidRe-renders the currently selected item(s).Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
getContentBrowser, setModel, updateItemMethods 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, 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, 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
-
CONTEXT_AREA_MAIN_DIV_SCLASS
- See Also:
-
EMPTY_MESSAGE_I3
- See Also:
-
LIST_VIEW_CONFIG_CODE
- See Also:
-
BROWSERAREA_SHOW_MAX_L10NKEY
- See Also:
-
listView
-
contextArea
protected transient org.zkoss.zk.ui.HtmlBasedComponent contextArea -
internalContextViewMode
-
contextModel
-
gridContextController
protected org.zkoss.zk.ui.event.EventListener gridContextController -
contextAreaMainDiv
protected transient org.zkoss.zul.Div contextAreaMainDiv -
uiConfigurationService
-
typeService
-
uiAccessRightService
-
tableController
-
lastContextType
-
loginService
-
contextHeader
protected org.zkoss.zul.Label contextHeader -
cleanContextHeader
protected boolean cleanContextHeader -
systemService
-
inlineCreationEnabled
protected boolean inlineCreationEnabled -
toolbarDiv
protected org.zkoss.zul.Div toolbarDiv -
multiSelectActionArea
protected org.zkoss.zul.Div multiSelectActionArea -
paging
protected org.zkoss.zul.Paging paging -
pageSizeCombo
protected org.zkoss.zul.Combobox pageSizeCombo -
previouslyActiveItem
-
headerString
-
columnModelListener
Listener that keeps track of visibility changes of columns and persists those changes.
-
-
Constructor Details
-
ContextAreaBrowserComponent
-
-
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- Specified by:
initializein classAbstractBrowserComponent- Returns:
trueif initialization was successful,falseotherwise- See Also:
-
getModel
- Specified by:
getModelin interfaceBrowserComponent- Overrides:
getModelin classAbstractBrowserComponent
-
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
-
updateMultiSelectActionArea
protected void updateMultiSelectActionArea() -
updateMultiSelectAction
-
updatePaging
protected void updatePaging() -
setActiveItem
Description copied from class:AbstractBrowserComponentSets the active item of this browser component toactiveItem.- Specified by:
setActiveItemin interfaceCockpitComponent- Specified by:
setActiveItemin classAbstractBrowserComponent- 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- Specified by:
updateActiveItemsin classAbstractBrowserComponent
-
updateSelectedItems
public void updateSelectedItems()Description copied from class:AbstractBrowserComponentRe-renders the currently selected item(s).- Specified by:
updateSelectedItemsin interfaceCockpitComponent- Specified by:
updateSelectedItemsin classAbstractBrowserComponent
-
updateItem
Description copied from class:AbstractBrowserComponentRe-renders the item.- Specified by:
updateItemin interfaceCockpitComponent- Specified by:
updateItemin classAbstractBrowserComponent- Parameters:
item- the item to be re-renderedmodifiedProperties- modified properties
-
getContextListModel
-
updateContextItems
protected void updateContextItems() -
createContextArea
protected org.zkoss.zk.ui.HtmlBasedComponent createContextArea() -
createContextMainDiv
protected org.zkoss.zul.Div createContextMainDiv() -
createContextHeader
-
createContextGroupbox
protected org.zkoss.zul.Groupbox createContextGroupbox() -
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.- Specified by:
resizein classAbstractBrowserComponent
-
getListComponentModel
-
loadListView
-
loadListViewConfig
load the list view configuration -
createMultiTypeListViewConfiguration
-
getListViewConfiguration
protected ListViewConfiguration getListViewConfiguration(ObjectTemplate objectTemplate, String code) -
getUIConfigurationService
-
getUIAccessRightService
-
getLoginService
-
getTypeService
-
getContextTableModel
-
setContextTableModel
-
getContextResultType
-
detach
public void detach()- Specified by:
detachin interfaceorg.zkoss.zk.ui.Component- Overrides:
detachin 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 classorg.zkoss.zk.ui.AbstractComponent
-
desktopRemoved
public void desktopRemoved(org.zkoss.zk.ui.Desktop desktop) - Specified by:
desktopRemovedin interfaceDesktopRemovalAwareComponent
-
cleanup
protected void cleanup() -
getSystemService
-
showAddItemPopup
protected void showAddItemPopup() -
showAddItemRow
protected void showAddItemRow() -
getValueContainer
-
getRequiredPropertyDescriptors
-
isContextPagingEnabled
-
getPageableBrowserModelIfPresent
-
getEditorFactory
-
update
public boolean update(boolean cleanContextHeader) Description copied from class:AbstractContextBrowserComponentUpdates this browser component i.e. synchronizes its view width the underlying model.- Specified by:
updatein classAbstractContextBrowserComponent- Parameters:
cleanContextHeader- indicates if cleaning of ContextHeader is necessary- Returns:
trueif this browser was successfully updated,falseotherwise
-
getListenerHandler
-
getGroupboxComponents
-
getHeaderComponents
-
createCloseButton
-
createContextTableModelListener
-
getColumnModelListener
A columnModelListener to keep track of visibility changes of the ListModel columns.- Returns:
- ColumnModelListener the listener that should be hooked into ColumnModel
-
storeListViewConfiguration
protected void storeListViewConfiguration()
-