NAME

IWL::RPC::Request - an RPC Requst helper class

DESCRIPTION

The RPC Request helper class is an abstract class, which provides RPC functionality (via XMLHttpRequest) to IWL Objects

METHODS

registerEvent (EVENT, URL, [PARAMS, OPTIONS])

Registers an event handler to the given event. The event will be processed by a handleEvent(3pm) call in the handling script

Parameters: EVENT - The event name to register. URL the script url, which will provide the event handling. PARAMS - a hash reference of parameters to be passed to the handler subroutine as a parameter. OPTIONS - a hash reference of options to be interpretted by the handler

onStart

A javascript expression to be evaluated before the request takes place. It receives params as an argument

onComplete

A javascript expression to be evaluated after the request takes place

emitOnce

A boolean flag, causes the event to be emitted only once

disableView

An indication will be shown that a response is active, if the parameter exists. It can be a hash with the following options:

noCover BOOL

If true, the screen will not be covered, only the mouse cursor will indicate that a response is active (default: false)

fullCover BOOL

If true, the screen will be fully covered (default: false)

opacity FLOAT

The opacity of the covering element (default: 0.8)

update

The id of element to be updated. If empty, the document body is updated. The following parameters are also taken under consideration if this one is specified:

evalScripts

True, if any script elements in the response should be evaluated using javascript's eval() function

insertion

If omitted, the contents of the container will be replaced with the response of the script. Otherwise, depeding on the value, the reponse will be placed around the exsting content. Valid values are:

after

Will be inserted as the next sibling of the container,

before

Will be inserted as the previous sibling of the container,

bottom

Will be inserted as the last child of the container,

top

Will be inserted as the first child of the container

LICENCE AND COPYRIGHT

Copyright (c) 2006-2007 Viktor Kojouharov. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perldoc perlartistic.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.