org.tanukisoftware.wrapper.event

Class WrapperUserEvent

java.lang.Object

java.util.EventObject

org.tanukisoftware.wrapper.event.WrapperEvent

org.tanukisoftware.wrapper.event.WrapperUserEvent

All Implemented Interfaces:

java.io.Serializable

public class WrapperUserEvent
extends WrapperEvent

WrapperUserEvents are fired whenever a USER_N event is fired within the Wrapper. These can be useful to take some custom action. Only available with Professional Edition.

Author:

Tanuki Software Development Team <support@tanukisoftware.com>

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
WrapperUserEvent(int code) Creates a new WrapperUserEvent.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the user event code.
long	getFlags() Returns a set of event flags for which the event should be fired.
java.lang.String	toString() Returns a string representation of the event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WrapperUserEvent

public WrapperUserEvent(int code)

Creates a new WrapperUserEvent.

Parameters:

code - The user code ('user_N').

Method Detail

getFlags

public long getFlags()

Returns a set of event flags for which the event should be fired. This value is compared with the mask supplied when a WrapperEventListener is registered to decide which listeners should receive the event.

If subclassed, the return value of the super class should usually be ORed with any additional flags.

Specified by:

getFlags in class WrapperEvent

Returns:

a set of event flags.

getCode

public int getCode()

Returns the user event code.

Returns:

The user event code.

toString

public java.lang.String toString()

Returns a string representation of the event.

Overrides:

toString in class java.util.EventObject

Returns:

A string representation of the event.