oracle.adf.view.page.editor.event

Class SelectionEvent

java.lang.Object

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

oracle.adf.view.page.editor.event.SelectionEvent

public class SelectionEvent
extends PageEditorEvent

A SelectionEvent is a notification that a component is selected using the various means Oracle Composer supports. These include selection on the page, the Structure Navigator etc.

The selected component is the parameter of SelectionEvent.

Constructor Summary

Constructors

Constructor and Description
SelectionEvent(java.lang.Object source, javax.faces.component.UIComponent selComp) Creates a Selection Event with the client id of the component that is selected.

Method Summary

Modifier and Type	Method and Description
Event	getEventType() Returns the type of this event.
javax.faces.component.UIComponent	getSelectedComponent() Returns the component that is selected.
java.lang.Object	getSource() Returns the source of the selection event.
void	processListener(PageEditorListener listener) Broadcast this SelectionEvent to the specified PageEditorListener, by whatever mechanism is appropriate.

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

SelectionEvent

public SelectionEvent(java.lang.Object source,
                      javax.faces.component.UIComponent selComp)

Creates a Selection Event with the client id of the component that is selected.

Parameters:

selCompClientId - Client id of the selected component.

Throws:

NullPointerException - If the given id is null.

Method Detail

processListener

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

Broadcast this SelectionEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processSelection method on SelectionListener, and passing this SelectionEvent as a paramter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this SelectionEvent to.

Throws:

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

getSelectedComponent

public javax.faces.component.UIComponent getSelectedComponent()

Returns the component that is selected.

Returns:

The UIComponent of the selected component. If the component with the given id cannot be found, returns null.

getSource

public java.lang.Object getSource()

Returns the source of the selection event.

Returns:

The object on which the Event initially occurred.

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.COMP_SELECTION_EVENT.