ilog.views.faces.dhtml.event
Class FacesMenuActionEvent

java.lang.Object
  java.util.EventObject
      javax.faces.event.FacesEvent
          javax.faces.event.ActionEvent
              ilog.views.faces.dhtml.event.FacesViewActionEvent
                  ilog.views.faces.dhtml.event.FacesMenuActionEvent

All Implemented Interfaces:

Serializable

public class FacesMenuActionEvent
extends FacesViewActionEvent

A view action event triggered by a menu component.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

FacesMenuActionEvent(FacesContext context, UIComponent component)
Creates a new IlvFacesMenuActionEvent instance.

Method Summary

IlvMenuItem	getSelectedMenuItem() Returns the model menu item selected.
boolean	isAppropriateListener(FacesListener listener) Always return Return true .
void	processListener(FacesListener listener) Broadcast this event to the specified listener, by whatever mechanism is appropriate.
void	setSelectedMenuItem(IlvMenuItem selectedMenuItem) Sets the selected menu item.

Methods inherited from class ilog.views.faces.dhtml.event.FacesViewActionEvent

getAdditionalParameters, getContext, getGraphicComponent, getObject, setAdditionalParameters, setGraphicComponent, setObject

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

FacesMenuActionEvent

public FacesMenuActionEvent(FacesContext context,
                            UIComponent component)

Creates a new IlvFacesMenuActionEvent instance.

Parameters:

context - The faces context.

component - The source of the event.

Method Detail

getSelectedMenuItem

public IlvMenuItem getSelectedMenuItem()

Returns the model menu item selected.

Returns:

The selected menu item.

setSelectedMenuItem

public void setSelectedMenuItem(IlvMenuItem selectedMenuItem)

Sets the selected menu item.

Parameters:

selectedMenuItem - The menu item.

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

Always return Return true .

Overrides:

isAppropriateListener in class FacesViewActionEvent

Parameters:

listener - The listener to evaluate

processListener

public void processListener(FacesListener listener)

Broadcast this event to the specified listener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this event as a parameter.

Overrides:

processListener in class ActionEvent

Parameters:

listener - The listener to send this event to.

Throws:

AbortProcessingException - Signal the JavaServer Faces implementation that no further processing on the current event should be performed