All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroActionMessage
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroAction
|
+----com.ibm.eNetwork.beans.HOD.MacroActionMessage
- public class MacroActionMessage
- extends MacroAction
This class represents one message action associated with a MacroScreen
object. For the message action, the Macro bean fires an
event with the message to any registered message listeners.
-
MacroActionMessage()
- Constructs an empty instance of a macro message action.
-
MacroActionMessage(String, String)
- Constucts a functional instance of a macro message action with the given
parameter.
-
execute()
- Executes the macro message action.
-
format(int, boolean)
- Formats the action object's contents into a readable string.
-
getMessage()
- Returns the message text
-
getTitle()
- Returns the title text
-
setAttributes(Hashtable)
- Sets all the basic attributes for the Macro action from the String
contents in the given hash table.
-
setMessage(String)
- Sets the message text.
-
setTitle(String)
- Sets the message title.
MacroActionMessage
public MacroActionMessage()
- Constructs an empty instance of a macro message action.
If you use this constructor, you must call all the set methods of this
class to properly set up the action.
MacroActionMessage
public MacroActionMessage(String argMessage,
String argTitle)
- Constucts a functional instance of a macro message action with the given
parameter.
- Parameters:
- argMessage - message text
- argTitle - title string
execute
public void execute()
- Executes the macro message action.
- Overrides:
- execute in class MacroAction
getMessage
public String getMessage()
- Returns the message text
- Returns:
- message string
setMessage
public void setMessage(String argMessage)
- Sets the message text.
- Parameters:
- argMessage - message string to set
getTitle
public String getTitle()
- Returns the title text
- Returns:
- title string
setTitle
public void setTitle(String argTitle)
- Sets the message title.
- Parameters:
- argTitle - title string to set
format
public String format(int argType,
boolean formatAll)
- Formats the action object's contents into a readable string. Intended
for visual feedback, as 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
setAttributes
public MacroParseEvent setAttributes(Hashtable ht) throws MacroException
- Sets all the basic attributes for the Macro action from the String
contents in the given hash table.
- Parameters:
- ht - hash table that contains string values of each attribute.
Numeric and boolean values are converted from strings.
- Overrides:
- setAttributes in class MacroAction
All Packages Class Hierarchy This Package Previous Next Index