de.hybris.platform.cockpit.components.contentbrowser

Class AbstractMultiViewToolbarBrowserComponent

java.lang.Object

Div

de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

de.hybris.platform.cockpit.components.contentbrowser.AbstractMultiViewToolbarBrowserComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent

Direct Known Subclasses:

DefaultMultiViewToolbarComponent, PagerToolbarBrowserComponent

public abstract class AbstractMultiViewToolbarBrowserComponent
extends AbstractBrowserComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BROWSER_VIEW_NOT_AVAILABLE
protected static java.lang.String	MODE_FACTORY

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

Constructor Summary

Constructors

Constructor and Description
AbstractMultiViewToolbarBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)

Method Summary

Modifier and Type	Method and Description
protected HtmlBasedComponent	createLeftToolbarContent()
protected HtmlBasedComponent	createRightToolbarContent()
protected HtmlBasedComponent	createToolbar()
protected boolean	currentViewHasOwnModel()
protected ActionColumnConfiguration	getActionConfig()
protected ActionColumnConfiguration	getAddtionalToolbarActionConfig()
Div	getCommentToolbarSlot()
AdvancedBrowserModel	getModel()
Div	getMultiSelectActionArea()
java.util.List<Toolbarbutton>	getViewModeButtons()
boolean	initialize() Initializes this browser component i.e.
protected void	initializeCommentToolbarSlot()
boolean	isViewButtonsVisible()
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.
void	setCommentToolbarSlot(Div commentToolbarSlot)
void	setViewButtonsVisible(boolean viewButtonsVisible)
boolean	update() Updates this browser component i.e.
protected void	updateActionArea(ActionColumnConfiguration actionConfig, HtmlBasedComponent actionArea, java.lang.Boolean isMultiSelect)
protected void	updateActionAreaAction(ListViewAction.Context context, ListViewAction action, HtmlBasedComponent actionArea, java.lang.Boolean isMultiSelect)
void	updateActiveItems() Re-renders the currently active item(s).
protected void	updateCommentToolbarSlot()
void	updateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties) Re-renders the item.
protected void	updateMultiSelectActionArea()
void	updateSelectedItems() Re-renders the currently selected item(s).
protected void	updateViewModeButtons()

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

getContentBrowser, setModel, updateItem

Methods inherited from class java.lang.Object

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

Field Detail

BROWSER_VIEW_NOT_AVAILABLE

protected static final java.lang.String BROWSER_VIEW_NOT_AVAILABLE

See Also:

Constant Field Values

MODE_FACTORY

protected static final java.lang.String MODE_FACTORY

See Also:

Constant Field Values

Constructor Detail

AbstractMultiViewToolbarBrowserComponent

public AbstractMultiViewToolbarBrowserComponent(BrowserModel model,
                                                AbstractContentBrowser contentBrowser)

Method Detail

currentViewHasOwnModel

protected boolean currentViewHasOwnModel()

createLeftToolbarContent

protected HtmlBasedComponent createLeftToolbarContent()

initializeCommentToolbarSlot

protected void initializeCommentToolbarSlot()

createRightToolbarContent

protected HtmlBasedComponent createRightToolbarContent()

updateViewModeButtons

protected void updateViewModeButtons()

updateMultiSelectActionArea

protected void updateMultiSelectActionArea()

updateActionArea

protected void updateActionArea(ActionColumnConfiguration actionConfig,
                                HtmlBasedComponent actionArea,
                                java.lang.Boolean isMultiSelect)

updateActionAreaAction

protected void updateActionAreaAction(ListViewAction.Context context,
                                      ListViewAction action,
                                      HtmlBasedComponent actionArea,
                                      java.lang.Boolean isMultiSelect)

getActionConfig

protected ActionColumnConfiguration getActionConfig()

getAddtionalToolbarActionConfig

protected ActionColumnConfiguration getAddtionalToolbarActionConfig()

getMultiSelectActionArea

public Div getMultiSelectActionArea()

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

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)

createToolbar

protected HtmlBasedComponent createToolbar()

updateCommentToolbarSlot

protected void updateCommentToolbarSlot()

getCommentToolbarSlot

public Div getCommentToolbarSlot()

Returns:

the commentToolbarSlot

setCommentToolbarSlot

public void setCommentToolbarSlot(Div commentToolbarSlot)

Parameters:

commentToolbarSlot - the commentToolbarSlot to set

getModel

public AdvancedBrowserModel getModel()

Specified by:

getModel in interface BrowserComponent

Overrides:

getModel in class AbstractBrowserComponent

isViewButtonsVisible

public boolean isViewButtonsVisible()

setViewButtonsVisible

public void setViewButtonsVisible(boolean viewButtonsVisible)

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

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

getViewModeButtons

public java.util.List<Toolbarbutton> getViewModeButtons()