com.retek.commons.gui.event
Class RActionEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bycom.retek.commons.gui.event.RActionEvent
All Implemented Interfaces:
java.io.Serializable

public class RActionEvent
extends java.util.EventObject

This class represents a RActionEvent. It defines a means of knowing the event source, event number, event command and associated event data.

Retek Inc. Copyright (c) 2002

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
RActionEvent(java.lang.Object source, int number)
          Returns new RActionEvent object.
RActionEvent(java.lang.Object source, int number, java.lang.Object eventData)
          Returns new RActionEvent object.
RActionEvent(java.lang.Object source, int number, java.lang.String text)
          Returns new RActionEvent object.
RActionEvent(java.lang.Object source, java.lang.String command)
          Returns new RActionEvent object.
RActionEvent(java.lang.Object source, java.lang.String command, java.lang.Object eventData)
          Returns new RActionEvent object.
RActionEvent(java.lang.Object source, java.lang.String command, java.lang.String text)
          Returns new RActionEvent object.
 
Method Summary
 boolean getBooleanEventData()
          Retrieves the event data as a boolean value.
 java.lang.String getEventCommand()
          Retrieves the event command.
 java.lang.Object getEventData()
          Retrieves the event data.
 int getEventNumber()
          Retrieves the event number.
 java.lang.String getEventText()
          Retrieves the event text.
 boolean isEvent(int number)
          Returns whether or not this event matches an event number.
 boolean isEvent(java.lang.String command)
          Returns whether or not this event matches an event command.
 void setEventCommand(java.lang.String command)
          Sets the event command.
 void setEventData(java.lang.Object data)
          Sets the event data.
 void setEventNumber(int number)
          Sets the event number.
 void setEventText(java.lang.String text)
          Sets an event string.
 java.lang.String toString()
          A description of the object.
 
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

RActionEvent

public RActionEvent(java.lang.Object source,
                    java.lang.String command)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
command - An event command.

RActionEvent

public RActionEvent(java.lang.Object source,
                    int number)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
number - An event identifier.

RActionEvent

public RActionEvent(java.lang.Object source,
                    java.lang.String command,
                    java.lang.String text)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
command - An event command.
text - A text string to associate with the event.

RActionEvent

public RActionEvent(java.lang.Object source,
                    int number,
                    java.lang.String text)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
number - An event number.
text - A text string to associate with the event.

RActionEvent

public RActionEvent(java.lang.Object source,
                    java.lang.String command,
                    java.lang.Object eventData)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
command - An event command.
eventData - An object containing data to be transmitted with the event.

RActionEvent

public RActionEvent(java.lang.Object source,
                    int number,
                    java.lang.Object eventData)
Returns new RActionEvent object.

Parameters:
source - The object that generated the event.
number - An event number.
eventData - An object containing data to be transmitted with the event.
Method Detail

setEventNumber

public void setEventNumber(int number)
Sets the event number.

Parameters:
number - The event number.

getEventNumber

public int getEventNumber()
Retrieves the event number.

Returns:
The event number.

setEventCommand

public void setEventCommand(java.lang.String command)
Sets the event command.


getEventCommand

public java.lang.String getEventCommand()
Retrieves the event command.

Returns:
The event command.

isEvent

public boolean isEvent(int number)
Returns whether or not this event matches an event number.

Parameters:
number - An event number.
Returns:
True if the event matches the event number, false if it does not.

isEvent

public boolean isEvent(java.lang.String command)
Returns whether or not this event matches an event command.

Parameters:
command - An event command.
Returns:
True if the event matches the event command, false if it does not.

setEventText

public void setEventText(java.lang.String text)
Sets an event string. This is used to store an event data that is a string.

Parameters:
text - A text string to assign to the event.

getEventText

public java.lang.String getEventText()
Retrieves the event text.

Returns:
The event text.

setEventData

public void setEventData(java.lang.Object data)
Sets the event data.

Parameters:
data - The event data.

getEventData

public java.lang.Object getEventData()
Retrieves the event data.

Returns:
The event data.

getBooleanEventData

public boolean getBooleanEventData()
Retrieves the event data as a boolean value. This method returns false if the event data is not a boolean value.

Returns:
True if the event data represents Boolean.TRUE, false if not.

toString

public java.lang.String toString()
A description of the object.



Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28