ilog.views.util.servlet.event

Class ServletActionEvent

java.lang.Object

java.util.EventObject

ilog.views.util.servlet.event.ServletActionEvent

All Implemented Interfaces:

Serializable

public class ServletActionEvent
extends EventObject
implements Serializable

The ServletActionEvent is fired by the servlet support when a client side action involving a graphic component and an object is triggered.

This listener is designed to be registered on an IlvMenuItem.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ServletActionEvent(Object source, EventObject event) Creates a new ServletActionEvent instance.

Method Summary

Modifier and Type	Method and Description
String[]	getAdditionalParameters() Returns the optional additional parameters.
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.
EventObject	getSourceEvent() If this event instance is translated from another event, returns the source event or false otherwise.
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 java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletActionEvent

public ServletActionEvent(Object source,
                          EventObject event)

Creates a new ServletActionEvent instance.

Parameters:

source - The source of the event.

event - An optional event that has been translated into this event.

Method Detail

getSourceEvent

public EventObject getSourceEvent()

If this event instance is translated from another event, returns the source event or false otherwise.

Returns:

The source event or null.

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.