Package de.hybris.platform.cockpit.components.contentbrowser

Class CaptionBrowserComponent

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.CaptionBrowserComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent, java.io.Serializable, java.lang.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:

LiveEditContentBrowser.DefaultLiveEditCaptionComponent, QueryCaptionBrowserComponent

public class CaptionBrowserComponent
extends AbstractBrowserComponent

See Also:

Serialized Form

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

Modifier and Type	Field	Description
protected org.zkoss.zul.Toolbarbutton	closeBtn
protected org.zkoss.zul.Groupbox	mainGroupbox
protected org.zkoss.zul.Label	navigationPathLabel
protected org.zkoss.zul.Popup	navigationPathTooltip

Fields 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_IMG

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
CaptionBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)

Method Summary

Modifier and Type	Method	Description
protected void	createAdditionalRightCaptionComponents(org.zkoss.zul.Hbox hbox)
protected org.zkoss.zk.ui.HtmlBasedComponent	createAdvancedArea()
protected org.zkoss.zul.Caption	createCaption()	Creates the caption component.
protected org.zkoss.zk.ui.HtmlBasedComponent	createCaptionLabelComponent()	Called by createCaption().
protected org.zkoss.zk.ui.HtmlBasedComponent	createCaptionLabelTooltipContent(java.lang.String string)
protected org.zkoss.zul.Groupbox	createGroupbox()
protected org.zkoss.zk.ui.HtmlBasedComponent	createLeftCaptionContent()	Creates and returns the content of the (upper) left side of this caption component.
protected org.zkoss.zk.ui.HtmlBasedComponent	createRightCaptionContent()	Creates and returns the content of the (upper) right side of this caption component.
boolean	initialize()	Initializes this browser component i.e.
void	resize()	Notifies this browser component that it should resize itself if possible, since the view state might require it.
void	setActiveItem(TypedObject activeItem)	Sets the active item of this browser component to activeItem.
boolean	update()	Updates this browser component i.e.
void	updateActiveItems()	Re-renders the currently active item(s).
void	updateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties)	Re-renders the item.
void	updateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties, java.lang.Object reason)	Override if you want to react on the reason for the update
protected void	updateLabels()
void	updateSelectedItems()	Re-renders the currently selected item(s).

Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

getContentBrowser, getModel, setModel

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, 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, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, 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, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

Methods inherited from interface org.zkoss.zul.api.Div

getAlign, setAlign

Methods 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, setZIndex

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Field Detail

mainGroupbox

protected transient org.zkoss.zul.Groupbox mainGroupbox

closeBtn

protected transient org.zkoss.zul.Toolbarbutton closeBtn

navigationPathTooltip

protected transient org.zkoss.zul.Popup navigationPathTooltip

navigationPathLabel

protected transient org.zkoss.zul.Label navigationPathLabel

Constructor Detail

CaptionBrowserComponent

public CaptionBrowserComponent(BrowserModel model,
                               AbstractContentBrowser contentBrowser)

Method Detail

initialize

public boolean initialize()

Description copied from class: AbstractBrowserComponent

Initializes this browser component i.e. creates all required components, adds event listeners etc.

Implementation note: Remember to set the initialized flag to true after this method has been called.

Note: This method is automatically called when a model or browser controller is set.

Specified by:

initialize in interface CockpitComponent

Specified by:

initialize in class AbstractBrowserComponent

Returns:

true if initialization was successful, false otherwise

See Also:

AbstractBrowserComponent.setModel(BrowserModel)

update

public boolean update()

Description copied from class: AbstractBrowserComponent

Updates this browser component i.e. synchronizes its view width the underlying model.

Specified by:

update in interface CockpitComponent

Specified by:

update in class AbstractBrowserComponent

Returns:

true if this browser was successfully updated, false otherwise

updateItem

public void updateItem(TypedObject item,
                       java.util.Set<PropertyDescriptor> modifiedProperties,
                       java.lang.Object reason)

Description copied from class: AbstractBrowserComponent

Override if you want to react on the reason for the update

Overrides:

updateItem in class AbstractBrowserComponent

reason - the reason for the update

updateLabels

protected void updateLabels()

setActiveItem

public void setActiveItem(TypedObject activeItem)

Description copied from class: AbstractBrowserComponent

Sets the active item of this browser component to activeItem.

Specified by:

setActiveItem in interface CockpitComponent

Specified by:

setActiveItem in class AbstractBrowserComponent

Parameters:

activeItem - the new active item

updateActiveItems

public void updateActiveItems()

Description copied from class: AbstractBrowserComponent

Re-renders the currently active item(s).

Specified by:

updateActiveItems in interface CockpitComponent

Specified by:

updateActiveItems in class AbstractBrowserComponent

updateSelectedItems

public void updateSelectedItems()

Description copied from class: AbstractBrowserComponent

Re-renders the currently selected item(s).

Specified by:

updateSelectedItems in interface CockpitComponent

Specified by:

updateSelectedItems in class AbstractBrowserComponent

createGroupbox

protected org.zkoss.zul.Groupbox createGroupbox()

createAdvancedArea

protected org.zkoss.zk.ui.HtmlBasedComponent createAdvancedArea()

createCaption

protected org.zkoss.zul.Caption createCaption()

Creates the caption component. Calls createLeftCaptionContent(), createRightCaptionContent() and createCaptionLabelComponent().

Note: You typically want to override createLeftCaptionContent(), createRightCaptionContent() and/or createCaptionLabelComponent() methods instead of this one.

Returns:

the created caption component

createLeftCaptionContent

protected org.zkoss.zk.ui.HtmlBasedComponent createLeftCaptionContent()

Creates and returns the content of the (upper) left side of this caption component.

Called by createCaption().

createAdditionalRightCaptionComponents

protected void createAdditionalRightCaptionComponents(org.zkoss.zul.Hbox hbox)

createRightCaptionContent

protected org.zkoss.zk.ui.HtmlBasedComponent createRightCaptionContent()

Creates and returns the content of the (upper) right side of this caption component. Called by createCaption().

createCaptionLabelComponent

protected org.zkoss.zk.ui.HtmlBasedComponent createCaptionLabelComponent()

Called by createCaption(). Calls createCaptionLabelTooltipContent(String).

createCaptionLabelTooltipContent

protected org.zkoss.zk.ui.HtmlBasedComponent createCaptionLabelTooltipContent(java.lang.String string)

resize

public void resize()

Description copied from class: AbstractBrowserComponent

Notifies this browser component that it should resize itself if possible, since the view state might require it.

This is typically only necessary for ZK's Borderlayout components.

Specified by:

resize in class AbstractBrowserComponent

updateItem

public void updateItem(TypedObject item,
                       java.util.Set<PropertyDescriptor> modifiedProperties)

Description copied from class: AbstractBrowserComponent

Re-renders the item.

Specified by:

updateItem in interface CockpitComponent

Specified by:

updateItem in class AbstractBrowserComponent

Parameters:

item - the item to be re-rendered

modifiedProperties - modified properties