de.hybris.platform.cockpit.components.contentbrowser

Class AbstractSectionMainAreaBrowserComponent

java.lang.Object

Div

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

de.hybris.platform.cockpit.components.contentbrowser.AbstractMainAreaBrowserComponent

de.hybris.platform.cockpit.components.contentbrowser.AbstractSectionMainAreaBrowserComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent, DesktopRemovalAwareComponent

Direct Known Subclasses:

DefaultSectionMainAreaBrowserComponent

public abstract class AbstractSectionMainAreaBrowserComponent
extends AbstractMainAreaBrowserComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized
protected Borderlayout	mainArea
protected Map<BrowserSectionModel,BrowserComponent>	sectionMap

Fields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractMainAreaBrowserComponent

EMPTY_MESSAGE, lastResultType, listComponentModel, loginService, resultModel, typeService, uiConfigurationService

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, 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
AbstractSectionMainAreaBrowserComponent(SectionBrowserModel model, AbstractContentBrowser contentBrowser)

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
protected Borderlayout	createMainBorderLayout()
protected Map<BrowserSectionModel,BrowserComponent>	createSections()
void	desktopRemoved(Desktop desktop)
void	detach()
SectionBrowserModel	getModel()
protected SectionModelListener	getSectionModelListener()
boolean	initialize() Initializes this browser component i.e.
protected boolean	isInitialized()
protected abstract void	layoutSections(List<BrowserSectionModel> sectionModels, HtmlBasedComponent parent) Responsible for laying out the different sections.
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	setParent(Component parent)
void	setSectionModelListener(SectionModelListener sectionModelListener) Sets the section model listener to be used by this view component in order to keep its state up to date.
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	updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties, Object reason) Override if you want to react on the reason for the update
void	updateSection(BrowserSectionModel sectionModel)
void	updateSectionSelection(BrowserSectionModel sectionModel)

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

createMainArea, createTableController, getCurrentItemView, getLoginService, getResultModel, getRootType, getTableModel, getTypeService, getUIConfigurationService, loadListModel, resetSelection, setTableModel, updateResult, updateSelectedItems

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

getContentBrowser, setModel

Methods inherited from class java.lang.Object

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

Field Detail

sectionMap

protected transient Map<BrowserSectionModel,BrowserComponent> sectionMap

mainArea

protected transient Borderlayout mainArea

initialized

protected boolean initialized

Constructor Detail

AbstractSectionMainAreaBrowserComponent

public AbstractSectionMainAreaBrowserComponent(SectionBrowserModel 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

Overrides:

initialize in class AbstractMainAreaBrowserComponent

Returns:

true if initialization was successful, false otherwise

See Also:

AbstractBrowserComponent.setModel(BrowserModel)

createMainBorderLayout

protected Borderlayout createMainBorderLayout()

layoutSections

protected abstract void layoutSections(List<BrowserSectionModel> sectionModels,
                                       HtmlBasedComponent parent)

Responsible for laying out the different sections.

Parameters:

sectionModels - the sections to be rendered

parent - the parent component to which the sections should be added

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

getModel

public SectionBrowserModel getModel()

Specified by:

getModel in interface BrowserComponent

Overrides:

getModel in class AbstractMainAreaBrowserComponent

updateItem

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

updateItem

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

Description copied from class: AbstractBrowserComponent

Re-renders the item.

Specified by:

updateItem in interface CockpitComponent

Overrides:

updateItem in class AbstractMainAreaBrowserComponent

Parameters:

item - the item to be re-rendered

modifiedProperties - modified properties

updateSection

public void updateSection(BrowserSectionModel sectionModel)

updateSectionSelection

public void updateSectionSelection(BrowserSectionModel sectionModel)

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.

Overrides:

resize in class AbstractMainAreaBrowserComponent

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

Overrides:

setActiveItem in class AbstractMainAreaBrowserComponent

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

Overrides:

updateActiveItems in class AbstractMainAreaBrowserComponent

createSections

protected Map<BrowserSectionModel,BrowserComponent> createSections()

setSectionModelListener

public void setSectionModelListener(SectionModelListener sectionModelListener)

Sets the section model listener to be used by this view component in order to keep its state up to date.

Note: This listener should be used internally for updating this view components state when the underlying model changes.

Parameters:

sectionModelListener -

getSectionModelListener

protected SectionModelListener getSectionModelListener()

isInitialized

protected boolean isInitialized()

setParent

public void setParent(Component parent)

Overrides:

setParent in class AbstractMainAreaBrowserComponent

detach

public void detach()

Overrides:

detach in class AbstractMainAreaBrowserComponent

desktopRemoved

public void desktopRemoved(Desktop desktop)

Specified by:

desktopRemoved in interface DesktopRemovalAwareComponent

Overrides:

desktopRemoved in class AbstractMainAreaBrowserComponent

cleanup

protected void cleanup()

Specified by:

cleanup in class AbstractMainAreaBrowserComponent