AbstractBrowserComponent (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- Div
- - de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent

Direct Known Subclasses:

AbstractContextBrowserComponent, AbstractMainAreaBrowserComponent, AbstractMultiViewToolbarBrowserComponent, CaptionBrowserComponent, MacFinderTreeComponent, MappingBrowserCaptionComponent, ReportDashboardCaptionComponent, WidgetDashboardToolbarComponent
```
public abstract class AbstractBrowserComponent
extends Div
implements BrowserComponent
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ADV_QUERY_BTN_ACTIVE_IMG`
`protected static String`	`ADV_QUERY_BTN_IMG`
`protected static String`	`BROWSER_TOOLBAR_SCLASS`
`protected static String`	`CLOSE_BTN_IMG`
`protected static String`	`CONTENT_BROWSER_GB_SCLASS`
`protected static String`	`CONTENT_BROWSER_STICKY_GB_SCLASS`
`protected static String`	`DUPLICATE_BTN_IMG`
`protected boolean`	`initialized`
`protected static String`	`MAIN_AREA_BL_SCLASS`
`protected static String`	`MINIMIZE_BTN_IMG`
`protected static String`	`SAVE_QUERY_BTN_IMG`
`protected static String`	`SEARCH_MAGNIFIER_BTN_IMG`
`protected static String`	`SPLIT_ACTIVE_BTN_IMG`
`protected static String`	`SPLIT_INACTIVE_BTN_IMG`

Constructor Summary

Constructors
Constructor and Description

AbstractBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)

Constructors
Constructor and Description
`AbstractBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractContentBrowser`	`getContentBrowser()` Returns the content browser containing this browser component.
`BrowserModel`	`getModel()`
`abstract boolean`	`initialize()` Initializes this browser component i.e.
`abstract void`	`resize()` Notifies this browser component that it should resize itself if possible, since the view state might require it.
`abstract void`	`setActiveItem(TypedObject activeItem)` Sets the active item of this browser component to `activeItem`.
`void`	`setModel(BrowserModel model)` Sets the model to `model` and calls `initialize()`.
`abstract boolean`	`update()` Updates this browser component i.e.
`abstract void`	`updateActiveItems()` Re-renders the currently active item(s).
`abstract 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
`abstract void`	`updateSelectedItems()` Re-renders the currently selected item(s).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONTENT_BROWSER_GB_SCLASS
```
protected static final String CONTENT_BROWSER_GB_SCLASS
```
    See Also:
    
    Constant Field Values
  - CONTENT_BROWSER_STICKY_GB_SCLASS
```
protected static final String CONTENT_BROWSER_STICKY_GB_SCLASS
```
    See Also:
    
    Constant Field Values
  - BROWSER_TOOLBAR_SCLASS
```
protected static final String BROWSER_TOOLBAR_SCLASS
```
    See Also:
    
    Constant Field Values
  - MAIN_AREA_BL_SCLASS
```
protected static final String MAIN_AREA_BL_SCLASS
```
    See Also:
    
    Constant Field Values
  - SEARCH_MAGNIFIER_BTN_IMG
```
protected static final String SEARCH_MAGNIFIER_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - ADV_QUERY_BTN_IMG
```
protected static final String ADV_QUERY_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - ADV_QUERY_BTN_ACTIVE_IMG
```
protected static final String ADV_QUERY_BTN_ACTIVE_IMG
```
    See Also:
    
    Constant Field Values
  - SAVE_QUERY_BTN_IMG
```
protected static final String SAVE_QUERY_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - DUPLICATE_BTN_IMG
```
protected static final String DUPLICATE_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - SPLIT_ACTIVE_BTN_IMG
```
protected static final String SPLIT_ACTIVE_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - SPLIT_INACTIVE_BTN_IMG
```
protected static final String SPLIT_INACTIVE_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - MINIMIZE_BTN_IMG
```
protected static final String MINIMIZE_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - CLOSE_BTN_IMG
```
protected static final String CLOSE_BTN_IMG
```
    See Also:
    
    Constant Field Values
  - initialized
```
protected boolean initialized
```
- Constructor Detail
  - AbstractBrowserComponent
```
public AbstractBrowserComponent(BrowserModel model,
                                AbstractContentBrowser contentBrowser)
```
- Method Detail
  - update
```
public abstract boolean update()
```
    Updates this browser component i.e. synchronizes its view width the underlying model.
    
    Specified by:
    
    update in interface CockpitComponent
    
    Returns:
    
    true if this browser was successfully updated, false otherwise
  - setActiveItem
```
public abstract void setActiveItem(TypedObject activeItem)
```
    Sets the active item of this browser component to activeItem.
    
    Specified by:
    
    setActiveItem in interface CockpitComponent
    
    Parameters:
    
    activeItem - the new active item
  - updateActiveItems
```
public abstract void updateActiveItems()
```
    Re-renders the currently active item(s).
    
    Specified by:
    
    updateActiveItems in interface CockpitComponent
  - updateSelectedItems
```
public abstract void updateSelectedItems()
```
    Re-renders the currently selected item(s).
    
    Specified by:
    
    updateSelectedItems in interface CockpitComponent
  - updateItem
```
public abstract void updateItem(TypedObject item,
                                Set<PropertyDescriptor> modifiedProperties)
```
    Re-renders the item.
    
    Specified by:
    
    updateItem in interface CockpitComponent
    
    Parameters:
    
    item - the item to be re-rendered
    
    modifiedProperties - modified properties
  - updateItem
```
public void updateItem(TypedObject item,
                       Set<PropertyDescriptor> modifiedProperties,
                       Object reason)
```
    Override if you want to react on the reason for the update
    
    Parameters:
    
    reason - the reason for the update
  - initialize
```
public abstract boolean initialize()
```
    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
    
    Returns:
    
    true if initialization was successful, false otherwise
    
    See Also:
    
    setModel(BrowserModel)
  - resize
```
public abstract void resize()
```
    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.
  - getModel
```
public BrowserModel getModel()
```
    Specified by:
    
    getModel in interface BrowserComponent
  - getContentBrowser
```
public AbstractContentBrowser getContentBrowser()
```
    Returns the content browser containing this browser component.
    
    Returns:
    
    the content browser containing this component
  - setModel
```
public void setModel(BrowserModel model)
```
    Sets the model to model and calls initialize().
    
    Specified by:
    
    setModel in interface BrowserComponent
    
    Parameters:
    
    model - the model

Class AbstractBrowserComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_BROWSER_GB_SCLASS

CONTENT_BROWSER_STICKY_GB_SCLASS

BROWSER_TOOLBAR_SCLASS

MAIN_AREA_BL_SCLASS

SEARCH_MAGNIFIER_BTN_IMG

ADV_QUERY_BTN_IMG

ADV_QUERY_BTN_ACTIVE_IMG

SAVE_QUERY_BTN_IMG

DUPLICATE_BTN_IMG

SPLIT_ACTIVE_BTN_IMG

SPLIT_INACTIVE_BTN_IMG

MINIMIZE_BTN_IMG

CLOSE_BTN_IMG

initialized

Constructor Detail

AbstractBrowserComponent

Method Detail

update

setActiveItem

updateActiveItems

updateSelectedItems

updateItem

updateItem

initialize

resize

getModel

getContentBrowser

setModel