org.gnu.gnomevte.event
Class CommitEvent

java.lang.Object
  extended by GtkEvent
      extended by org.gnu.gnomevte.event.CommitEvent

public class CommitEvent
extends GtkEvent

An event representing a commit action by a Terminal widget. This event is fired every time that data is sent to the terminal. This normally happens after pasting some text or by interacting with the keyboard.


Nested Class Summary
static class CommitEvent.Type
          Type of a TerminalCommitEvent.
 
Constructor Summary
CommitEvent(java.lang.Object source, EventType type, java.lang.String committedText)
          Constructor for TerminalCommitEvent.
 
Method Summary
 java.lang.String getCommittedText()
          Get's the text that is being committed to the Terminal.
 boolean isOfType(CommitEvent.Type aType)
          This method compares the type of the current event to the one provided as an argument.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommitEvent

public CommitEvent(java.lang.Object source,
                   EventType type,
                   java.lang.String committedText)
Constructor for TerminalCommitEvent.

Parameters:
source - the source of the event.
type - the event type.
committedText - the text that is committed (sent) to the Terminal.
Method Detail

isOfType

public boolean isOfType(CommitEvent.Type aType)
This method compares the type of the current event to the one provided as an argument.

Parameters:
aType - the type to compare to.
Returns:
true if the events are of same type.

getCommittedText

public java.lang.String getCommittedText()
Get's the text that is being committed to the Terminal.

Returns:
the committed text.