Package com.hybris.cockpitng.widgets.baseeditorarea

Class DefaultEditorAreaController

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.ViewAnnotationAwareComposer

com.hybris.cockpitng.util.DefaultWidgetController

com.hybris.cockpitng.widgets.baseeditorarea.DefaultEditorAreaController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, WidgetVisibilityStateAware, java.io.Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class DefaultEditorAreaController
extends DefaultWidgetController
implements WidgetVisibilityStateAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ACTION_SLOT_COMPONENT_ID
static java.lang.String	COCKPIT_EVENT_CALLBACK_MANAGER	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected static java.lang.String	COMP_ID_ACTION_SLOT
protected static java.lang.String	COMP_ID_ATTRIBUTES_DIV
protected static java.lang.String	COMP_ID_CANCEL_BTN
protected static java.lang.String	COMP_ID_SAVE_BTN
protected static java.lang.String	COMP_ID_VIEW_BTN
static java.lang.String	EDITOR_AREA_CONFIGURATION
static java.lang.String	EDITOR_AREA_WIDTH_REQUEST
static int	FLUID_MAX_WIDTH
static int	FLUID_MIN_WIDTH
static java.lang.String	GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED
protected static java.lang.String	ITEM_VALIDATION_ERROR_MSG	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected static java.lang.String	ITEM_VALIDATION_WARNING_MSG	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	MODEL_ALL_REFERENCED_OBJECTS	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	MODEL_CURRENT_OBJECT
static java.lang.String	MODEL_CURRENT_OBJECT_TYPE
static java.lang.String	MODEL_EDITOR_AREA_CONFIG_CTX
static java.lang.String	MODEL_EDITOR_INPUT_DATA
static java.lang.String	MODEL_FAILURE_NOTIFICATION_ID	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
protected static java.lang.String	MODEL_FLUID_VIEW_MODE
static java.lang.String	MODEL_INPUT_OBJECT_IS_MODIFIED
static java.lang.String	MODEL_INPUT_OBJECT_IS_NEW
static java.lang.String	MODEL_LAST_PINNED_TAB
static java.lang.String	MODEL_SUCCESS_NOTIFICATION_ID	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	MODEL_VALUE_CHANGED
static java.lang.String	ON_EDITORS_DETACHED	Event fired after editors components are detached from EditorArea UI
static java.lang.String	RESPONSIVE_IMAGE_URL
static java.lang.String	RESPONSIVE_IMAGE_URL_HOVER
static java.lang.String	SELECTOR_STATIC_SECTION_SLOT
protected static java.lang.String	SETTING_CONFIGURATION_CONTEXT
static java.lang.String	SETTING_DISABLE_RESET_FOR_MODIFIED_INPUT_OBJECT
protected static java.lang.String	SETTING_ESSENTIALS_IN_OVERVIEW_TAB
protected static java.lang.String	SETTING_FLUID_VIEW_CODE
static java.lang.String	SETTING_MOLD_ACCORDION
protected static java.lang.String	SETTING_TITLE_BY_CTX
static java.lang.String	SOCKET_INPUT_FOCUS
static java.lang.String	SOCKET_INPUT_OBJECT
static java.lang.String	SOCKET_INPUT_RESET
static java.lang.String	SOCKET_INPUT_RESIZE
static java.lang.String	SOCKET_OUTPUT_OBJECT_SAVED
static java.lang.String	SOCKET_OUTPUT_WIDGET_TITLE
static java.lang.String	STATIC_IMAGE_URL
static java.lang.String	STATIC_IMAGE_URL_HOVER
static java.lang.String	USER_NOTIFICATION_CURRENT_ENTITY_AUTOSAVED	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	VALIDATION_PATH_PREFIX	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
static java.lang.String	YW_STATIC_SECTION_ACTIVE
static java.lang.String	YW_STATIC_SECTION_INACTIVE

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor	Description
DefaultEditorAreaController()

Method Summary

Modifier and Type	Method	Description
protected DataType	adjustCurrentType(java.lang.Object currentObject)
protected void	adjustValueState(boolean inputObjectIsModified, boolean inputObjectIsNew)
protected void	applySclassAccordingToWidth(org.zkoss.zk.ui.HtmlBasedComponent targetComponent, int width)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7, use DefaultEditorAreaControllerComponentsSizeDelegate.applySclassAccordingToWidth(int) insted.
void	cancelObjectModification()
protected ValidationContext	createValidationContext(boolean applyConfirmed)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 not used, see DefaultEditorAreaControllerValidationPopupDelegate
protected EditorArea	decorateConfigWithOverviewTab(EditorArea config)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 don't need any more see DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)
protected ValidationResult	doValidate(java.lang.Object objectToValidate, boolean preventBroadcast)
protected ValidationResult	doValidate(java.lang.Object objectToValidate, boolean preventBroadcast, boolean applyConfirmed)
protected void	executeSaveWithConfirmation(Executable save)
protected Widgetslot	findStaticSectionSlot()
void	focusAttribute(FocusRequest focusRequest)
protected void	focusAttribute(java.lang.String qualifier)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerValidationPopupDelegate.focusAttribute(String) instead.
protected java.lang.String	formatSClass(java.lang.String sclass)
Actions	getActionSlot()
org.zkoss.zul.Div	getAttributesDiv()
org.zkoss.zul.Vlayout	getBody()
org.zkoss.zul.Button	getCancelButton()
protected CockpitLocaleService	getCockpitLocaleService()
protected DefaultEditorAreaControllerComponentsSizeDelegate	getComponentsSizeDelegate()
DefaultEditorAreaControllerConcurrentModificationDelegate	getConcurrentModificationDelegate()
protected DefaultEditorAreaControllerConfigurationLoader	getConfigurationLoader()
protected java.lang.String	getCRUDNotificationSource()
protected java.lang.String	getCurrentContext()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getCurrentContext() instead.
protected java.lang.Object	getCurrentObject()
protected ValidationResult	getCurrentValidationResult()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getCurrentValidationResult()
protected java.lang.String	getDefaultContext()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getDefaultContext() instead.
protected EditorArea	getEditorAreaConfiguration()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration()
protected EditorArea	getEditorAreaConfiguration(java.lang.String componentContext)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)
protected WidgetComponentRenderer<org.zkoss.zk.ui.Component,EditorArea,java.lang.Object>	getEditorAreaRenderer()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
org.zkoss.zul.Label	getEditorAreaTitle()
protected DefaultEditorAreaControllerFluidModeSwitcherDelegate	getFluidModeSwitcherDelegate()
protected java.lang.String	getFluidViewModeCode()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.getFluidViewModeCode().
protected LabelService	getLabelService()
protected EditorAreaLogicHandler	getLogicHandler()
protected DefaultEditorAreaControllerModelOperationsDelegate	getModelOperationsDelegate()
protected NotificationService	getNotificationService()
protected java.lang.String	getNotificationSource()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7, use NotificationService.getWidgetNotificationSource(com.hybris.cockpitng.engine.WidgetInstanceManager) instead.
protected ObjectFacade	getObjectFacade()
protected DefaultEditorAreaControllerPersistenceListenersDelegate	getPersistenceListeners()
ReferenceModelProperties	getReferenceModelProperties()
protected NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,EditorArea,java.lang.Object>	getRenderer()
org.zkoss.zul.Button	getSaveButton()
protected DefaultEditorAreaControllerSettingsLoader	getSettingsLoader()
protected EditorArea	getStoredEditorAreaConfiguration()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration()
protected java.lang.String	getSuccessNotificationId()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6
org.zkoss.zk.ui.Component	getToolbarContainer()
protected TypeFacade	getTypeFacade()
protected DefaultEditorAreaControllerValidationPopupDelegate	getValidationPopupDelegate()
ValidationRenderer	getValidationRenderer()
org.zkoss.zul.Window	getValidationResults()
org.zkoss.zul.Toolbarbutton	getViewModeButton()
protected DefaultEditorAreaControllerWidgetTitleDelegate	getWidgetTitleDelegate()
void	handleObjectDeletedEvent(CockpitEvent event)	Object deleted global event handler. Checks if deleted object is equal to current object or if it's referenced by any editor within the editor area.
protected void	handleObjectSavingException(ObjectSavingException savingException)	The default implementation just notifies the user via NotificationService.notifyUser(String, String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level, Object...).
protected void	handleObjectSavingSuccess(java.lang.Object savedObject)	The default implementation just notifies user via NotificationService.notifyUser(String, String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level, Object...).
void	handleObjectUpdatedEvent(CockpitEvent event)	Object updated global event handler. Default implementation checks if deleted object is referenced by any editor within the editor area, and if it is, the corresponding editors are reloaded.
void	handleResizeBrowser(CockpitEvent event)
void	handleResizeParent()
void	handleViewModeButtonClick(org.zkoss.zk.ui.event.Event event)
void	handleVisibilityState(WidgetVisibilityState state)	Handles state visibility widget state.
protected void	initConfigCtx()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.initContext() instead.
void	initialize(org.zkoss.zk.ui.Component comp)	Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
protected boolean	inputDataAlreadySet(java.lang.Object inputData)
protected boolean	isFluidViewMode()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.isFluidViewMode().
protected boolean	isModelValueChanged()
void	itemLockingChanged(CockpitEvent event)
protected EditorArea	loadEditorAreaConfiguration(java.lang.String typeCode, java.lang.String component)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)
protected EditorArea	lookupEditorAreaConfiguration(DataType dataType, java.lang.String componentContext)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)
protected EditorAreaLogicHandler	lookupEditorAreaLogicHandler(EditorArea editorArea)
protected void	notifyAfterSaveListeners()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerPersistenceListenersDelegate.notifyAfterSaveListeners()
void	onActionPerformed(org.zkoss.zk.ui.event.Event event)
void	onParentWidthRequest(org.zkoss.zk.ui.event.Event event)
protected void	onTypeChanged()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.onTypeChange(DataType)
protected java.lang.Object	performRefresh(java.lang.Object currentObject, EditorArea editorArea)
protected java.lang.Object	performSave(java.lang.Object currentObject, EditorArea editorArea)
protected void	populateEventContext(Context source, DefaultCockpitEvent destination)
protected void	prepareValidationResultModel()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 dont store configuration in model, use DefaultEditorAreaControllerModelOperationsDelegate.prepareValidationResultModel()
protected void	prepareValidationResultsPopup(org.zkoss.zk.ui.Component parent)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 dont store configuration in model, use DefaultEditorAreaControllerValidationPopupDelegate.prepareValidationResultsPopup(Component, Executable)
protected void	prepareViewModeButton()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.isFluidViewMode().
protected java.lang.Object	reloadIfNecessary(java.lang.Object objectInput, boolean inputObjectIsModified, boolean inputObjectIsNew)
void	reset()	Resets widget to initial state, displaying no data.
protected java.lang.String	resolveEditorAreaLogicHandler(EditorArea editorArea)
void	saveObject()
protected void	saveObjectInternal()
protected void	sendEditorsDetachedEvent()
protected void	setComponentsSizeDelegate(DefaultEditorAreaControllerComponentsSizeDelegate componentsSizeDelegate)
void	setConcurrentModificationDelegate(DefaultEditorAreaControllerConcurrentModificationDelegate concurrentModificationDelegate)
protected void	setConfigurationLoader(DefaultEditorAreaControllerConfigurationLoader configurationLoader)
protected void	setCurrentContext(java.lang.String configCtx)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.setCurrentContext(String) instead.
protected void	setFluidModeSwitcherDelegate(DefaultEditorAreaControllerFluidModeSwitcherDelegate fluidModeSwitcherDelegate)
protected void	setModelOperationsDelegate(DefaultEditorAreaControllerModelOperationsDelegate modelOperationsDelegate)
void	setObject(java.lang.Object inputData)
protected void	setObjectInternal(java.lang.Object inputData)
protected void	setPersistenceListeners(DefaultEditorAreaControllerPersistenceListenersDelegate persistenceListeners)
void	setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)
protected void	setSettingsLoader(DefaultEditorAreaControllerSettingsLoader settingsLoader)
protected void	setValidationPopupDelegate(DefaultEditorAreaControllerValidationPopupDelegate validationPopupDelegate)
protected void	setWidgetTitleByCtxName()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 not used, see DefaultEditorAreaControllerWidgetTitleDelegate.setWidgetTitleByCtxName().
protected void	setWidgetTitleDelegate(DefaultEditorAreaControllerWidgetTitleDelegate widgetTitleDelegate)
protected void	showAllAttributes(DataType dataType)
protected boolean	showLinksInNotifications()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.6 - not used
protected void	updateWidgetTitle()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 use DefaultEditorAreaControllerWidgetTitleDelegate.updateWidgetTitle() instead.

Methods inherited from class com.hybris.cockpitng.util.DefaultWidgetController

doAfterCompose, doBeforeCompose, doBeforeComposeChildren, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, getValue, getWidgetDragAndDropStrategyRepository, getWidgetInstanceManager, getWidgetRoot, getWidgetSettings, getWidgetslot, getWidgetTitle, getWidgetUtils, initDragAndDropAwareness, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, invokeListenerMethod, onSocketInput, preInitialize, sendOutput, sendOutputAfterOperation, sendOutputAfterOperation, sendOutputAfterOperation, setValue, setWidgetInstanceManager, setWidgetTitle

Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer

scanEventListeners

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Field Detail

ON_EDITORS_DETACHED

public static final java.lang.String ON_EDITORS_DETACHED

Event fired after editors components are detached from EditorArea UI

See Also:

Constant Field Values

MODEL_LAST_PINNED_TAB

public static final java.lang.String MODEL_LAST_PINNED_TAB

See Also:

Constant Field Values

MODEL_CURRENT_OBJECT

public static final java.lang.String MODEL_CURRENT_OBJECT

See Also:

Constant Field Values

MODEL_CURRENT_OBJECT_TYPE

public static final java.lang.String MODEL_CURRENT_OBJECT_TYPE

See Also:

Constant Field Values

MODEL_ALL_REFERENCED_OBJECTS

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String MODEL_ALL_REFERENCED_OBJECTS

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

DefaultReferenceModelProperties.MODEL_ALL_REFERENCED_OBJECTS, Constant Field Values

MODEL_VALUE_CHANGED

public static final java.lang.String MODEL_VALUE_CHANGED

See Also:

Constant Field Values

VALIDATION_PATH_PREFIX

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String VALIDATION_PATH_PREFIX

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

SOCKET_INPUT_RESIZE

public static final java.lang.String SOCKET_INPUT_RESIZE

See Also:

Constant Field Values

SOCKET_INPUT_OBJECT

public static final java.lang.String SOCKET_INPUT_OBJECT

See Also:

Constant Field Values

SOCKET_INPUT_RESET

public static final java.lang.String SOCKET_INPUT_RESET

See Also:

Constant Field Values

SOCKET_INPUT_FOCUS

public static final java.lang.String SOCKET_INPUT_FOCUS

See Also:

Constant Field Values

SOCKET_OUTPUT_WIDGET_TITLE

public static final java.lang.String SOCKET_OUTPUT_WIDGET_TITLE

See Also:

Constant Field Values

SOCKET_OUTPUT_OBJECT_SAVED

public static final java.lang.String SOCKET_OUTPUT_OBJECT_SAVED

See Also:

Constant Field Values

EDITOR_AREA_CONFIGURATION

public static final java.lang.String EDITOR_AREA_CONFIGURATION

See Also:

Constant Field Values

EDITOR_AREA_WIDTH_REQUEST

public static final java.lang.String EDITOR_AREA_WIDTH_REQUEST

See Also:

Constant Field Values

RESPONSIVE_IMAGE_URL

public static final java.lang.String RESPONSIVE_IMAGE_URL

See Also:

Constant Field Values

STATIC_IMAGE_URL

public static final java.lang.String STATIC_IMAGE_URL

See Also:

Constant Field Values

RESPONSIVE_IMAGE_URL_HOVER

public static final java.lang.String RESPONSIVE_IMAGE_URL_HOVER

See Also:

Constant Field Values

STATIC_IMAGE_URL_HOVER

public static final java.lang.String STATIC_IMAGE_URL_HOVER

See Also:

Constant Field Values

MODEL_INPUT_OBJECT_IS_NEW

public static final java.lang.String MODEL_INPUT_OBJECT_IS_NEW

See Also:

Constant Field Values

MODEL_INPUT_OBJECT_IS_MODIFIED

public static final java.lang.String MODEL_INPUT_OBJECT_IS_MODIFIED

See Also:

Constant Field Values

MODEL_SUCCESS_NOTIFICATION_ID

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String MODEL_SUCCESS_NOTIFICATION_ID

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

MODEL_FAILURE_NOTIFICATION_ID

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String MODEL_FAILURE_NOTIFICATION_ID

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

MODEL_EDITOR_AREA_CONFIG_CTX

public static final java.lang.String MODEL_EDITOR_AREA_CONFIG_CTX

See Also:

Constant Field Values

MODEL_EDITOR_INPUT_DATA

public static final java.lang.String MODEL_EDITOR_INPUT_DATA

See Also:

Constant Field Values

SETTING_DISABLE_RESET_FOR_MODIFIED_INPUT_OBJECT

public static final java.lang.String SETTING_DISABLE_RESET_FOR_MODIFIED_INPUT_OBJECT

See Also:

Constant Field Values

SETTING_MOLD_ACCORDION

public static final java.lang.String SETTING_MOLD_ACCORDION

See Also:

Constant Field Values

COCKPIT_EVENT_CALLBACK_MANAGER

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String COCKPIT_EVENT_CALLBACK_MANAGER

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

USER_NOTIFICATION_CURRENT_ENTITY_AUTOSAVED

@Deprecated(since="6.6",
            forRemoval=true)
public static final java.lang.String USER_NOTIFICATION_CURRENT_ENTITY_AUTOSAVED

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

SELECTOR_STATIC_SECTION_SLOT

public static final java.lang.String SELECTOR_STATIC_SECTION_SLOT

See Also:

Constant Field Values

YW_STATIC_SECTION_ACTIVE

public static final java.lang.String YW_STATIC_SECTION_ACTIVE

See Also:

Constant Field Values

YW_STATIC_SECTION_INACTIVE

public static final java.lang.String YW_STATIC_SECTION_INACTIVE

See Also:

Constant Field Values

FLUID_MIN_WIDTH

public static final int FLUID_MIN_WIDTH

See Also:

Constant Field Values

FLUID_MAX_WIDTH

public static final int FLUID_MAX_WIDTH

See Also:

Constant Field Values

GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED

public static final java.lang.String GLOBAL_EVENT_ITEM_LOCKED_STATE_CHANGED

See Also:

Constant Field Values

ITEM_VALIDATION_ERROR_MSG

@Deprecated(since="6.6",
            forRemoval=true)
protected static final java.lang.String ITEM_VALIDATION_ERROR_MSG

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

ITEM_VALIDATION_WARNING_MSG

@Deprecated(since="6.6",
            forRemoval=true)
protected static final java.lang.String ITEM_VALIDATION_WARNING_MSG

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

See Also:

Constant Field Values

COMP_ID_SAVE_BTN

protected static final java.lang.String COMP_ID_SAVE_BTN

See Also:

Constant Field Values

COMP_ID_CANCEL_BTN

protected static final java.lang.String COMP_ID_CANCEL_BTN

See Also:

Constant Field Values

COMP_ID_VIEW_BTN

protected static final java.lang.String COMP_ID_VIEW_BTN

See Also:

Constant Field Values

COMP_ID_ATTRIBUTES_DIV

protected static final java.lang.String COMP_ID_ATTRIBUTES_DIV

See Also:

Constant Field Values

COMP_ID_ACTION_SLOT

protected static final java.lang.String COMP_ID_ACTION_SLOT

See Also:

Constant Field Values

MODEL_FLUID_VIEW_MODE

protected static final java.lang.String MODEL_FLUID_VIEW_MODE

See Also:

Constant Field Values

ACTION_SLOT_COMPONENT_ID

protected static final java.lang.String ACTION_SLOT_COMPONENT_ID

See Also:

Constant Field Values

SETTING_CONFIGURATION_CONTEXT

protected static final java.lang.String SETTING_CONFIGURATION_CONTEXT

See Also:

Constant Field Values

SETTING_FLUID_VIEW_CODE

protected static final java.lang.String SETTING_FLUID_VIEW_CODE

See Also:

Constant Field Values

SETTING_ESSENTIALS_IN_OVERVIEW_TAB

protected static final java.lang.String SETTING_ESSENTIALS_IN_OVERVIEW_TAB

See Also:

Constant Field Values

SETTING_TITLE_BY_CTX

protected static final java.lang.String SETTING_TITLE_BY_CTX

See Also:

Constant Field Values

Constructor Detail

DefaultEditorAreaController

public DefaultEditorAreaController()

Method Detail

initialize

public void initialize(org.zkoss.zk.ui.Component comp)

Description copied from class: DefaultWidgetController

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by DefaultWidgetController.doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

Overrides:

initialize in class DefaultWidgetController

handleVisibilityState

public void handleVisibilityState(WidgetVisibilityState state)

Description copied from interface: WidgetVisibilityStateAware

Handles state visibility widget state.

Specified by:

handleVisibilityState in interface WidgetVisibilityStateAware

Parameters:

state - name of widget state. f.e.: #VISIBLE

onParentWidthRequest

public void onParentWidthRequest(org.zkoss.zk.ui.event.Event event)

onActionPerformed

public void onActionPerformed(org.zkoss.zk.ui.event.Event event)

handleViewModeButtonClick

public void handleViewModeButtonClick(org.zkoss.zk.ui.event.Event event)
                               throws TypeNotFoundException

Throws:

TypeNotFoundException

saveObject

public void saveObject()

cancelObjectModification

public void cancelObjectModification()

handleResizeParent

public void handleResizeParent()

focusAttribute

public void focusAttribute(FocusRequest focusRequest)

focusAttribute

@Deprecated(since="6.7",
            forRemoval=true)
protected void focusAttribute(java.lang.String qualifier)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerValidationPopupDelegate.focusAttribute(String) instead.

reset

public void reset()

Resets widget to initial state, displaying no data.

setObject

public void setObject(java.lang.Object inputData)

setObjectInternal

protected void setObjectInternal(java.lang.Object inputData)

inputDataAlreadySet

protected boolean inputDataAlreadySet(java.lang.Object inputData)

adjustCurrentType

protected DataType adjustCurrentType(java.lang.Object currentObject)

reloadIfNecessary

protected java.lang.Object reloadIfNecessary(java.lang.Object objectInput,
                                             boolean inputObjectIsModified,
                                             boolean inputObjectIsNew)
                                      throws ObjectNotFoundException

Throws:

ObjectNotFoundException

adjustValueState

protected void adjustValueState(boolean inputObjectIsModified,
                                boolean inputObjectIsNew)

handleResizeBrowser

public void handleResizeBrowser(CockpitEvent event)

itemLockingChanged

public void itemLockingChanged(CockpitEvent event)

handleObjectDeletedEvent

public void handleObjectDeletedEvent(CockpitEvent event)

Object deleted global event handler.
Checks if deleted object is equal to current object or if it's referenced by any editor within the editor area. If it's equal to current one, null is set as new current. If it's referenced, the corresponding editors are reloaded.

Parameters:

event - delete event

handleObjectUpdatedEvent

public void handleObjectUpdatedEvent(CockpitEvent event)

Object updated global event handler.
Default implementation checks if deleted object is referenced by any editor within the editor area, and if it is, the corresponding editors are reloaded.

Parameters:

event - update event

updateWidgetTitle

@Deprecated(since="6.7",
            forRemoval=true)
protected void updateWidgetTitle()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerWidgetTitleDelegate.updateWidgetTitle() instead.

applySclassAccordingToWidth

@Deprecated(since="6.7",
            forRemoval=true)
protected void applySclassAccordingToWidth(org.zkoss.zk.ui.HtmlBasedComponent targetComponent,
                                           int width)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7, use DefaultEditorAreaControllerComponentsSizeDelegate.applySclassAccordingToWidth(int) insted.

showLinksInNotifications

@Deprecated(since="6.6",
            forRemoval=true)
protected boolean showLinksInNotifications()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6 - not used

initConfigCtx

@Deprecated(since="6.7",
            forRemoval=true)
protected void initConfigCtx()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.initContext() instead.

prepareViewModeButton

@Deprecated(since="6.7",
            forRemoval=true)
protected void prepareViewModeButton()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.isFluidViewMode().

createValidationContext

@Deprecated(since="6.7",
            forRemoval=true)
protected ValidationContext createValidationContext(boolean applyConfirmed)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 not used, see DefaultEditorAreaControllerValidationPopupDelegate

doValidate

protected ValidationResult doValidate(java.lang.Object objectToValidate,
                                      boolean preventBroadcast)

doValidate

protected ValidationResult doValidate(java.lang.Object objectToValidate,
                                      boolean preventBroadcast,
                                      boolean applyConfirmed)

saveObjectInternal

protected void saveObjectInternal()

performRefresh

protected java.lang.Object performRefresh(java.lang.Object currentObject,
                                          EditorArea editorArea)
                                   throws ObjectNotFoundException

Throws:

ObjectNotFoundException

performSave

protected java.lang.Object performSave(java.lang.Object currentObject,
                                       EditorArea editorArea)
                                throws ObjectSavingException

Throws:

ObjectSavingException

executeSaveWithConfirmation

protected void executeSaveWithConfirmation(Executable save)

getStoredEditorAreaConfiguration

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea getStoredEditorAreaConfiguration()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration()

lookupEditorAreaLogicHandler

protected EditorAreaLogicHandler lookupEditorAreaLogicHandler(EditorArea editorArea)

resolveEditorAreaLogicHandler

protected java.lang.String resolveEditorAreaLogicHandler(EditorArea editorArea)

prepareValidationResultModel

@Deprecated(since="6.7",
            forRemoval=true)
protected void prepareValidationResultModel()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 dont store configuration in model, use DefaultEditorAreaControllerModelOperationsDelegate.prepareValidationResultModel()

prepareValidationResultsPopup

@Deprecated(since="6.7",
            forRemoval=true)
protected void prepareValidationResultsPopup(org.zkoss.zk.ui.Component parent)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 dont store configuration in model, use DefaultEditorAreaControllerValidationPopupDelegate.prepareValidationResultsPopup(Component, Executable)

isModelValueChanged

protected boolean isModelValueChanged()

getCRUDNotificationSource

protected java.lang.String getCRUDNotificationSource()

populateEventContext

protected void populateEventContext(Context source,
                                    DefaultCockpitEvent destination)

handleObjectSavingSuccess

protected void handleObjectSavingSuccess(java.lang.Object savedObject)

The default implementation just notifies user via NotificationService.notifyUser(String, String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level, Object...).

Parameters:

savedObject - the item that has been successfully saved.

handleObjectSavingException

protected void handleObjectSavingException(ObjectSavingException savingException)

The default implementation just notifies the user via NotificationService.notifyUser(String, String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level, Object...).

Parameters:

savingException - the exception to handle.

getNotificationSource

@Deprecated(since="6.7",
            forRemoval=true)
protected java.lang.String getNotificationSource()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7, use NotificationService.getWidgetNotificationSource(com.hybris.cockpitng.engine.WidgetInstanceManager) instead.

getSuccessNotificationId

@Deprecated(since="6.6",
            forRemoval=true)
protected java.lang.String getSuccessNotificationId()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.6

notifyAfterSaveListeners

@Deprecated(since="6.7",
            forRemoval=true)
protected void notifyAfterSaveListeners()
                                 throws ObjectSavingException

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerPersistenceListenersDelegate.notifyAfterSaveListeners()

Throws:

ObjectSavingException

formatSClass

protected java.lang.String formatSClass(java.lang.String sclass)

getCurrentObject

protected java.lang.Object getCurrentObject()

getCurrentValidationResult

@Deprecated(since="6.7",
            forRemoval=true)
protected ValidationResult getCurrentValidationResult()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getCurrentValidationResult()

onTypeChanged

@Deprecated(since="6.7",
            forRemoval=true)
protected void onTypeChanged()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.onTypeChange(DataType)

sendEditorsDetachedEvent

protected void sendEditorsDetachedEvent()

findStaticSectionSlot

protected Widgetslot findStaticSectionSlot()

getEditorAreaConfiguration

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea getEditorAreaConfiguration()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration()

getEditorAreaConfiguration

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea getEditorAreaConfiguration(java.lang.String componentContext)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)

lookupEditorAreaConfiguration

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea lookupEditorAreaConfiguration(DataType dataType,
                                                   java.lang.String componentContext)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)

setWidgetTitleByCtxName

@Deprecated(since="6.7",
            forRemoval=true)
protected void setWidgetTitleByCtxName()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 not used, see DefaultEditorAreaControllerWidgetTitleDelegate.setWidgetTitleByCtxName().

loadEditorAreaConfiguration

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea loadEditorAreaConfiguration(java.lang.String typeCode,
                                                 java.lang.String component)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)

Loads the (editor-area) UI configuration for the provided type with code typeCode.

Parameters:

typeCode - type code

component - component code

Returns:

the column UI configuration

decorateConfigWithOverviewTab

@Deprecated(since="6.7",
            forRemoval=true)
protected EditorArea decorateConfigWithOverviewTab(EditorArea config)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 don't need any more see DefaultEditorAreaControllerConfigurationLoader.getEditorAreaConfiguration(String, String)

showAllAttributes

protected void showAllAttributes(DataType dataType)

getCurrentContext

@Deprecated(since="6.7",
            forRemoval=true)
protected java.lang.String getCurrentContext()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getCurrentContext() instead.

setCurrentContext

@Deprecated(since="6.7",
            forRemoval=true)
protected void setCurrentContext(java.lang.String configCtx)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.setCurrentContext(String) instead.

getDefaultContext

@Deprecated(since="6.7",
            forRemoval=true)
protected java.lang.String getDefaultContext()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 use DefaultEditorAreaControllerModelOperationsDelegate.getDefaultContext() instead.

getObjectFacade

protected ObjectFacade getObjectFacade()

getTypeFacade

protected TypeFacade getTypeFacade()

getLabelService

protected LabelService getLabelService()

getCockpitLocaleService

protected CockpitLocaleService getCockpitLocaleService()

getRenderer

protected NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,EditorArea,java.lang.Object> getRenderer()

getEditorAreaRenderer

@Deprecated(since="6.5",
            forRemoval=true)
protected WidgetComponentRenderer<org.zkoss.zk.ui.Component,EditorArea,java.lang.Object> getEditorAreaRenderer()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

Returns:

the editorAreaRenderer

See Also:

getRenderer()

getFluidViewModeCode

@Deprecated(since="6.7",
            forRemoval=true)
protected java.lang.String getFluidViewModeCode()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.getFluidViewModeCode().

isFluidViewMode

@Deprecated(since="6.7",
            forRemoval=true)
protected boolean isFluidViewMode()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 not used, see DefaultEditorAreaControllerModelOperationsDelegate.isFluidViewMode().

getBody

public org.zkoss.zul.Vlayout getBody()

getSaveButton

public org.zkoss.zul.Button getSaveButton()

getCancelButton

public org.zkoss.zul.Button getCancelButton()

getViewModeButton

public org.zkoss.zul.Toolbarbutton getViewModeButton()

getAttributesDiv

public org.zkoss.zul.Div getAttributesDiv()

getToolbarContainer

public org.zkoss.zk.ui.Component getToolbarContainer()

getActionSlot

public Actions getActionSlot()

getEditorAreaTitle

public org.zkoss.zul.Label getEditorAreaTitle()

getValidationResults

public org.zkoss.zul.Window getValidationResults()

getValidationRenderer

public ValidationRenderer getValidationRenderer()

getReferenceModelProperties

public ReferenceModelProperties getReferenceModelProperties()

setReferenceModelProperties

public void setReferenceModelProperties(ReferenceModelProperties referenceModelProperties)

getNotificationService

protected NotificationService getNotificationService()

getLogicHandler

protected EditorAreaLogicHandler getLogicHandler()

getSettingsLoader

protected DefaultEditorAreaControllerSettingsLoader getSettingsLoader()

setSettingsLoader

protected void setSettingsLoader(DefaultEditorAreaControllerSettingsLoader settingsLoader)

getConfigurationLoader

protected DefaultEditorAreaControllerConfigurationLoader getConfigurationLoader()

setConfigurationLoader

protected void setConfigurationLoader(DefaultEditorAreaControllerConfigurationLoader configurationLoader)

getFluidModeSwitcherDelegate

protected DefaultEditorAreaControllerFluidModeSwitcherDelegate getFluidModeSwitcherDelegate()

setFluidModeSwitcherDelegate

protected void setFluidModeSwitcherDelegate(DefaultEditorAreaControllerFluidModeSwitcherDelegate fluidModeSwitcherDelegate)

getModelOperationsDelegate

protected DefaultEditorAreaControllerModelOperationsDelegate getModelOperationsDelegate()

setModelOperationsDelegate

protected void setModelOperationsDelegate(DefaultEditorAreaControllerModelOperationsDelegate modelOperationsDelegate)

getPersistenceListeners

protected DefaultEditorAreaControllerPersistenceListenersDelegate getPersistenceListeners()

setPersistenceListeners

protected void setPersistenceListeners(DefaultEditorAreaControllerPersistenceListenersDelegate persistenceListeners)

getComponentsSizeDelegate

protected DefaultEditorAreaControllerComponentsSizeDelegate getComponentsSizeDelegate()

setComponentsSizeDelegate

protected void setComponentsSizeDelegate(DefaultEditorAreaControllerComponentsSizeDelegate componentsSizeDelegate)

getValidationPopupDelegate

protected DefaultEditorAreaControllerValidationPopupDelegate getValidationPopupDelegate()

setValidationPopupDelegate

protected void setValidationPopupDelegate(DefaultEditorAreaControllerValidationPopupDelegate validationPopupDelegate)

getWidgetTitleDelegate

protected DefaultEditorAreaControllerWidgetTitleDelegate getWidgetTitleDelegate()

setWidgetTitleDelegate

protected void setWidgetTitleDelegate(DefaultEditorAreaControllerWidgetTitleDelegate widgetTitleDelegate)

getConcurrentModificationDelegate

public DefaultEditorAreaControllerConcurrentModificationDelegate getConcurrentModificationDelegate()

setConcurrentModificationDelegate

public void setConcurrentModificationDelegate(DefaultEditorAreaControllerConcurrentModificationDelegate concurrentModificationDelegate)