de.hybris.platform.cockpit.components.contentbrowser

Class AbstractContentBrowser

java.lang.Object

Div

de.hybris.platform.cockpit.components.contentbrowser.AbstractContentBrowser

All Implemented Interfaces:

DesktopRemovalAwareComponent

Direct Known Subclasses:

AbstractContentContextBrowser, AbstractSimpleContentBrowser

public abstract class AbstractContentBrowser
extends Div
implements DesktopRemovalAwareComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractContentBrowser.BrowserFocusDiv

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractBrowserComponent	captionComponent
static String	CONTENT_BROWSER_CHANGE
protected AbstractBrowserComponent	contextAreaComponent
static String	DEFAULT_OVERLAY_SCLASS
static String	DEFAULT_SCLASS
static String	FOCUSED_OVERLAY_SCLASS
static String	FOCUSED_SCLASS
protected boolean	initialized Indicates whether this content browser has been initialized or not.
protected AbstractBrowserComponent	mainAreaComponent
protected Div	statusBar
protected AbstractBrowserComponent	toolbarComponent

Constructor Summary

Constructors

Constructor and Description
AbstractContentBrowser()

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
void	desktopRemoved(Desktop desktop)
void	detach()
ActionColumnConfiguration	getActionConfiguration()
AbstractBrowserComponent	getCaptionComponent()
protected HtmlBasedComponent	getContentBrowserComponent()
AbstractBrowserComponent	getContextAreaComponent()
protected DragAndDropWrapper	getDDWrapper()
protected HtmlBasedComponent	getFocusComponent()
AbstractBrowserComponent	getMainAreaComponent()
BrowserModel	getModel()
AbstractBrowserComponent	getToolbarComponent()
protected abstract boolean	initialize() Initializes this content browser i.e.
boolean	isActiveWhenUnfocused()
boolean	isInitialized()
abstract void	resize()
void	setActiveWhenUnfocused(boolean activeWhenUnfocused)
void	setContentBrowserComponent(HtmlBasedComponent contentBrowserComponent)
void	setFocus(boolean focus)
void	setFocusComponent(HtmlBasedComponent focusComponent)
void	setModel(BrowserModel model)
void	setParent(Component parent)
void	setRealSclass(String sclass)
void	setSclass(String sclass)
abstract boolean	update() Updates this content browser i.e.
abstract void	updateActivation() This method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.
abstract void	updateActiveItems() This method makes it possible to force the view to re-render the items which are considered "active".
abstract void	updateCaption()
abstract void	updateContextArea()
void	updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
abstract void	updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties, Object reason) This method makes it possible to force the view to re-render a list of items.
abstract void	updateMainArea()
abstract void	updateSelectedItems() This method makes it possible to force the view to re-render the items which are considered "selected".
void	updateStatusBar()
abstract void	updateToolbar()
abstract void	updateViewMode()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_BROWSER_CHANGE

public static final String CONTENT_BROWSER_CHANGE

See Also:

Constant Field Values

DEFAULT_SCLASS

public static final String DEFAULT_SCLASS

See Also:

Constant Field Values

FOCUSED_SCLASS

public static final String FOCUSED_SCLASS

See Also:

Constant Field Values

DEFAULT_OVERLAY_SCLASS

public static final String DEFAULT_OVERLAY_SCLASS

See Also:

Constant Field Values

FOCUSED_OVERLAY_SCLASS

public static final String FOCUSED_OVERLAY_SCLASS

See Also:

Constant Field Values

captionComponent

protected transient AbstractBrowserComponent captionComponent

toolbarComponent

protected transient AbstractBrowserComponent toolbarComponent

mainAreaComponent

protected transient AbstractBrowserComponent mainAreaComponent

contextAreaComponent

protected transient AbstractBrowserComponent contextAreaComponent

statusBar

protected transient Div statusBar

initialized

protected boolean initialized

Indicates whether this content browser has been initialized or not.

Constructor Detail

AbstractContentBrowser

public AbstractContentBrowser()

Method Detail

setFocus

public void setFocus(boolean focus)

getDDWrapper

protected DragAndDropWrapper getDDWrapper()

setSclass

public void setSclass(String sclass)

setRealSclass

public void setRealSclass(String sclass)

setFocusComponent

public void setFocusComponent(HtmlBasedComponent focusComponent)

getFocusComponent

protected HtmlBasedComponent getFocusComponent()

setContentBrowserComponent

public void setContentBrowserComponent(HtmlBasedComponent contentBrowserComponent)

getContentBrowserComponent

protected HtmlBasedComponent getContentBrowserComponent()

getModel

public BrowserModel getModel()

setModel

public void setModel(BrowserModel model)

updateActiveItems

public abstract void updateActiveItems()

This method makes it possible to force the view to re-render the items which are considered "active".

Note: This will not affect which items are considered active or not.

See Also:

updateActivation()

updateSelectedItems

public abstract void updateSelectedItems()

This method makes it possible to force the view to re-render the items which are considered "selected".

updateItem

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

This method makes it possible to force the view to re-render a list of items.

Parameters:

item - the item which should be re-rendered

modifiedProperties - set of modified properties

reason - the object that causes the update, can be null

updateItem

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

updateActivation

public abstract void updateActivation()

This method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.

See Also:

updateActiveItems()

updateMainArea

public abstract void updateMainArea()

updateViewMode

public abstract void updateViewMode()

updateContextArea

public abstract void updateContextArea()

updateCaption

public abstract void updateCaption()

updateToolbar

public abstract void updateToolbar()

update

public abstract boolean update()

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

Returns:

true if this browser was successfully updated, false otherwise

initialize

protected abstract boolean initialize()

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

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

Implementation note: Do not forget to set the initialized flag before returning.

Returns:

true if initialization was successful, false otherwise

See Also:

setModel(BrowserModel)

resize

public abstract void resize()

updateStatusBar

public void updateStatusBar()

setActiveWhenUnfocused

public void setActiveWhenUnfocused(boolean activeWhenUnfocused)

Parameters:

activeWhenUnfocused - the activeWhenUnfocused to set

isActiveWhenUnfocused

public boolean isActiveWhenUnfocused()

Returns:

the activeWhenUnfocused

isInitialized

public boolean isInitialized()

getCaptionComponent

public AbstractBrowserComponent getCaptionComponent()

getToolbarComponent

public AbstractBrowserComponent getToolbarComponent()

getMainAreaComponent

public AbstractBrowserComponent getMainAreaComponent()

getContextAreaComponent

public AbstractBrowserComponent getContextAreaComponent()

getActionConfiguration

public ActionColumnConfiguration getActionConfiguration()

setParent

public void setParent(Component parent)

detach

public void detach()

desktopRemoved

public void desktopRemoved(Desktop desktop)

Specified by:

desktopRemoved in interface DesktopRemovalAwareComponent

cleanup

protected void cleanup()