Skip navigation links

oracle.adf.view.page.editor.event
Class AttributeChangeEvent

java.lang.Object
oracle.adf.view.page.editor.event.PageEditorEvent
oracle.adf.view.page.editor.event.AttributeChangeEvent

public class AttributeChangeEvent

extends PageEditorEvent

Since:

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

Constructor Summary

AttributeChangeEvent(java.lang.String pagePath, javax.faces.component.UIComponent comp, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> compProps, javax.faces.component.UIComponent field, java.lang.Object value)
Create a AttributeChange event with ...

Method Summary

javax.faces.component.UIComponent	getComponent() Returns the component that is being edited
java.lang.String	getErrorDetail() Deprecated.
java.lang.String	getErrorSummary() Deprecated.
Event	getEventType() Returns the type of this event.
javax.faces.component.UIComponent	getField() Returns the field whose value is being validated.
java.lang.String	getFieldName() Returns the field name
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 field
java.lang.Object	getOldValue() Returns the old value of the field
java.lang.String	getPagePath() Returns the page path
java.lang.Object	getPropertyValue(java.lang.String propertyLabel) Returns the value of a property of the component that is being edited
void	processListener(PageEditorListener listener) Broadcast this AttributeChangeEvent to the specified PageEditorListener, by whatever mechanism is appropriate.
void	setErrorDetail(java.lang.String errDetail) Deprecated.
void	setErrorSummary(java.lang.String errSummary) Deprecated.
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

AttributeChangeEvent

public AttributeChangeEvent(java.lang.String pagePath,
                            javax.faces.component.UIComponent comp,
                            java.util.List<java.util.Map<java.lang.String,java.lang.Object>> compProps,
                            javax.faces.component.UIComponent field,
                            java.lang.Object value)

Create a AttributeChange 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.

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String propertyLabel)

Returns the value of a property of the component that is being edited

Parameters:

the - label of the property

Returns:

the value of the property

getField

public javax.faces.component.UIComponent getField()

Returns the field whose value is being validated.

Returns:

UIComponent that represents the field. Will always be RichInputText

getFieldName

public java.lang.String getFieldName()

Returns the field name

Returns:

name of the field

getNewValue

public java.lang.Object getNewValue()

Returns the new value of the field

Returns:

new value of the field

getOldValue

public java.lang.Object getOldValue()

Returns the old value of the field

Returns:

old value of the field

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.ATTRIBUTE_CHANGE_EVENT.

setErrorDetail

@Deprecated
public void setErrorDetail(java.lang.String errDetail)

Deprecated.

Set the error detail

Parameters:

errDetail - the error detail message

getErrorDetail

@Deprecated
public java.lang.String getErrorDetail()

Deprecated.

Returns the error detail message

Returns:

the error detail message

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

setErrorSummary

@Deprecated
public void setErrorSummary(java.lang.String errSummary)

Deprecated.

Set the error summary

Parameters:

errDetail - the error summary message

getErrorSummary

@Deprecated
public java.lang.String getErrorSummary()

Deprecated.

Returns the error detail summary

Returns:

the error detail summary

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

processListener

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

Broadcast this AttributeChangeEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processAttributeChange method on AttributeChangeListener, and passing this AttributeChangeEvent as a parameter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this AttributeChangeEvent to.

Throws:

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

Skip navigation links