com.sap.portal.admin.editor
Interface IEditorResponse

public interface IEditorResponse

IEditorResponse A respnse representor: This call can be used for any kind of response free additions. Such as html or hjava scripts.

Method Summary

void	addJavaScript(java.lang.String javaScript) Add java script code to the response.
void	addMessageKey(EditorMessageType messageType, java.lang.String messageKey) Add a message key that represented a message that will be published (formatted) to the editor user.
void	addMessageKey(EditorMessageType messageType, java.lang.String messageKey, java.lang.Object[] parameters) Add a message key that represented a message that will be published (formatted) to the editor user.
com.sapportals.portal.prt.component.IPortalComponentResponse	getResponse() Get the portal component response.
void	include(com.sapportals.portal.prt.pom.INode node) Include a POM node on this response
void	setBeforeSaveQuestion(java.lang.String question) Set a question that will be raised to the user When trying to save the editor content.
void	setClientProperty(java.lang.String key, java.lang.String data) Set a data associated with a key.

Method Detail

include

public void include(com.sapportals.portal.prt.pom.INode node)

Include a POM node on this response

Parameters:

node -

setBeforeSaveQuestion

public void setBeforeSaveQuestion(java.lang.String question)

Set a question that will be raised to the user When trying to save the editor content. The answer to the question must be "Yes"- save content Or "No"- do not save content

Parameters:

question - the question string (must be NLS formatted!)

setClientProperty

public void setClientProperty(java.lang.String key,
                              java.lang.String data)

Set a data associated with a key. This data will be available on the client side, and can be retrieved using the client API:
parametersMap.get([key]);

Parameters:

key - key with which the specified value is to be associated.

data - data to be associated with the specified key.

getResponse

public com.sapportals.portal.prt.component.IPortalComponentResponse getResponse()

Get the portal component response. Should be used only for services that demands response.

addJavaScript

public void addJavaScript(java.lang.String javaScript)

Add java script code to the response.

Parameters:

javaScript - the java script code

addMessageKey

public void addMessageKey(EditorMessageType messageType,
                          java.lang.String messageKey)

Add a message key that represented a message that will be published (formatted) to the editor user.

Parameters:

messageType - type of message

messageKey - The key of the message

addMessageKey

public void addMessageKey(EditorMessageType messageType,
                          java.lang.String messageKey,
                          java.lang.Object[] parameters)

Add a message key that represented a message that will be published (formatted) to the editor user. The message will be formatted using the given parameters.

Parameters:

messageType - type of message

messageKey - The key of the message

parameters - Array of parameters taht will be used for the formatting