ScriptingInfoEvent (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- java.util.EventObject
- - adams.gui.event.ScriptingInfoEvent

All Implemented Interfaces:

Serializable
```
public class ScriptingInfoEvent
extends EventObject
```
Gets sent when a scripting event happened.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_Cmd
the command that was run.
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor Description

ScriptingInfoEvent(AbstractScriptingEngine engine, String cmd)
Initializes the object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCmd()`	Returns the command that was run.
`AbstractScriptingEngine`	`getScriptingEngine()`	Returns the scripting engine that triggered the event.
`boolean`	`hasCmd()`	Checks whether a command is available or not (= idle).
`String`	`toString()`	Returns a string representation of the event 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

- Field Detail
  - m_Cmd
```
protected String m_Cmd
```
    the command that was run.
- Constructor Detail
  - ScriptingInfoEvent
```
public ScriptingInfoEvent(AbstractScriptingEngine engine,
                          String cmd)
```
    Initializes the object.
    
    Parameters:
    
    engine - the scripting engine that ran the command
    
    cmd - the command that was run
- Method Detail
  - getScriptingEngine
```
public AbstractScriptingEngine getScriptingEngine()
```
    Returns the scripting engine that triggered the event.
    
    Returns:
    
    the engine
  - hasCmd
```
public boolean hasCmd()
```
    Checks whether a command is available or not (= idle).
    
    Returns:
    
    true if command available
  - getCmd
```
public String getCmd()
```
    Returns the command that was run.
    
    Returns:
    
    the command
  - toString
```
public String toString()
```
    Returns a string representation of the event object.
    
    Overrides:
    
    toString in class EventObject
    
    Returns:
    
    the string representation