ilog.views.faces.dhtml.event

Class FacesViewActionEvent

java.lang.Object

java.util.EventObject

javax.faces.event.FacesEvent

javax.faces.event.ActionEvent

ilog.views.faces.dhtml.event.FacesViewActionEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FacesMenuActionEvent

public class FacesViewActionEvent
extends ActionEvent

The JSF action event for views events.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FacesViewActionEvent(FacesContext context, UIComponent component) Creates a new IlvFacesViewActionEvent instance.

Method Summary

Modifier and Type	Method and Description
String[]	getAdditionalParameters() Returns the optional additional parameters.
FacesContext	getContext() Returns the current faces context.
Object	getGraphicComponent() Returns the graphic component that contains the selected object.
Object	getObject() Returns the object selected on the graphic component when this action was triggered, or null if no object was selected.
boolean	isAppropriateListener(FacesListener listener) Return true if this listener is an instance of FacesViewActionListener.
void	setAdditionalParameters(String[] additionalParameters) Sets the optional additional parameters.
void	setGraphicComponent(Object graphicComponent) Sets the graphic component that contains the selected object.
void	setObject(Object object) Returns the object selected on the graphic component when this action was triggered.

Methods inherited from class javax.faces.event.ActionEvent

processListener

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FacesViewActionEvent

public FacesViewActionEvent(FacesContext context,
                            UIComponent component)

Creates a new IlvFacesViewActionEvent instance.

Parameters:

context - The current faces context.

component - The event source component.

Method Detail

getGraphicComponent

public Object getGraphicComponent()

Returns the graphic component that contains the selected object.

Returns:

The graphic component.

setGraphicComponent

public void setGraphicComponent(Object graphicComponent)

Sets the graphic component that contains the selected object.

Parameters:

graphicComponent - The graphic component.

getObject

public Object getObject()

Returns the object selected on the graphic component when this action was triggered, or null if no object was selected.

Returns:

The object selected.

setObject

public void setObject(Object object)

Returns the object selected on the graphic component when this action was triggered.

Parameters:

object - The selected object.

getAdditionalParameters

public String[] getAdditionalParameters()

Returns the optional additional parameters.

Returns:

The optional additional parameters.

setAdditionalParameters

public void setAdditionalParameters(String[] additionalParameters)

Sets the optional additional parameters.

Parameters:

additionalParameters - The optional additional parameters.

getContext

public FacesContext getContext()

Returns the current faces context.

Returns:

The context.

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

Return true if this listener is an instance of FacesViewActionListener.

Overrides:

isAppropriateListener in class ActionEvent

Parameters:

listener - The listener to evaluate