All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.event.MacroStateEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroStateEvent

public class MacroStateEvent
extends HODEvent
MacroExtractEvent is fired to MacroRuntimeListeners by Macro when Macro's state changes. This event is useful for controlling GUI feedback implemented on top of Macro.

See Also:
MacroRuntimeListener, Macro

Variable Index

 o STATE_DISCONNECTED
Macro state constant that when returned from getState(), indicates that the Macro bean is not wired properly.
 o STATE_EMPTY
Macro state constant that when returned from getState(), indicates that there is no macro currently in the Macro bean.
 o STATE_INTERNAL_ERROR
State property value.
 o STATE_PLAY_ERROR
Macro state constant that when returned from getState(), indicates that the Macro bean was playing, but the macro failed to complete successfully.
 o STATE_PLAY_PAUSED
Macro state constant that when returned from getState(), indicates a macro is playing, but is paused.
 o STATE_PLAYING
Macro state constant that when returned from getState(), indicates a macro is loaded and running.
 o STATE_RECORD_ERROR
State property value.
 o STATE_RECORD_PAUSED
Macro state constant that when returned from getState(), indicates a macro is recording, but is paused.
 o STATE_RECORDING
Macro state constant that when returned from getState(), indicates a macro is currently being recorded.
 o STATE_STOPPED
Macro state constant that when returned from getState(), indicates a macro is loaded, but stopped.
 o STATE_USER_ERROR
State property value.

Constructor Index

 o MacroStateEvent(Macro, int)
Constructs a new MacroStateEvent object.

Method Index

 o getECLErr()
Retrieve the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR.
 o getLine()
Retrieve the line of the Macro.
 o getMacroScreen()
Return the current MacroScreen object for the state.
 o getState()
Retrieve the state of the Macro.
 o setECLErr(ECLErr)
Set the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR.
 o setLine(String)
Set the line of the Macro.
 o setMacroScreen(MacroScreen)
Set the current MacroScreen object for the state.

Variables

 o STATE_STOPPED
 public static final int STATE_STOPPED
Macro state constant that when returned from getState(), indicates a macro is loaded, but stopped.

 o STATE_PLAYING
 public static final int STATE_PLAYING
Macro state constant that when returned from getState(), indicates a macro is loaded and running.

 o STATE_RECORDING
 public static final int STATE_RECORDING
Macro state constant that when returned from getState(), indicates a macro is currently being recorded.

 o STATE_PLAY_PAUSED
 public static final int STATE_PLAY_PAUSED
Macro state constant that when returned from getState(), indicates a macro is playing, but is paused.

 o STATE_RECORD_PAUSED
 public static final int STATE_RECORD_PAUSED
Macro state constant that when returned from getState(), indicates a macro is recording, but is paused.

 o STATE_EMPTY
 public static final int STATE_EMPTY
Macro state constant that when returned from getState(), indicates that there is no macro currently in the Macro bean.

 o STATE_DISCONNECTED
 public static final int STATE_DISCONNECTED
Macro state constant that when returned from getState(), indicates that the Macro bean is not wired properly.

 o STATE_PLAY_ERROR
 public static final int STATE_PLAY_ERROR
Macro state constant that when returned from getState(), indicates that the Macro bean was playing, but the macro failed to complete successfully.

 o STATE_RECORD_ERROR
 public static final int STATE_RECORD_ERROR
State property value. Macro is stopped due to an error during recording. This is the same as STATE_STOPPED with the added information that the most recent record command failed to complete.

 o STATE_INTERNAL_ERROR
 public static final int STATE_INTERNAL_ERROR
State property value. Macro is stopped due to an internal error. This is the same as STATE_STOPPED.

 o STATE_USER_ERROR
 public static final int STATE_USER_ERROR
State property value. Macro is encountered a user error. This is the same as STATE_STOPPED.

Constructors

 o MacroStateEvent
 public MacroStateEvent(Macro src,
                        int s)
Constructs a new MacroStateEvent object.

Methods

 o getState
 public int getState()
Retrieve the state of the Macro.

Returns:
int Macro state.
 o getLine
 public String getLine()
Retrieve the line of the Macro. This will be null except for error states.

Returns:
String Macro line
 o setLine
 public void setLine(String str)
Set the line of the Macro. This will be used only for error states.

Parameters:
String - Macro line
 o getECLErr
 public ECLErr getECLErr()
Retrieve the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR. This will be null if the MacroEvent.STATE_PLAY_ERROR was not caused by a thrown ECLErr.

Returns:
ECLErr ECLErr
 o setECLErr
 public void setECLErr(ECLErr error)
Set the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR. This will only be set if the MacroEvent.STATE_PLAY_ERROR was caused by a thrown ECLErr.

Parameters:
ECLErr - ECLErr
 o setMacroScreen
 public void setMacroScreen(MacroScreen ms)
Set the current MacroScreen object for the state.

Parameters:
ms - MacroScreen
 o getMacroScreen
 public MacroScreen getMacroScreen()
Return the current MacroScreen object for the state. Especially useful for discovering what the last screen was when Macro stopped playing.

Returns:
MacroScreen

All Packages  Class Hierarchy  This Package  Previous  Next  Index