de.hybris.platform.cockpit.reports.components.contentbrowser

Class ReportDashboardCaptionComponent

java.lang.Object

Div

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

de.hybris.platform.cockpit.reports.components.contentbrowser.ReportDashboardCaptionComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent

public class ReportDashboardCaptionComponent
extends AbstractBrowserComponent

WARNING: unstable API, don't extend

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	leftCaptionCmp
protected Component	rightCaptionCmp

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

Method Summary

Modifier and Type	Method and Description
protected Component	createRightCaptionComponent()
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, Set<PropertyDescriptor> modifiedProperties) Re-renders the item.
void	updateSelectedItems() Re-renders the currently selected item(s).

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

getContentBrowser, getModel, setModel, updateItem

Methods inherited from class java.lang.Object

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

Field Detail

rightCaptionCmp

protected Component rightCaptionCmp

leftCaptionCmp

protected Component leftCaptionCmp

Constructor Detail

ReportDashboardCaptionComponent

public ReportDashboardCaptionComponent(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)

createRightCaptionComponent

protected Component createRightCaptionComponent()

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

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

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

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

updateItem

public void updateItem(TypedObject item,
                       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

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