Skip navigation links

ilog.webui.dhtml
Class IlxWRequestDesc

java.lang.Object
  ilog.webui.dhtml.IlxWRequestDesc

All Implemented Interfaces:

ilog.webui.dhtml.IlxWConstants, ilog.webui.dhtml.IlxWDependencyProvider, ilog.webui.dhtml.IlxWJSObject, Serializable

public class IlxWRequestDesc
extends Object
implements ilog.webui.dhtml.IlxWJSObject, ilog.webui.dhtml.IlxWConstants, Serializable

Request descriptor.

Describes a request to send from the client to the web server. A request descriptor is made of two pieces of information:

• path: the path of the request;
• target: the target name of the client frame where the response must be printed.

A request can be either created via the getDesc(java.lang.String, java.lang.String) method or accessed by the predefined request descriptor WPORT.

The WPORT request may be used to specify that only the components of the current page should be redisplayed. Its definition depends on the current web browser.

• With browsers supporting smart redisplaying, the requests described with a WPORT descriptor are sent through an XMLHttpRequest ActiveX object. The target and path properties are therefore not used.
• On other browsers, the target of WPORT will be _self, specifying thus that the page will be completely redisplayed. The path will be the one that was previously used by the port that generated the page.

In all cases, the request is never sent directly to the web server but instead a request is sent to the controller servlet with the request descriptor as a parameter. After having processed the modified component queue, the servlet will forward the request with the given path (if not null).

See Also:

IlxWController, Serialized Form

Field Summary

static IlxWRequestDesc

WPORT A predefined request descriptor specifying that only the components of the port that displayed the page where this request is used can be refreshed.

Method Summary

boolean	equals(Object obj)
static IlxWRequestDesc	getDesc(String path, String target) Gets a request descriptor with the given path and target.
int	hashCode()
void	notifyDependencies(IlxWPort port)

Methods inherited from class java.lang.Object

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

Field Detail

WPORT

public static final IlxWRequestDesc WPORT

A predefined request descriptor specifying that only the components of the port that displayed the page where this request is used can be refreshed.

Method Detail

getDesc

public static IlxWRequestDesc getDesc(String path,
                                      String target)

Gets a request descriptor with the given path and target.

Parameters:

path - The path of the request to send to the web server.

target - The target frame on the client web browser for printing the response. A target may be:

• either the name of the frame
• or one of the following predefined strings : _self, _top, or _blank.

Returns:

A request descriptor containing the given information.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

notifyDependencies

public void notifyDependencies(IlxWPort port)

Specified by:

notifyDependencies in interface ilog.webui.dhtml.IlxWDependencyProvider