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


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD



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

All Implemented Interfaces:: java.io.Serializable

public class MacroStateEvent
extends com.ibm.eNetwork.beans.HOD.event.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 , Serialized Form


Field Summary
`static int`	`STATE_DISCONNECTED` Macro state constant that when returned from getState(), indicates that the Macro bean is not wired properly.
`static int`	`STATE_EMPTY` Macro state constant that when returned from getState(), indicates that there is no macro currently in the Macro bean.
`static int`	`STATE_INTERNAL_ERROR` State property value.
`static 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.
`static int`	`STATE_PLAY_PAUSED` Macro state constant that when returned from getState(), indicates a macro is playing, but is paused.
`static int`	`STATE_PLAYING` Macro state constant that when returned from getState(), indicates a macro is loaded and running.
`static int`	`STATE_RECORD_ERROR` State property value.
`static int`	`STATE_RECORD_PAUSED` Macro state constant that when returned from getState(), indicates a macro is recording, but is paused.
`static int`	`STATE_RECORDING` Macro state constant that when returned from getState(), indicates a macro is currently being recorded.
`static int`	`STATE_STOPPED` Macro state constant that when returned from getState(), indicates a macro is loaded, but stopped.
`static int`	`STATE_USER_ERROR` State property value.


Constructor Summary
`MacroStateEvent ( Macro src, int s)` Constructs a new MacroStateEvent object.


Method Summary
`com.ibm.eNetwork.ECL.ECLErr`	`getECLErr ()` Retrieve the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR.
`java.lang.String`	`getLine ()` Retrieve the line of the Macro.
`MacroScreen`	`getMacroScreen ()` Return the current MacroScreen object for the state.
`int`	`getState ()` Retrieve the state of the Macro.
`void`	`setECLErr (com.ibm.eNetwork.ECL.ECLErr error)` Set the ECLErr that was the cause of the MacroEvent.STATE_PLAY_ERROR.
`void`	`setLine (java.lang.String str)` Set the line of the Macro.
`void`	`setMacroScreen ( MacroScreen ms)` Set the current MacroScreen object for the state.


Methods inherited from class java.util.EventObject
`getSource, toString`


Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`


Field Detail

STATE_STOPPED



public static final int 
STATE_STOPPED

STATE_PLAYING



public static final int 
STATE_PLAYING

STATE_RECORDING



public static final int 
STATE_RECORDING

STATE_PLAY_PAUSED



public static final int 
STATE_PLAY_PAUSED

STATE_RECORD_PAUSED



public static final int 
STATE_RECORD_PAUSED

STATE_EMPTY



public static final int 
STATE_EMPTY

STATE_DISCONNECTED



public static final int 
STATE_DISCONNECTED

STATE_PLAY_ERROR



public static final int 
STATE_PLAY_ERROR

STATE_RECORD_ERROR



public static final int 
STATE_RECORD_ERROR

STATE_INTERNAL_ERROR



public static final int 
STATE_INTERNAL_ERROR

STATE_USER_ERROR



public static final int 
STATE_USER_ERROR


Constructor Detail

MacroStateEvent



public 
MacroStateEvent(
Macro src,
                       int s)


Method Detail

getState



public int 
getState()

getLine



public java.lang.String 
getLine()

setLine



public void 
setLine(java.lang.String str)

getECLErr



public com.ibm.eNetwork.ECL.ECLErr 
getECLErr()

setECLErr



public void 
setECLErr(com.ibm.eNetwork.ECL.ECLErr error)

setMacroScreen



public void 
setMacroScreen(
MacroScreen ms)

getMacroScreen



public 
MacroScreen 

            getMacroScreen()


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD