de.hybris.platform.cockpit.session.impl

Class EditorArea

java.lang.Object

de.hybris.platform.cockpit.session.impl.EditorArea

All Implemented Interfaces:

CockpitEventAcceptor, CockpitEventProducer, FocusablePerspectiveArea, UICockpitArea, UIComponent, UIEditorArea, UISessionListener

Direct Known Subclasses:

AdmincockpitEditorArea, ImportCockpitEditorArea, LiveEditCallbackEditorArea, PrintEditorArea

public class EditorArea
extends Object
implements UIEditorArea

Manages editor area content and events. Holds currently shown object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDITOR_AREA_CONFIG_CODE

Constructor Summary

Constructors

Constructor and Description
EditorArea()

Method Summary

Modifier and Type	Method and Description
void	addCockpitEventAcceptor(CockpitEventAcceptor acceptor)
void	addConstraintsPk(String constraintsPk)
void	addEditorAreaListener(EditorAreaListener editorAreaListener)
protected void	addMessage(SectionPanelModel panelModel, Exception exc)
protected void	addMissingMessage(Set<PropertyDescriptor> relatedProps)
void	afterLogin(UserModel user)
void	beforeLogout(UserModel user)
void	createModelFromContainer()
void	doBrowseItem()
void	doNextItem()
void	doOnChange(PropertyDescriptor propertyDescriptor)
void	doPreviousItem()
void	doSave()
void	fireBrowseItem(TypedObject currentObj)
protected void	fireCurrentObjectChanged(TypedObject prev, TypedObject newOne)
protected void	fireCurrentObjectUpdated(TypedObject item)
void	fireNextItem(TypedObject currentObj)
void	firePreviousItem(TypedObject currentObj)
protected void	fireValueChanged(ObjectValueContainer cont, PropertyDescriptor propertyDescriptor)
protected void	fireValuesStored(ObjectValueContainer cont)
protected void	fireValuesUpdated(ObjectValueContainer cont)
protected Map<LanguageModel,String>	getAllLabels(String labelLocKey)
EditorConfiguration	getConfiguration(String typecode)
List<String>	getConstraintsPk()
TypedObject	getCurrentObject()
ObjectType	getCurrentObjectType()
ObjectValueContainer	getCurrentObjectValues()
EditorAreaController	getEditorAreaController()
int	getItemStackSize()
String	getLabel()
protected Set<String>	getLoadLanguages()
protected Set<PropertyDescriptor>	getLoadPropertyDescriptors()
UICockpitPerspective	getManagingPerspective()
UICockpitPerspective	getPerspective()
SessionService	getsessionService()
SystemService	getSystemService()
EditorConfiguration	getTypeConfiguration()
TypeService	getTypeService()
protected UIConfigurationService	getUIConfigurationService()
UndoManager	getUndoManager()
Set<CockpitValidationDescriptor>	getValidationInfo()
ObjectValueHandlerRegistry	getValueHandlerRegistry()
protected ValueService	getValueService()
String	getViewURI()
String	getWidth()
void	globalDataLanguageChanged()
void	initialize(Map<String,Object> params)
boolean	isFocused()
void	onCockpitEvent(CockpitEvent event)
void	perspectiveChanged(UICockpitPerspective previous, UICockpitPerspective newOne)
void	removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)
void	removeEditorAreaListener(EditorAreaListener editorAreaListener)
void	reset()
void	resetStack()
void	restatusIgnoredDescriptors(ObjectValueContainer valueContainer, Set<CockpitValidationDescriptor> validationInfo)
void	revalidateForm()
void	setCockpitTypeService(TypeService typeService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCurrentObject(TypedObject object)
void	setCurrentObjectType(ObjectType currentObjectType)
void	setEditorAreaController(EditorAreaController editorAreaController)
void	setFocus(boolean focus)
void	setManagingPerspective(UICockpitPerspective managingPerspective)
void	setModelLocalizedValue(ItemModel model, String qualifier, String languageIso, Object value)
void	setModelSingleValue(ItemModel model, String qualifier, Object value)
void	setPerspective(UICockpitPerspective perspective)
void	setSessionService(SessionService sessionService)
void	setSystemService(SystemService systemService)
void	setUndoManager(UndoManager undoManager)
void	setValidationInfo(Set<CockpitValidationDescriptor> validationInfo)
void	setValueHandlerRegistry(ObjectValueHandlerRegistry valueHandlerRegistry)
void	setValueService(ValueService valueService)
void	setViewURI(String viewURI)
void	setWidth(String width)
void	update()
void	updateAllValues()
void	updateValues(Set<PropertyDescriptor> properties)
void	validateForm(Set<CockpitValidationDescriptor> validationInfo, TypedObject currentObject) Validates form.

Methods inherited from class java.lang.Object

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

Field Detail

EDITOR_AREA_CONFIG_CODE

public static final String EDITOR_AREA_CONFIG_CODE

See Also:

Constant Field Values

Constructor Detail

EditorArea

public EditorArea()

Method Detail

getValidationInfo

public Set<CockpitValidationDescriptor> getValidationInfo()

setValidationInfo

public void setValidationInfo(Set<CockpitValidationDescriptor> validationInfo)

getViewURI

public String getViewURI()

Specified by:

getViewURI in interface UIComponent

setViewURI

public void setViewURI(String viewURI)

afterLogin

public void afterLogin(UserModel user)

Specified by:

afterLogin in interface UISessionListener

beforeLogout

public void beforeLogout(UserModel user)

Specified by:

beforeLogout in interface UISessionListener

globalDataLanguageChanged

public void globalDataLanguageChanged()

Specified by:

globalDataLanguageChanged in interface UISessionListener

perspectiveChanged

public void perspectiveChanged(UICockpitPerspective previous,
                               UICockpitPerspective newOne)

Specified by:

perspectiveChanged in interface UISessionListener

getPerspective

public UICockpitPerspective getPerspective()

Specified by:

getPerspective in interface UICockpitArea

setPerspective

public void setPerspective(UICockpitPerspective perspective)

Specified by:

setPerspective in interface UICockpitArea

getValueHandlerRegistry

public ObjectValueHandlerRegistry getValueHandlerRegistry()

setValueHandlerRegistry

public void setValueHandlerRegistry(ObjectValueHandlerRegistry valueHandlerRegistry)

getSystemService

public SystemService getSystemService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

setSessionService

public void setSessionService(SessionService sessionService)

setSystemService

public void setSystemService(SystemService systemService)

getTypeService

public TypeService getTypeService()

setCockpitTypeService

public void setCockpitTypeService(TypeService typeService)

getUndoManager

public UndoManager getUndoManager()

setUndoManager

public void setUndoManager(UndoManager undoManager)

setValueService

public void setValueService(ValueService valueService)

getValueService

protected ValueService getValueService()

fireCurrentObjectUpdated

protected void fireCurrentObjectUpdated(TypedObject item)
                                 throws RuntimeException

Throws:

RuntimeException

fireCurrentObjectChanged

protected void fireCurrentObjectChanged(TypedObject prev,
                                        TypedObject newOne)
                                 throws RuntimeException

Throws:

RuntimeException

fireValuesStored

protected void fireValuesStored(ObjectValueContainer cont)

fireValuesUpdated

protected void fireValuesUpdated(ObjectValueContainer cont)

fireValueChanged

protected void fireValueChanged(ObjectValueContainer cont,
                                PropertyDescriptor propertyDescriptor)

addEditorAreaListener

public void addEditorAreaListener(EditorAreaListener editorAreaListener)

Specified by:

addEditorAreaListener in interface UIEditorArea

removeEditorAreaListener

public void removeEditorAreaListener(EditorAreaListener editorAreaListener)

Specified by:

removeEditorAreaListener in interface UIEditorArea

getCurrentObject

public TypedObject getCurrentObject()

Specified by:

getCurrentObject in interface UIEditorArea

getTypeConfiguration

public EditorConfiguration getTypeConfiguration()

Specified by:

getTypeConfiguration in interface UIEditorArea

getLoadPropertyDescriptors

protected Set<PropertyDescriptor> getLoadPropertyDescriptors()

getLoadLanguages

protected Set<String> getLoadLanguages()

setCurrentObject

public void setCurrentObject(TypedObject object)

Specified by:

setCurrentObject in interface UIEditorArea

setCurrentObjectType

public void setCurrentObjectType(ObjectType currentObjectType)

Specified by:

setCurrentObjectType in interface UIEditorArea

getCurrentObjectType

public ObjectType getCurrentObjectType()

Specified by:

getCurrentObjectType in interface UIEditorArea

updateAllValues

public void updateAllValues()

Specified by:

updateAllValues in interface UIEditorArea

updateValues

public void updateValues(Set<PropertyDescriptor> properties)

Specified by:

updateValues in interface UIEditorArea

getCurrentObjectValues

public ObjectValueContainer getCurrentObjectValues()

Specified by:

getCurrentObjectValues in interface UIEditorArea

setModelSingleValue

public void setModelSingleValue(ItemModel model,
                                String qualifier,
                                Object value)
                         throws AttributeNotSupportedException

Throws:

AttributeNotSupportedException

setModelLocalizedValue

public void setModelLocalizedValue(ItemModel model,
                                   String qualifier,
                                   String languageIso,
                                   Object value)
                            throws AttributeNotSupportedException

Throws:

AttributeNotSupportedException

doSave

public void doSave()

Specified by:

doSave in interface UIEditorArea

restatusIgnoredDescriptors

public void restatusIgnoredDescriptors(ObjectValueContainer valueContainer,
                                       Set<CockpitValidationDescriptor> validationInfo)

createModelFromContainer

public void createModelFromContainer()

validateForm

public void validateForm(Set<CockpitValidationDescriptor> validationInfo,
                         TypedObject currentObject)

Validates form.

Parameters:

validationInfo - the validation info

currentObject - the current object

addMissingMessage

protected void addMissingMessage(Set<PropertyDescriptor> relatedProps)

addMessage

protected void addMessage(SectionPanelModel panelModel,
                          Exception exc)

isFocused

public boolean isFocused()

Specified by:

isFocused in interface FocusablePerspectiveArea

setFocus

public void setFocus(boolean focus)

Specified by:

setFocus in interface FocusablePerspectiveArea

getManagingPerspective

public UICockpitPerspective getManagingPerspective()

Specified by:

getManagingPerspective in interface FocusablePerspectiveArea

Specified by:

getManagingPerspective in interface UIEditorArea

setManagingPerspective

public void setManagingPerspective(UICockpitPerspective managingPerspective)

Specified by:

setManagingPerspective in interface UIEditorArea

initialize

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

Specified by:

initialize in interface UICockpitArea

Specified by:

initialize in interface UIComponent

update

public void update()

Specified by:

update in interface UICockpitArea

fireNextItem

public void fireNextItem(TypedObject currentObj)

firePreviousItem

public void firePreviousItem(TypedObject currentObj)

fireBrowseItem

public void fireBrowseItem(TypedObject currentObj)

doNextItem

public void doNextItem()

Specified by:

doNextItem in interface UIEditorArea

doPreviousItem

public void doPreviousItem()

Specified by:

doPreviousItem in interface UIEditorArea

doBrowseItem

public void doBrowseItem()

Specified by:

doBrowseItem in interface UIEditorArea

doOnChange

public void doOnChange(PropertyDescriptor propertyDescriptor)

Specified by:

doOnChange in interface UIEditorArea

reset

public void reset()

Specified by:

reset in interface UIEditorArea

getConfiguration

public EditorConfiguration getConfiguration(String typecode)

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

getAllLabels

protected Map<LanguageModel,String> getAllLabels(String labelLocKey)

getEditorAreaController

public EditorAreaController getEditorAreaController()

Specified by:

getEditorAreaController in interface UIEditorArea

setEditorAreaController

public void setEditorAreaController(EditorAreaController editorAreaController)

addCockpitEventAcceptor

public void addCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Specified by:

addCockpitEventAcceptor in interface CockpitEventProducer

removeCockpitEventAcceptor

public void removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Specified by:

removeCockpitEventAcceptor in interface CockpitEventProducer

onCockpitEvent

public void onCockpitEvent(CockpitEvent event)

Specified by:

onCockpitEvent in interface CockpitEventAcceptor

revalidateForm

public void revalidateForm()

resetStack

public void resetStack()

getLabel

public String getLabel()

Specified by:

getLabel in interface UIComponent

getWidth

public String getWidth()

Specified by:

getWidth in interface UIEditorArea

setWidth

public void setWidth(String width)

Specified by:

setWidth in interface UIEditorArea

getConstraintsPk

public List<String> getConstraintsPk()

Returns:

the constraintsPk

addConstraintsPk

public void addConstraintsPk(String constraintsPk)

getsessionService

public SessionService getsessionService()

getItemStackSize

public int getItemStackSize()