PhantomMacro (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.PhantomMacro

All Implemented Interfaces:
Comparable<PhantomMacro>
```
public class PhantomMacro
extends Object
implements Comparable<PhantomMacro>
```
This class contains the Phantom Macro definition and its macro steps.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`PhantomMacro.MacroStep` The definition of macro steps.
`class`	`PhantomMacro.PhantomMacroThread` This starter class just starts the play back of the macro in another thread.
`class`	`PhantomMacro.WaitAnyScreen` The definition of macro steps.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`comment` The comment of the macro.
`PhantomMacro.MacroStep[]`	`steps` The macro steps.
`static int`	`TYPE_CALLDLG` Call another macro.
`static int`	`TYPE_CALLREXX` Call REXX (not supported).
`static int`	`TYPE_CHANGESESSION` Change session.
`static int`	`TYPE_COMMENT` Note.
`static int`	`TYPE_DEBUG` Output text.
`static int`	`TYPE_JMPDLG` Jump to macro.
`static int`	`TYPE_NOP` No operation.
`static int`	`TYPE_PAUSETIMER` Pause timer.
`static int`	`TYPE_SENDFILEPSW` Send user ID password (not supported).
`static int`	`TYPE_SENDKEY` Send key.
`static int`	`TYPE_SENDPARAM` Send parameter.
`static int`	`TYPE_SENDPASSWORD` Send password (not supported).
`static int`	`TYPE_SENDSTRING` Send a character string.
`static int`	`TYPE_SETTIMEOUT` Set time-out.
`static int`	`TYPE_STARTTIMER` Start timer.
`static int`	`TYPE_STOPTIMER` Stop timer.
`static int`	`TYPE_WAIT` Delay (seconds).
`static int`	`TYPE_WAITANYSCR` Wait for screens.
`static int`	`TYPE_WAITSCREEN` Wait for a screen.
`static int`	`WAS_CALLDLG` WaitAnyScreen: Call another macro.
`static int`	`WAS_DEFAULT` WaitAnyScreen: Default screen: keep on going in this macro.
`static int`	`WAS_JMPDLG` WaitAnyScreen: Jump or branch away to another dialog.
`static int`	`WAS_RC` WaitAnyScreen: A return code that is returned to the potential CallObject issuer.
`static int`	`WAS_REXX` WaitAnyScreen: Call a REXX procedure (not supported).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PhantomMacro o)` Used to sort the Phantom Macros at save.
`String`	`getName()` Gets the name of the macro.
`String`	`playBack(PhantomWorker worker)` Plays back the macro.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_NOP
```
public static final int TYPE_NOP
```
    No operation.
    See Also:
    Constant Field Values
  - TYPE_SETTIMEOUT
```
public static final int TYPE_SETTIMEOUT
```
    Set time-out.
    See Also:
    Constant Field Values
  - TYPE_STARTTIMER
```
public static final int TYPE_STARTTIMER
```
    Start timer.
    See Also:
    Constant Field Values
  - TYPE_STOPTIMER
```
public static final int TYPE_STOPTIMER
```
    Stop timer.
    See Also:
    Constant Field Values
  - TYPE_SENDSTRING
```
public static final int TYPE_SENDSTRING
```
    Send a character string.
    See Also:
    Constant Field Values
  - TYPE_SENDKEY
```
public static final int TYPE_SENDKEY
```
    Send key.
    See Also:
    Constant Field Values
  - TYPE_WAITSCREEN
```
public static final int TYPE_WAITSCREEN
```
    Wait for a screen.
    See Also:
    Constant Field Values
  - TYPE_CHANGESESSION
```
public static final int TYPE_CHANGESESSION
```
    Change session.
    See Also:
    Constant Field Values
  - TYPE_SENDPARAM
```
public static final int TYPE_SENDPARAM
```
    Send parameter.
    See Also:
    Constant Field Values
  - TYPE_SENDPASSWORD
```
public static final int TYPE_SENDPASSWORD
```
    Send password (not supported).
    See Also:
    Constant Field Values
  - TYPE_WAIT
```
public static final int TYPE_WAIT
```
    Delay (seconds).
    See Also:
    Constant Field Values
  - TYPE_PAUSETIMER
```
public static final int TYPE_PAUSETIMER
```
    Pause timer.
    See Also:
    Constant Field Values
  - TYPE_WAITANYSCR
```
public static final int TYPE_WAITANYSCR
```
    Wait for screens.
    See Also:
    Constant Field Values
  - TYPE_CALLREXX
```
public static final int TYPE_CALLREXX
```
    Call REXX (not supported).
    See Also:
    Constant Field Values
  - TYPE_CALLDLG
```
public static final int TYPE_CALLDLG
```
    Call another macro.
    See Also:
    Constant Field Values
  - TYPE_JMPDLG
```
public static final int TYPE_JMPDLG
```
    Jump to macro.
    See Also:
    Constant Field Values
  - TYPE_SENDFILEPSW
```
public static final int TYPE_SENDFILEPSW
```
    Send user ID password (not supported).
    See Also:
    Constant Field Values
  - TYPE_COMMENT
```
public static final int TYPE_COMMENT
```
    Note.
    See Also:
    Constant Field Values
  - TYPE_DEBUG
```
public static final int TYPE_DEBUG
```
    Output text.
    See Also:
    Constant Field Values
  - WAS_DEFAULT
```
public static final int WAS_DEFAULT
```
    WaitAnyScreen: Default screen: keep on going in this macro.
    See Also:
    Constant Field Values
  - WAS_CALLDLG
```
public static final int WAS_CALLDLG
```
    WaitAnyScreen: Call another macro.
    See Also:
    Constant Field Values
  - WAS_JMPDLG
```
public static final int WAS_JMPDLG
```
    WaitAnyScreen: Jump or branch away to another dialog.
    See Also:
    Constant Field Values
  - WAS_REXX
```
public static final int WAS_REXX
```
    WaitAnyScreen: Call a REXX procedure (not supported).
    See Also:
    Constant Field Values
  - WAS_RC
```
public static final int WAS_RC
```
    WaitAnyScreen: A return code that is returned to the potential CallObject issuer.
    See Also:
    Constant Field Values
  - steps
```
public final PhantomMacro.MacroStep[] steps
```
    The macro steps.
  - comment
```
public String comment
```
    The comment of the macro.
- Method Detail
  - getName
```
public String getName()
```
    Gets the name of the macro.
  - playBack
```
public String playBack(PhantomWorker worker)
```
    Plays back the macro. The macro is not yet a thread, but will be created as such using this method, if the calling thread is the main thread.
    Returns:
    String returned by the macro or "0" if a thread was started. If the macro can't be started, "1" is returned.
  - compareTo
```
public int compareTo(PhantomMacro o)
```
    Used to sort the Phantom Macros at save.
    Specified by:
    compareTo in interface Comparable<PhantomMacro>

Class PhantomMacro

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_NOP

TYPE_SETTIMEOUT

TYPE_STARTTIMER

TYPE_STOPTIMER

TYPE_SENDSTRING

TYPE_SENDKEY

TYPE_WAITSCREEN

TYPE_CHANGESESSION

TYPE_SENDPARAM

TYPE_SENDPASSWORD

TYPE_WAIT

TYPE_PAUSETIMER

TYPE_WAITANYSCR

TYPE_CALLREXX

TYPE_CALLDLG

TYPE_JMPDLG

TYPE_SENDFILEPSW

TYPE_COMMENT

TYPE_DEBUG

WAS_DEFAULT

WAS_CALLDLG

WAS_JMPDLG

WAS_REXX

WAS_RC

steps

comment

Method Detail

getName

playBack

compareTo