com.goldencode.p2j.util

Interface CommonLastEvent

All Superinterfaces:

CommonHandle, Coordinates, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon

public interface CommonLastEvent
extends CommonHandle, Coordinates, PseudoWidget

Exposes the following methods or attributes from the LAST-EVENT handle:

LAST-EVENT attribute or method	API
CODE	getLastKey()
FUNCTION	getLastFunction()

This interface is used as a returned type by the handle.unwrapLastEvent() API, which, depending on the handle's state, it either returns an KeyReader.asHandle() instance or a dynamic proxy using handle.invalidAttrAccessProxy.

Method Summary

Modifier and Type	Method and Description
logical	_setLastKey(long etype, long kcode) Sets the event type and last key read from any source (stream or terminal).
logical	_setLastKey(long etype, NumberType kcode) Sets the event type and last key read from any source (stream or terminal).
logical	_setLastKey(NumberType etype, long kcode) Sets the event type and last key read from any source (stream or terminal).
logical	_setLastKey(NumberType etype, NumberType kcode) Sets the event type and last key read from any source (stream or terminal).
character	getEventType() Implementation of the LAST-EVENT system handle's EVENT-TYPE attribute.
character	getLastFunction() Implementation of the LAST-EVENT system handle's FUNCTION attribute.
integer	getLastKey() Obtains the last key read from any source (stream or terminal).
handle	getWidgetEnter() Implementation of the WIDGET-ENTER system handle's EVENT-TYPE attribute.
handle	getWidgetLeave() Implementation of the WIDGET-LEAVE system handle's EVENT-TYPE attribute.
logical	isOnFrameBorder() Implementation of the ON-FRAME-BORDER system handle's EVENT-TYPE attribute.

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.util.Coordinates

getColumn, getRow, getX, getY, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY

Method Detail

getLastKey

integer getLastKey()

Obtains the last key read from any source (stream or terminal).

Returns:

The last key read.

_setLastKey

logical _setLastKey(long etype,
                    long kcode)

Sets the event type and last key read from any source (stream or terminal). This is an undocumented method for the LAST-EVENT system handle that was found in customer source code.

Parameters:

etype - The event-type of the last event. This may be 0 (for KEYPRESS), 1 (for MOUSE). If one of these valid values is passed, then the method will change the event state and return true. With any other value, the method will not change state and will return false.

kcode - The key-code of the last event. Any value may be passed but any changes will only be saved if the etype is valid (and the method thus returns true). Any integer between -32768 and 32767 (inclusive) will set the key code to that same number. Any other number will be cast into a 16-bit signed integer before assignment (which will drop the most significant 32-bits).

Returns:

true if the etype is valid and state is changed. false if etype is NOT valid and state is NOT changed.

_setLastKey

logical _setLastKey(NumberType etype,
                    long kcode)

Sets the event type and last key read from any source (stream or terminal). This is an undocumented method for the LAST-EVENT system handle that was found in customer source code.

Parameters:

etype - The event-type of the last event. This may be 0 (for KEYPRESS), 1 (for MOUSE). If one of these valid values is passed, then the method will change the event state and return true. With any other value, the method will not change state and will return false. Passing unknown value is equivalent to KEYPRESS.

kcode - The key-code of the last event. Any value may be passed but any changes will only be saved if the etype is valid (and the method thus returns true). Any integer between -32768 and 32767 (inclusive) will set the key code to that same number. Any other number will be cast into a 16-bit signed integer before assignment (which will drop the most significant 32-bits).

Returns:

true if the etype is valid and state is changed. false if etype is NOT valid and state is NOT changed.

_setLastKey

logical _setLastKey(long etype,
                    NumberType kcode)

Sets the event type and last key read from any source (stream or terminal). This is an undocumented method for the LAST-EVENT system handle that was found in customer source code.

Parameters:

etype - The event-type of the last event. This may be 0 (for KEYPRESS), 1 (for MOUSE). If one of these valid values is passed, then the method will change the event state and return true. With any other value, the method will not change state and will return false.

kcode - The key-code of the last event. Any value may be passed but any changes will only be saved if the etype is valid (and the method thus returns true). Any integer between -32768 and 32767 (inclusive) will set the key code to that same number. Any other number will be cast into a 16-bit signed integer before assignment (which will drop the most significant 32-bits). Passing unknown value is the same as passing 0.

Returns:

true if the etype is valid and state is changed. false if etype is NOT valid and state is NOT changed.

_setLastKey

logical _setLastKey(NumberType etype,
                    NumberType kcode)

Sets the event type and last key read from any source (stream or terminal). This is an undocumented method for the LAST-EVENT system handle that was found in customer source code.

Parameters:

etype - The event-type of the last event. This may be 0 (for KEYPRESS), 1 (for MOUSE). If one of these valid values is passed, then the method will change the event state and return true. With any other value, the method will not change state and will return false. Passing unknown value is equivalent to KEYPRESS.

kcode - The key-code of the last event. Any value may be passed but any changes will only be saved if the etype is valid (and the method thus returns true). Any integer between -32768 and 32767 (inclusive) will set the key code to that same number. Any other number will be cast into a 16-bit signed integer before assignment (which will drop the most significant 32-bits). Passing unknown value is the same as passing 0.

Returns:

true if the etype is valid and state is changed. false if etype is NOT valid and state is NOT changed.

getLastFunction

character getLastFunction()

Implementation of the LAST-EVENT system handle's FUNCTION attribute.

Returns:

The key function of the last key event.

getEventType

character getEventType()

Implementation of the LAST-EVENT system handle's EVENT-TYPE attribute.

Returns:

The key function of the last key event.

getWidgetEnter

handle getWidgetEnter()

Implementation of the WIDGET-ENTER system handle's EVENT-TYPE attribute.

Returns:

A handle, in a trigger associated with an ENTRY event or a LEAVE event, to the next widget to receive input focus.

getWidgetLeave

handle getWidgetLeave()

Implementation of the WIDGET-LEAVE system handle's EVENT-TYPE attribute.

Returns:

A handle, in a trigger associated with an ENTRY event or a LEAVE event, to the next widget to receive input focus.

isOnFrameBorder

logical isOnFrameBorder()

Implementation of the ON-FRAME-BORDER system handle's EVENT-TYPE attribute.

Returns:

YES if the last event was a mouse event that occurred on a frame border.