de.hybris.platform.cockpit.session.impl

Class BaseUICockpitPerspective

java.lang.Object

de.hybris.platform.cockpit.session.impl.AbstractUIPerspective

de.hybris.platform.cockpit.session.impl.BaseUICockpitPerspective

All Implemented Interfaces:

CockpitEventAcceptor, CockpitEventProducer, UICockpitPerspective, UIComponent

Direct Known Subclasses:

AbstractConstraintPerspective, AbstractProductCockpitPerspective, AdminBundlePerspective, AdminPerspective, CmsCockpitPerspective, ImportCockpitCronJobPerspective, JirafePerspective, PrintPerspective, ReportPerspective

public class BaseUICockpitPerspective
extends AbstractUIPerspective

Field Summary

Fields

Modifier and Type	Field and Description
static String	DRAG_DROP_ID
static String	INITIAL_ATTRIBUTES
static String	PROPERTY_DESCRIPTOR

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractUIPerspective

activeItem

Constructor Summary

Constructors

Constructor and Description
BaseUICockpitPerspective()

Method Summary

Modifier and Type	Method and Description
void	activateItemInEditor(TypedObject activeItem)
protected void	activateItemInEditorArea(TypedObject activeItem)
void	activateItemInPopupEditor(TypedObject activeItem)
void	addCockpitEventAcceptor(CockpitEventAcceptor acceptor)
boolean	canCreate(TemplateListEntry entry)
void	closeAreasIfOverlapped()
void	closePopupEditor()
void	collapseEditorArea()
void	collapseNavigationArea()
void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, BrowserModel browser) Deprecated.
void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, BrowserModel browser, boolean loadDefaultValues) Deprecated.
void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, BrowserModel browser, boolean loadDefaultValues, boolean initialValidation) Deprecated.
protected void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, BrowserModel browser, CreateContext ctx, boolean loadDefaultValues, boolean initialValidation)
void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, CreateContext context)
void	createItemInPopupEditor(ObjectType type, Map<String,? extends Object> initialValues, CreateContext context, boolean loadDefaultValues)
void	createNewItem(ObjectTemplate template)
void	createNewItem(ObjectTemplate template, CreateContext createContext, Map<String,Object> initValues, boolean loadDefaultValues, boolean expandEditorArea, boolean popup) Creates new item.
void	createNewItem(ObjectTemplate template, Map<String,Object> initValues)
void	createNewItem(ObjectTemplate template, Map<String,Object> initValues, boolean loadDefaultValues)
protected void	createTemplateList(String baseType)
void	expandEditorArea()
void	expandEditorArea(boolean invalidate)
void	expandNavigationArea()
boolean	generateCreateMenuitems(Menupopup menupopup, boolean popup)
boolean	generateCreateMenuitems(Menupopup menupopup, boolean expandEditorArea, CreateContext createContext, boolean popup, Map<String,Object> initValues, boolean loadDefaultValues) Generates menu for creating new items.
List<TemplateListEntry>	generateTemplateEntryList(CreateContext createContext)
UIBrowserArea	getBrowserArea()
protected BrowserAreaListener	getBrowserAreaListener()
String	getCustomCsaURI()
UIEditorArea	getEditorArea()
LayoutRegion	getEditorAreaComponent()
protected EditorAreaListener	getEditorAreaListener()
UINavigationArea	getNavigationArea()
LayoutRegion	getNavigationAreaComponent()
protected NavigationAreaListener	getNavigationAreaListener()
NotifierZKComponent	getNotifier()
UIEditorArea	getPopupEditorArea()
protected List<TemplateListEntry>	getTemplateList(String baseType)
protected UIConfigurationService	getUIConfigurationService()
void	handleItemRemoved(TypedObject object)
void	initialize(Map<String,Object> params)
boolean	isActivatable(TypedObject item)
boolean	isForceOpenInEditorArea()
boolean	isPopupEditorOpen()
void	onCockpitEvent(CockpitEvent event)
void	onHide()
void	onShow()
void	openReferenceCollectionInBrowserContext(Collection<TypedObject> objects, ObjectTemplate template, TypedObject rootItem, Map<String,? extends Object> parameters)
void	removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)
void	resetOpenBrowserContainer()
void	setBrowserArea(UIBrowserArea browserArea)
void	setBrowserAreaListener(BrowserAreaListener browserAreaListener)
void	setCustomCsaURI(String customCsaURI)
void	setEditorArea(UIEditorArea editorArea)
void	setEditorAreaComponent(LayoutRegion editorAreaComponent)
void	setEditorAreaListener(EditorAreaListener editorAreaListener)
void	setEditorAreaTypes(Set<EditorAreaTypeRule> typeRules)
void	setForceOpenInEditorArea(boolean forceOpenInEditorArea)
void	setNavigationArea(UINavigationArea navigationArea)
void	setNavigationAreaComponent(LayoutRegion navigationAreaComponent)
void	setNavigationAreaListener(NavigationAreaListener navAreaListener)
void	setNotifier(NotifierZKComponent notifier)
void	setPopupEditorArea(UIEditorArea popupEditorArea)
void	setPopupEditorWindow(Window popupEditorWindow)
void	setUiConfigurationService(UIConfigurationService uiConfigurationService)
void	toggleNavAndEditArea()
void	update()

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractUIPerspective

getActiveItem, getDragAndDropWrapperService, getEffectBorderColor, getEffectDuration, getFocusedArea, getInfoBoxTimeout, getLabel, getMoveTargetX, getMoveTargetY, getTemplateList, getTypeService, getUid, getViewURI, isActivationEffectEnabled, isSelectable, setActivationEffectEnabled, setActiveItem, setCockpitTypeService, setDragAndDropWrapperService, setEffectBorderColor, setEffectDuration, setFocusedArea, setInfoBoxTimeout, setLabel, setMoveTargetX, setMoveTargetY, setSelectable, setTemplateList, setUid, setViewURI

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_ATTRIBUTES

public static final String INITIAL_ATTRIBUTES

See Also:

Constant Field Values

PROPERTY_DESCRIPTOR

public static final String PROPERTY_DESCRIPTOR

See Also:

Constant Field Values

DRAG_DROP_ID

public static final String DRAG_DROP_ID

See Also:

Constant Field Values

Constructor Detail

BaseUICockpitPerspective

public BaseUICockpitPerspective()

Method Detail

setUiConfigurationService

public void setUiConfigurationService(UIConfigurationService uiConfigurationService)

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

setEditorAreaTypes

public void setEditorAreaTypes(Set<EditorAreaTypeRule> typeRules)

onHide

public void onHide()

Specified by:

onHide in class AbstractUIPerspective

onShow

public void onShow()

Specified by:

onShow in class AbstractUIPerspective

resetOpenBrowserContainer

public void resetOpenBrowserContainer()

createItemInPopupEditor

public void createItemInPopupEditor(ObjectType type,
                                    Map<String,? extends Object> initialValues,
                                    CreateContext context)

createItemInPopupEditor

public void createItemInPopupEditor(ObjectType type,
                                    Map<String,? extends Object> initialValues,
                                    CreateContext context,
                                    boolean loadDefaultValues)

createItemInPopupEditor

@Deprecated
public void createItemInPopupEditor(ObjectType type,
                                                Map<String,? extends Object> initialValues,
                                                BrowserModel browser)

Deprecated.

createItemInPopupEditor

@Deprecated
public void createItemInPopupEditor(ObjectType type,
                                                Map<String,? extends Object> initialValues,
                                                BrowserModel browser,
                                                boolean loadDefaultValues)

Deprecated.

createItemInPopupEditor

@Deprecated
public void createItemInPopupEditor(ObjectType type,
                                                Map<String,? extends Object> initialValues,
                                                BrowserModel browser,
                                                boolean loadDefaultValues,
                                                boolean initialValidation)

Deprecated.

createItemInPopupEditor

protected void createItemInPopupEditor(ObjectType type,
                                       Map<String,? extends Object> initialValues,
                                       BrowserModel browser,
                                       CreateContext ctx,
                                       boolean loadDefaultValues,
                                       boolean initialValidation)

isPopupEditorOpen

public boolean isPopupEditorOpen()

closePopupEditor

public void closePopupEditor()

isActivatable

public boolean isActivatable(TypedObject item)

activateItemInPopupEditor

public void activateItemInPopupEditor(TypedObject activeItem)

activateItemInEditorArea

protected void activateItemInEditorArea(TypedObject activeItem)

activateItemInEditor

public final void activateItemInEditor(TypedObject activeItem)

getNavigationArea

public UINavigationArea getNavigationArea()

setNavigationArea

public void setNavigationArea(UINavigationArea navigationArea)

getBrowserArea

public UIBrowserArea getBrowserArea()

setBrowserArea

public void setBrowserArea(UIBrowserArea browserArea)

getEditorArea

public UIEditorArea getEditorArea()

setEditorArea

public void setEditorArea(UIEditorArea editorArea)

setCustomCsaURI

public void setCustomCsaURI(String customCsaURI)

getCustomCsaURI

public String getCustomCsaURI()

getNotifier

public NotifierZKComponent getNotifier()

setNotifier

public void setNotifier(NotifierZKComponent notifier)

setPopupEditorWindow

public void setPopupEditorWindow(Window popupEditorWindow)

initialize

public void initialize(Map<String,Object> params)

openReferenceCollectionInBrowserContext

public void openReferenceCollectionInBrowserContext(Collection<TypedObject> objects,
                                                    ObjectTemplate template,
                                                    TypedObject rootItem,
                                                    Map<String,? extends Object> parameters)

handleItemRemoved

public void handleItemRemoved(TypedObject object)

setBrowserAreaListener

public void setBrowserAreaListener(BrowserAreaListener browserAreaListener)

getBrowserAreaListener

protected BrowserAreaListener getBrowserAreaListener()

setEditorAreaListener

public void setEditorAreaListener(EditorAreaListener editorAreaListener)

getEditorAreaListener

protected EditorAreaListener getEditorAreaListener()

setNavigationAreaListener

public void setNavigationAreaListener(NavigationAreaListener navAreaListener)

getNavigationAreaListener

protected NavigationAreaListener getNavigationAreaListener()

setPopupEditorArea

public void setPopupEditorArea(UIEditorArea popupEditorArea)

getPopupEditorArea

public UIEditorArea getPopupEditorArea()

setEditorAreaComponent

public void setEditorAreaComponent(LayoutRegion editorAreaComponent)

getEditorAreaComponent

public LayoutRegion getEditorAreaComponent()

setNavigationAreaComponent

public void setNavigationAreaComponent(LayoutRegion navigationAreaComponent)

getNavigationAreaComponent

public LayoutRegion getNavigationAreaComponent()

expandEditorArea

public void expandEditorArea()

toggleNavAndEditArea

public void toggleNavAndEditArea()

expandEditorArea

public void expandEditorArea(boolean invalidate)

expandNavigationArea

public void expandNavigationArea()

collapseNavigationArea

public void collapseNavigationArea()

collapseEditorArea

public void collapseEditorArea()

update

public void update()

addCockpitEventAcceptor

public void addCockpitEventAcceptor(CockpitEventAcceptor acceptor)

removeCockpitEventAcceptor

public void removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)

onCockpitEvent

public void onCockpitEvent(CockpitEvent event)

createNewItem

public void createNewItem(ObjectTemplate template)

createNewItem

public void createNewItem(ObjectTemplate template,
                          Map<String,Object> initValues)

createNewItem

public void createNewItem(ObjectTemplate template,
                          Map<String,Object> initValues,
                          boolean loadDefaultValues)

createNewItem

public void createNewItem(ObjectTemplate template,
                          CreateContext createContext,
                          Map<String,Object> initValues,
                          boolean loadDefaultValues,
                          boolean expandEditorArea,
                          boolean popup)

Creates new item.

Parameters:

template - the template of new item to be created

createContext - the creation context, optional

initValues - initial values

loadDefaultValues - if true, default values will be preloaded

expandEditorArea - if true, editor area will be expanded

popup - if true, the creation dialog will be opened as a popup

createTemplateList

protected void createTemplateList(String baseType)

getTemplateList

protected List<TemplateListEntry> getTemplateList(String baseType)

generateCreateMenuitems

public boolean generateCreateMenuitems(Menupopup menupopup,
                                       boolean popup)

generateCreateMenuitems

public boolean generateCreateMenuitems(Menupopup menupopup,
                                       boolean expandEditorArea,
                                       CreateContext createContext,
                                       boolean popup,
                                       Map<String,Object> initValues,
                                       boolean loadDefaultValues)

Generates menu for creating new items.

Parameters:

menupopup - the menu component

expandEditorArea - if true, editor area will be expanded

createContext - the creation context, optional

popup - if true, the creation dialog will be opened as a popup

initValues - initial values

loadDefaultValues - if true, default values will be preloaded

Returns:

true, if menu has more than one entry, false otherwise

generateTemplateEntryList

public List<TemplateListEntry> generateTemplateEntryList(CreateContext createContext)

closeAreasIfOverlapped

public void closeAreasIfOverlapped()

canCreate

public boolean canCreate(TemplateListEntry entry)

setForceOpenInEditorArea

public void setForceOpenInEditorArea(boolean forceOpenInEditorArea)

isForceOpenInEditorArea

public boolean isForceOpenInEditorArea()