oracle.adf.view.page.editor.event

Class ParameterChangeEvent

java.lang.Object

oracle.adf.view.page.editor.event.PageEditorEvent

oracle.adf.view.page.editor.event.ParameterChangeEvent

public class ParameterChangeEvent
extends PageEditorEvent

Since:

release specific (what release of product did this appear in)

Constructor Summary

Constructors

Constructor and Description
ParameterChangeEvent(java.lang.String pagePath, java.lang.String componentId, java.lang.String taskFlowId, java.lang.String paramName, java.lang.Object oldValue, java.lang.Object newValue) Create a ParameterChange event

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponentId() Returns the id of the component that is being edited
Event	getEventType() Returns the type of this event.
java.lang.String	getMessageDetail() Returns the detail message
javax.faces.application.FacesMessage.Severity	getMessageSeverity() Returns the message severity
java.lang.String	getMessageSummary() Returns the detail summary
java.lang.Object	getNewValue() Returns the new value of the parameter
java.lang.Object	getOldValue() Returns the old value of the parameter
java.lang.String	getPagePath() Returns the page path
java.lang.String	getParamName() Returns the parameter name whose value is being changed
java.lang.String	getTaskFlowId() Returns the task flow id If the component that is being edited is not a region, return null
void	processListener(PageEditorListener listener) Broadcast this ParameterChangeEvent to the specified PageEditorListener, by whatever mechanism is appropriate.
void	setMessageDetail(java.lang.String msgDetail) Set the message detail
void	setMessageSeverity(javax.faces.application.FacesMessage.Severity severity) Set the message severity
void	setMessageSummary(java.lang.String msgSummary) Set the message summary
void	setShowMessage(boolean showMsg) Set the flag which indicates if to show message when no error
boolean	showMessage() If to show message when no error

Methods inherited from class oracle.adf.view.page.editor.event.PageEditorEvent

isEventHandled, setEventHandled

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterChangeEvent

public ParameterChangeEvent(java.lang.String pagePath,
                            java.lang.String componentId,
                            java.lang.String taskFlowId,
                            java.lang.String paramName,
                            java.lang.Object oldValue,
                            java.lang.Object newValue)

Create a ParameterChange event

Method Detail

getPagePath

public java.lang.String getPagePath()

Returns the page path

Returns:

path of the page that the component is on

getComponentId

public java.lang.String getComponentId()

Returns the id of the component that is being edited

Returns:

the id of the component that is being edited

getTaskFlowId

public java.lang.String getTaskFlowId()

Returns the task flow id If the component that is being edited is not a region, return null

Returns:

id of the task flow id

getParamName

public java.lang.String getParamName()

Returns the parameter name whose value is being changed

Returns:

the parameter name

getNewValue

public java.lang.Object getNewValue()

Returns the new value of the parameter

Returns:

new value of the parameter

getOldValue

public java.lang.Object getOldValue()

Returns the old value of the parameter

Returns:

old value of the parameter

setMessageDetail

public void setMessageDetail(java.lang.String msgDetail)

Set the message detail

Parameters:

msgDetail - the detail message

getMessageDetail

public java.lang.String getMessageDetail()

Returns the detail message

Returns:

the detail message

setMessageSummary

public void setMessageSummary(java.lang.String msgSummary)

Set the message summary

Parameters:

msgSummary - the summary message

getMessageSummary

public java.lang.String getMessageSummary()

Returns the detail summary

Returns:

the detail summary

setMessageSeverity

public void setMessageSeverity(javax.faces.application.FacesMessage.Severity severity)

Set the message severity

Parameters:

severity - the error message severity

getMessageSeverity

public javax.faces.application.FacesMessage.Severity getMessageSeverity()

Returns the message severity

Returns:

the error message severity

setShowMessage

public void setShowMessage(boolean showMsg)

Set the flag which indicates if to show message when no error

Parameters:

showMsg - the flag which indicates if to show message when no error

showMessage

public boolean showMessage()

If to show message when no error

Returns:

true if to show the message when error; otherwise false

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.PARAMETER_CHANGE_EVENT.

processListener

public void processListener(PageEditorListener listener)
                     throws javax.faces.event.AbortProcessingException

Broadcast this ParameterChangeEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processParameterChange method on ParameterChangeListener, and passing this ParameterChangeEvent as a parameter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this ParameterChangeEvent to.

Throws:

javax.faces.event.AbortProcessingException - Signal Oracle Composer that no further processing on the current event should be performed.