com.ibm.eNetwork.ECL
Interface ECLPSNotify

Deprecated.

Use com.ibm.eNetwork.ECL.event.ECLPSListener.

public interface ECLPSNotify

The ECLPSNotify interface can be used to implement an object which will receive and handle ECLPS events. Events are generated whenever the presentation space is updated. The presentation space can be updated by the host (when a new screen is sent) or through keyboard input. Special events are generated when event generation stops and when errors occur during event generation.

To be notified of PS events, the application must:

1. Define a class which implements the ECLPSNotify interface.
2. Implement the NotifyEvent(), NotifyStop(), and NotifyError() methods.
3. Create an instance of the new class.
4. Register the instance with the ECLPS.RegisterPSEvent() method.

See Also:

ECLPS

Method Summary

void	NotifyError(ECLPS ps, ECLErr e) Deprecated. The NotifyError() method is called whenever the ECLPS object detects an error during event generation.
void	NotifyEvent(ECLPS ps) Deprecated. The NotifyEvent() method is called whenever the presentation space is updated.
void	NotifyStop(ECLPS ps, int reason) Deprecated. The NotifyStop() method is called when event generation is stopped for any reason.

Method Detail

NotifyEvent

public void NotifyEvent(ECLPS ps)

Deprecated.

The NotifyEvent() method is called whenever the presentation space is updated. The presentation space can be updated by the host (when a new screen is sent) or through operator (mouse or keyboard) input.

An application should not assume it will receive a distinct event for every update. An update event is defined as one or more changes in the PS since the last time an event was generated (or since registration, if there was no prior update event).

Parameters:

ps - The object which generated the event.

NotifyStop

public void NotifyStop(ECLPS ps,
                       int reason)

Deprecated.

The NotifyStop() method is called when event generation is stopped for any reason. Event generation might stop because of an error condition or because the ECLPS.UnregisterPSEvent() method was called.

Parameters:

ps - The object which generated the event.

reason - This parameter is not currently used.

NotifyError

public void NotifyError(ECLPS ps,
                        ECLErr e)

Deprecated.

The NotifyError() method is called whenever the ECLPS object detects an error during event generation. An ECLErr object containing information about the error is passed to this method. If event generation stops due to an error, the NotifyStop() method is also called.

Parameters:

ps - The object which generated the event.

e - The ECLErr object containing error data.

See Also:

ECLErr, NotifyStop(com.ibm.eNetwork.ECL.ECLPS, int)