com.sap.portal.admin.editor
Interface IGenericEventsHandler

All Known Implementing Classes:
GenericEventsHandler

public interface IGenericEventsHandler

IGenericEventsHandler Handle the events of the application designer. The events are: Save Close Refresh Preview Edit mode


Method Summary
 void handleCloseEvent(IEditorContext context, ILockingPolicy lockingPolicy, com.sapportals.common.PPLogger logger)
          Handle the "close" event that was raised.
 void handleEditModeEvent(IEditorContext context, com.sapportals.common.PPLogger logger)
          Handle the "edit mode" event that was raised.
 void handlePreviewEvent(IEditorContext context, com.sapportals.common.PPLogger logger)
          Handle the "preview" event that was raised.
 void handleRefreshEvent(IEditorContext context, com.sapportals.common.PPLogger logger)
          Handle the "refresh" event that was raised.
 void handleSaveEvent(IEditorContext context, IDataHandler dataHandler, ILockingPolicy lockingPolicy, com.sapportals.common.PPLogger logger)
          Handle the "save" event that was raised.
 

Method Detail

handleCloseEvent

public void handleCloseEvent(IEditorContext context,
                             ILockingPolicy lockingPolicy,
                             com.sapportals.common.PPLogger logger)
Handle the "close" event that was raised. The editor framework will try to release lock after this method finished successfully.
Parameters:
context - current editor context
lockingPolicy - the locking policy which can be used for the release lock operation
logger -  

handleEditModeEvent

public void handleEditModeEvent(IEditorContext context,
                                com.sapportals.common.PPLogger logger)
Handle the "edit mode" event that was raised.
Parameters:
context - current editor context
logger - to log messages

handlePreviewEvent

public void handlePreviewEvent(IEditorContext context,
                               com.sapportals.common.PPLogger logger)
Handle the "preview" event that was raised.
Parameters:
context - current editor context
logger - to log messages

handleRefreshEvent

public void handleRefreshEvent(IEditorContext context,
                               com.sapportals.common.PPLogger logger)
Handle the "refresh" event that was raised.
Parameters:
context - current editor context
logger - to log messages

handleSaveEvent

public void handleSaveEvent(IEditorContext context,
                            IDataHandler dataHandler,
                            ILockingPolicy lockingPolicy,
                            com.sapportals.common.PPLogger logger)
Handle the "save" event that was raised. The editor framework will try to save data (using the data handler plugin) after this method finished successfully.
Parameters:
context - current editor context
dataHandler - the handler of the data- can be perform the save
lockingPolicy - the locking policy which can be used for the save operation
logger - to log messages