com.ibm.eNetwork.ECL.event
Class ECLPSEvent

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.event.ECLEvent
        |
        +--com.ibm.eNetwork.ECL.event.ECLPSEvent

public class ECLPSEvent

extends ECLEvent

Event fired to notify listeners that something in the presentation space has changed. The change could be just a new cursor location, a new screen from the host, keys which were typed by the user, or text entered by another application via the API.

The event contains the coordinates of the changed area of the presentation space. It also contains the type of the event, either ECLPS.HOST_EVENTS or ECLPS.USER_EVENTS. Host events are generated as a result of host driven presentation space changes. User events are generated as a result of user input via ECLPS methods, like SendKeys().

The event does not actually contain the data associated with the presentation space changes. To access the changed data in the planes the event handler must call ECLPS.GetScreen(int, int, int).

See Also:

ECLPS.RegisterPSEvent(com.ibm.eNetwork.ECL.event.ECLPSListener), ECLPSListener

Constructor Summary

ECLPSEvent(java.lang.Object source)
Constructor for generating a new ECLPSEvent.

ECLPSEvent(java.lang.Object source, int type)
Constructor for generating a new ECLPSEvent with a specific type.

Method Summary

boolean	GetCursorVisible() Returns whether the cursor is visible.
int	GetEnd() Returns the ending linear position of the changed area.
int	GetEndCol() Returns the ending column of the changed area.
int	GetEndRow() Returns the ending row of the changed area.
ECLPS	GetPS() Returns the ECLPS object associated with this event.
int	GetStart() Returns the starting linear position of the changed area.
int	GetStartCol() Returns the starting column of the changed area.
int	GetStartRow() Returns the starting row of the changed area.
int	GetType() Returns the type of this event.

Methods inherited from class com.ibm.eNetwork.ECL.event.ECLEvent

GetSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ECLPSEvent

public ECLPSEvent(java.lang.Object source)

Constructor for generating a new ECLPSEvent.

Parameters:

source - The source of the event.

ECLPSEvent

public ECLPSEvent(java.lang.Object source,
                  int type)

Constructor for generating a new ECLPSEvent with a specific type.

Parameters:

source - The source of the event.

type - Either ECLPS.USER_EVENTS or ECLPS.HOST_EVENTS.

Method Detail

GetType

public int GetType()

Returns the type of this event. The type is ECLPS.USER_EVENTS if it is generated by operator input or a method call such as ECLPS.SendKeys(). The type is ECLPS.HOST_EVENTS if it generated when the host updates the presentation space.

GetPS

public ECLPS GetPS()

Returns the ECLPS object associated with this event.

GetStart

public int GetStart()

Returns the starting linear position of the changed area.

GetStartRow

public int GetStartRow()

Returns the starting row of the changed area.

GetStartCol

public int GetStartCol()

Returns the starting column of the changed area.

GetEnd

public int GetEnd()

Returns the ending linear position of the changed area.

GetEndRow

public int GetEndRow()

Returns the ending row of the changed area.

GetEndCol

public int GetEndCol()

Returns the ending column of the changed area.

GetCursorVisible

public boolean GetCursorVisible()

Returns whether the cursor is visible.