All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroActionPause
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroAction
|
+----com.ibm.eNetwork.beans.HOD.MacroActionPause
- public class MacroActionPause
- extends MacroAction
This class represents one pause action associated with a MacroScreen
object. The pause action is used for inserting a pause during the
execution of macro actions.
-
MacroActionPause()
- Constructs an empty instance of a macro pause.
-
MacroActionPause(long)
- Constructs a functional instance of a macro pause with the given
parameter.
-
execute()
- Executes the pause action.
-
format(int, boolean)
- Formats the action object's contents into a readable string.
-
getTimeout()
- Returns the duration of the pause action.
-
halt()
- Halts the pause action.
-
setTimeout(long)
- Sets the duration of the pause action.
MacroActionPause
public MacroActionPause()
- Constructs an empty instance of a macro pause.
If you use this constructor you must call all the set methods of this
class to properly set up the action.
MacroActionPause
public MacroActionPause(long argDuration)
- Constructs a functional instance of a macro pause with the given
parameter.
- Parameters:
- argDuration - pause duration in milliseconds
execute
public void execute()
- Executes the pause action.
- Overrides:
- execute in class MacroAction
halt
public void halt()
- Halts the pause action.
- Overrides:
- halt in class MacroAction
setTimeout
public void setTimeout(long argTimeout)
- Sets the duration of the pause action. The default pause is 10000
milliseconds (10 seconds).
- Parameters:
- argTimeout - new pause duration in milliseconds
getTimeout
public long getTimeout()
- Returns the duration of the pause action.
- Returns:
- pause duration for the action
format
public String format(int argType,
boolean formatAll)
- Formats the action object's contents into a readable string. Intended
for visual feedback, like with the MacroDebugActionEvent class.
- Parameters:
- argType - reserved, currently only XML strings are supported
- formatAll - if true, optional parameters will be formatted also
- Returns:
- formatted string that reflects the contents of the action
- Overrides:
- format in class MacroAction
All Packages Class Hierarchy This Package Previous Next Index