ilog.views.servlet

Class ServerActionEvent

java.lang.Object

java.util.EventObject

ilog.views.util.servlet.IlvServerActionEvent

ilog.views.servlet.ServerActionEvent

All Implemented Interfaces:

Serializable

public class ServerActionEvent
extends IlvServerActionEvent

An event object that is sent to listeners of actions requested from the client side. An action is generated from the client side when the ServerActionListener.actionPerformed method is called. This method queries the server for a new image, but additional parameters are sent in the image request so that an action such as adding, removing, or selecting objects can be performed before the image is generated. An action is defined by a name and a list of parameters. To implement the action on the client side, you will implement the ServerActionListener interface and check the action name and parameters in the event.

Since:

JViews 3.5

See Also:

ServerActionListener.actionPerformed(ilog.views.servlet.ServerActionEvent), IlvManagerServlet.addServerActionListener(ilog.views.servlet.ServerActionListener), Serialized Form

Field Summary

Fields inherited from class ilog.views.util.servlet.IlvServerActionEvent

_params

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ServerActionEvent(javax.servlet.http.HttpServletRequest request, IlvManagerView view, String action, IlvManagerServletSupport support, String[] params) Creates an action event.
ServerActionEvent(javax.servlet.http.HttpServletRequest request, IlvManagerView view, String action, String[] params) Deprecated. Beginning with JViews 8.0 use ServerActionEvent(HttpServletRequest, IlvManagerView, String, IlvManagerServletSupport, String[]) instead.

Method Summary

Modifier and Type	Method and Description
IlvManagerView	getManagerView() Returns the manager view to which the action applies.
IlvPoint	getPointParameter(int index) Returns an IlvPoint parameter at the specified index.
IlvRect	getRectParameter(int index) Returns an IlvRect parameter at the specified index.
IlvManagerServletSupport	getServletSupport() Returns the IlvManagerServletSupport that created that event.

Methods inherited from class ilog.views.util.servlet.IlvServerActionEvent

getActionName, getDoubleParameter, getFloatParameter, getIntParameter, getLongParameter, getParameterCount, getParameters, getRequest, getResponse, getStringParameter

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

ServerActionEvent

@Deprecated
public ServerActionEvent(javax.servlet.http.HttpServletRequest request,
                                     IlvManagerView view,
                                     String action,
                                     String[] params)

Deprecated. Beginning with JViews 8.0 use ServerActionEvent(HttpServletRequest, IlvManagerView, String, IlvManagerServletSupport, String[]) instead.

Creates an action event.

ServerActionEvent

public ServerActionEvent(javax.servlet.http.HttpServletRequest request,
                         IlvManagerView view,
                         String action,
                         IlvManagerServletSupport support,
                         String[] params)

Creates an action event.

Since:

JViews 8.0

Method Detail

getManagerView

public IlvManagerView getManagerView()

Returns the manager view to which the action applies.

getServletSupport

public IlvManagerServletSupport getServletSupport()

Returns the IlvManagerServletSupport that created that event.

Since:

JViews 8.0

getPointParameter

public IlvPoint getPointParameter(int index)
                           throws javax.servlet.ServletException

Returns an IlvPoint parameter at the specified index. This utility method reads two double parameters starting at index and creates an IlvPoint.

Parameters:

index - The parameter index.

Throws:

javax.servlet.ServletException

getRectParameter

public IlvRect getRectParameter(int index)
                         throws javax.servlet.ServletException

Returns an IlvRect parameter at the specified index. This utility method reads four double parameters starting at index and creates an IlvRect.

Parameters:

index - The parameter index.

Throws:

javax.servlet.ServletException