com.sap.portal.admin.editor

Interface IGenericEventsHandler

All Known Implementing Classes:

GenericEventsHandler

Deprecated. As of SAP NetWeaver 2007 release, replaced by package com.sap.portal.adminstudio.workunitfwapi

public interface IGenericEventsHandler

The interface that handles generic events for the application designer. Generic events are triggered when an administrator clicks a button in the generic toolbar at the top of the editor. These events are triggered and captured automatically by the editor framework.
You cannot change the buttons displayed in the generic events toolbar, but you can create a custom event handler for overriding or extending the standard event handling.
The following lists the generic events that are triggered when the corresponding button is clicked in the generic toolbar at the top of the editor, and describes the default handling of the events:

• Save: Saves the editor data.
• Close: Closes the editor and releases the lock. If object properties were changed, the editor framework displays a dialog asking whether to save the changes.
• Refresh: Reloads the data.
• Preview: Calls handlePreviewEvent on the editor’s event handler. Implement this method to handle a preview event.
• Edit Mode: Reloads the data and enables editing an object that was opened in read-only mode.

Method Summary

void	handleCloseEvent(IEditorContext context, ILockingPolicy lockingPolicy, PPLogger logger) Deprecated. Handles a close event.
void	handleEditModeEvent(IEditorContext context, PPLogger logger) Deprecated. Handles an edit mode event.
void	handlePreviewEvent(IEditorContext context, PPLogger logger) Deprecated. Handles a preview event.
void	handleRefreshEvent(IEditorContext context, PPLogger logger) Deprecated. Handles a refresh event.
void	handleSaveEvent(IEditorContext context, IDataHandler dataHandler, ILockingPolicy lockingPolicy, PPLogger logger) Deprecated. Handles a save event.

Method Detail

handleCloseEvent

void handleCloseEvent(IEditorContext context,
                      ILockingPolicy lockingPolicy,
                      PPLogger logger)

Deprecated.

Handles a close event. The editor framework attempts to release the lock after this method runs successfully.

Parameters:

context - the current editor context

lockingPolicy - the locking policy to use to release the lock

logger - a logger for logging messages

handleEditModeEvent

void handleEditModeEvent(IEditorContext context,
                         PPLogger logger)

Deprecated.

Handles an edit mode event.

Parameters:

context - the current editor context

logger - a logger for logging messages

handlePreviewEvent

void handlePreviewEvent(IEditorContext context,
                        PPLogger logger)

Deprecated.

Handles a preview event.

Parameters:

context - the current editor context

logger - a logger for logging messages

handleRefreshEvent

void handleRefreshEvent(IEditorContext context,
                        PPLogger logger)

Deprecated.

Handles a refresh event.

Parameters:

context - the current editor context

logger - a logger for logging messages

handleSaveEvent

void handleSaveEvent(IEditorContext context,
                     IDataHandler dataHandler,
                     ILockingPolicy lockingPolicy,
                     PPLogger logger)

Deprecated.

Handles a save event. The editor framework attempts to save data after this method runs successfully.

Parameters:

context - the current editor context

dataHandler - the handler of the data

lockingPolicy - the locking policy to use for the save operation

logger - a logger for logging messages

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN