com.quadrique.jbuildingblocks.gui
Class SelectionBaseEvent

java.lang.Object
  java.util.EventObject
      com.quadrique.jbuildingblocks.gui.SelectionBaseEvent

All Implemented Interfaces:

Serializable

public class SelectionBaseEvent
extends EventObject

This class describes a selection event. This selection event is sent to all the listeners that registered to receive the selection events.

Author:

Hervé Rivere

See Also:

SelectionHandler, SelectionListener, Serialized Form

Constructor Summary

SelectionBaseEvent(Object zSource, int zSelectionType, int zSelectionId, Object zUserObject)
The constructor of the class.

Method Summary

int	getSelectionId()
int	getSelectionType()
Object	getUserObject()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionBaseEvent

public SelectionBaseEvent(Object zSource,
                          int zSelectionType,
                          int zSelectionId,
                          Object zUserObject)

The constructor of the class.

Parameters:

zSource - the object that created this event,

zSelectionType - if applicable, an integer value that represents the type of the selection (e.g. an MDI window has been selected). The definition of the corresponding numeric values is application specific and outside the scope of this class. We recoomend that the values be defined as static final members in an application specific class as shown in the following example: // selection types final static public int SELECTION_IS_DOMAIN_PANEL = 1; final static public int SELECTION_IS_FRAME_RESULTS = 2; final static public int SELECTION_IS_FRAME_ALARMS = 3; ...

zSelectionId - if applicable, an integer value that uniquely identifies the selected entity. The definition of the corresponding numeric values is application specific and outside the scope of this class.

zUserObject - an optional object that contains additional information regarding the selection. It is typically used to store additional information for later processing

Method Detail

getSelectionType

public int getSelectionType()

Returns:

the selection type

getSelectionId

public int getSelectionId()

Returns:

the selection id

getUserObject

public Object getUserObject()

Returns:

the user object