oracle.adf.view.page.editor.event

Class BaseActionEvent

java.lang.Object

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

oracle.adf.view.page.editor.event.BaseActionEvent

Direct Known Subclasses:

CustomActionEvent, SelectActionEvent

public abstract class BaseActionEvent
extends PageEditorEvent

A BaseActionEvent is a notification that a component's custom action is invoked using Oracle Composer.

Constructor Summary

Constructors

Constructor and Description
BaseActionEvent(java.lang.String pagePath, javax.faces.component.UIComponent comp) Create a BaseActionEvent event with ...

Method Summary

Modifier and Type	Method and Description
javax.faces.component.UIComponent	getComponent() Returns the component that is being edited
java.lang.String	getMessageDetail() Returns the detail message
javax.faces.application.FacesMessage.Severity	getMessageSeverity() Returns the message severity
java.lang.String	getMessageSummary() Returns the message summary
java.lang.String	getPagePath() Returns the page path
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

getEventType, isEventHandled, processListener, setEventHandled

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseActionEvent

public BaseActionEvent(java.lang.String pagePath,
                       javax.faces.component.UIComponent comp)

Create a BaseActionEvent event with ...

Method Detail

getPagePath

public java.lang.String getPagePath()

Returns the page path

Returns:

path of the page that the component is on

getComponent

public javax.faces.component.UIComponent getComponent()

Returns the component that is being edited

Returns:

The UIComponent of the selected component.

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 message summary

Returns:

the message 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