de.hybris.platform.cockpit.components.contentbrowser

Class AbstractMainAreaBrowserComponent

java.lang.Object

Div

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

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

All Implemented Interfaces:

BrowserComponent, CockpitComponent, DesktopRemovalAwareComponent

Direct Known Subclasses:

AbstractSectionMainAreaBrowserComponent, BundleNavigationNodeContentMainComponent, CommentMainAreaBrowserComponent, CompareMainAreaBrowserComponent, LiveEditContentBrowser.DefaultLiveEditMainAreaComponent, MainAreaGridviewBrowserComponent, MainAreaListviewBrowserComponent, MainAreaPageFlowViewBrowserComponent, MainAreaPageFlowViewBrowserComponent, MainAreaPageImageStructureViewBrowserComponent, MainAreaPageStructureViewBrowserComponent, NavigationNodeContentMainComponent, PrintcockpitWelcomeMainAreaBrowserComponent, PrintPagesStructureViewBrowserComponent, WelcomeMainAreaBrowserComponent, WelcomeMainAreaBrowserComponent

public abstract class AbstractMainAreaBrowserComponent
extends AbstractBrowserComponent
implements DesktopRemovalAwareComponent

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EMPTY_MESSAGE
protected ObjectTemplate	lastResultType
protected MutableListModel	listComponentModel
protected LoginService	loginService
protected Div	mainArea
protected DefaultListModel<TypedObject>	resultModel
protected TypeService	typeService
protected UIConfigurationService	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, 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
AbstractMainAreaBrowserComponent(AdvancedBrowserModel model, AbstractContentBrowser contentBrowser)

Method Summary

Modifier and Type	Method and Description
protected abstract void	cleanup()
protected abstract Div	createMainArea()
protected DefaultBrowserTableController	createTableController(AdvancedBrowserModel advancedBrowserModel, MutableTableModel mutableTableModel, UIListView listView)
void	desktopRemoved(Desktop desktop)
void	detach()
protected abstract UIItemView	getCurrentItemView()
protected LoginService	getLoginService()
AdvancedBrowserModel	getModel()
protected DefaultListModel<TypedObject>	getResultModel()
protected ObjectTemplate	getRootType()
protected MutableTableModel	getTableModel()
protected TypeService	getTypeService()
protected UIConfigurationService	getUIConfigurationService()
boolean	initialize() Initializes this browser component i.e.
protected void	loadListModel()
protected void	resetSelection()
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)
protected void	setTableModel(MutableTableModel tableModel)
void	updateActiveItems() Re-renders the currently active item(s).
void	updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties) Re-renders the item.
protected void	updateResult()
void	updateSelectedItems() Re-renders the currently selected item(s).

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

getContentBrowser, setModel, update, updateItem

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MESSAGE

protected static final String EMPTY_MESSAGE

See Also:

Constant Field Values

mainArea

protected transient Div mainArea

resultModel

protected final DefaultListModel<TypedObject> resultModel

lastResultType

protected ObjectTemplate lastResultType

uiConfigurationService

protected UIConfigurationService uiConfigurationService

typeService

protected TypeService typeService

loginService

protected LoginService loginService

listComponentModel

protected MutableListModel listComponentModel

Constructor Detail

AbstractMainAreaBrowserComponent

public AbstractMainAreaBrowserComponent(AdvancedBrowserModel model,
                                        AbstractContentBrowser contentBrowser)

Method Detail

getModel

public AdvancedBrowserModel getModel()

Specified by:

getModel in interface BrowserComponent

Overrides:

getModel in class AbstractBrowserComponent

getCurrentItemView

protected abstract UIItemView getCurrentItemView()

createMainArea

protected abstract Div createMainArea()

resetSelection

protected void resetSelection()

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)

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

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

getResultModel

protected DefaultListModel<TypedObject> getResultModel()

updateResult

protected void updateResult()

loadListModel

protected void loadListModel()

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

getLoginService

protected LoginService getLoginService()

getTypeService

protected TypeService getTypeService()

getTableModel

protected MutableTableModel getTableModel()

setTableModel

protected void setTableModel(MutableTableModel tableModel)

getRootType

protected ObjectTemplate getRootType()

createTableController

protected DefaultBrowserTableController createTableController(AdvancedBrowserModel advancedBrowserModel,
                                                              MutableTableModel mutableTableModel,
                                                              UIListView listView)

desktopRemoved

public void desktopRemoved(Desktop desktop)

Specified by:

desktopRemoved in interface DesktopRemovalAwareComponent

detach

public void detach()

setParent

public void setParent(Component parent)

cleanup

protected abstract void cleanup()