ilog.views.util.servlet.event
Class ServletActionListener

java.lang.Object
  ilog.views.util.servlet.event.ServletActionListener

All Implemented Interfaces:

ActionListener, Serializable

Direct Known Subclasses:

FacesViewActionListener

public abstract class ServletActionListener
extends Object
implements ActionListener

This class defines a server side action listener.

Since:

JViews 7.5

See Also:

Serialized Form

Constructor Summary

ServletActionListener()
Creates a new ServletActionListener instance.

ServletActionListener(boolean updateAll)
Creates a new ServletActionListener instance.

ServletActionListener(String[] parameters)
Creates a new ServletActionListener instance.

ServletActionListener(String[] parameters, boolean updateAll)
Creates a new ServletActionListener instance.

ServletActionListener(String actionName, String[] parameters)
Creates a new ServletActionListener instance.

ServletActionListener(String actionName, String[] parameters, boolean updateAll)
Creates a new ServletActionListener instance.

Method Summary

String	getActionName() Returns the name of the server side action to trigger.
String[]	getAdditionalParameters() Returns the additional parameters of this listener.
boolean	isUpdateAll() Returns whether refresh the image and capabilities or the image only after the action.
void	setActionName(String actionName) Sets the name of the server side action to trigger.
void	setAdditionalParameters(String[] parameters) Sets the additional parameters of this listener.
void	setUpdateAll(boolean updateAll) Sets whether refresh the image and capabilities or the image only after the action.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.util.servlet.event.ActionListener

actionPerformed

Constructor Detail

ServletActionListener

public ServletActionListener(String actionName,
                             String[] parameters,
                             boolean updateAll)

Creates a new ServletActionListener instance.

Parameters:

actionName - The action name of the desired action.

parameters - The optional additional parameters.

updateAll - Whether refresh the image and capabilities or the image only.

ServletActionListener

public ServletActionListener()

Creates a new ServletActionListener instance.

ServletActionListener

public ServletActionListener(boolean updateAll)

Creates a new ServletActionListener instance.

Parameters:

updateAll - Whether refresh the image and capabilities or the image only.

ServletActionListener

public ServletActionListener(String[] parameters)

Creates a new ServletActionListener instance.

Parameters:

parameters - The optional additional parameters.

ServletActionListener

public ServletActionListener(String[] parameters,
                             boolean updateAll)

Creates a new ServletActionListener instance.

Parameters:

parameters - The optional additional parameters.

updateAll - Whether refresh the image and capabilities or the image only.

ServletActionListener

public ServletActionListener(String actionName,
                             String[] parameters)

Creates a new ServletActionListener instance.

Parameters:

actionName - The action name of the desired action.

parameters - The optional additional parameters.

Method Detail

getActionName

public String getActionName()

Returns the name of the server side action to trigger.

If this method returns null, the menu encoder will set the action name of the default action listener that will call the actionPerformed method of this object.

If the action name is not null, this action registered with the specified name on the servlet support will triggered.

Returns:

The action name.

setActionName

public void setActionName(String actionName)

Sets the name of the server side action to trigger.

If this method returns null, the menu encoder will set the action name of the default action listener that will call the actionPerformed method of this object.

If the action name is not null, this action registered with the specified name on the servlet support will triggered.

Parameters:

actionName - The action name.

getAdditionalParameters

public String[] getAdditionalParameters()

Returns the additional parameters of this listener.

Returns:

The additional parameters.

setAdditionalParameters

public void setAdditionalParameters(String[] parameters)

Sets the additional parameters of this listener.

Parameters:

parameters - The additional parameters.

isUpdateAll

public boolean isUpdateAll()

Returns whether refresh the image and capabilities or the image only after the action.

Returns:

Whether refresh the image and capabilities or the image only.

setUpdateAll

public void setUpdateAll(boolean updateAll)

Sets whether refresh the image and capabilities or the image only after the action.

Parameters:

updateAll - Whether refresh the image and capabilities or the image only after the action.