|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.eNetwork.beans.HOD.MacroScreens
This class is the collection class for the MacroScreen objects associated with a particular macro. All the screens to be recognized by the Macro bean are contained here.
Generally, this class would be instantiated and the MacroScreen objects would be added. The MacroScreens object could then be added to the Macro bean and the macro played. When the screen appears in the presentation space that matches the MacroScreen object, the MacroAction objects in the MacroActions collection will be executed in sequence.
Note that the Macro bean does this all automatically when it parses a macro file or records user interaction when linked to a Terminal bean. However, if you want to control the contents of a macro at the internal object representation level of the macro, you would use the MacroScreens object and its contained objects.
See Also:ECLScreenDesc
MacroActions
,
MacroAction
,
MacroScreen
,
Macro
, Serialized FormFields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants |
---|
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT |
Constructor Summary | |
---|---|
MacroScreens()
Constructs an empty instance of a MacroScreens object. |
|
MacroScreens(java.util.Vector argScreens)
Constructs a MacroScreens object using the given vector. |
Method Summary | |
---|---|
void |
add(int argIndex,
MacroScreen argMS)
Inserts the macro screen at the given index. |
void |
add(MacroScreen argMS)
Appends the macro screen to the end of the collection. |
void |
clear()
Removes all macro screens from the collection |
java.lang.Object |
clone()
Returns a new instance of MacroScreens with the same state as the current MacroScreens object. |
boolean |
contains(MacroScreen argMS)
Tests to see if the given macro screen is in the collection. |
boolean |
contains(java.lang.String argName)
Tests to see if the given macro screen with given Name is in the collection. |
boolean |
containsStartScreen()
Returns whether the macro screens collection contains at least one start screen. |
boolean |
containsStopScreen()
Returns whether the macro screens collection contains at least one stop screen. |
void |
createVariableBoolean(java.lang.String name,
java.lang.String initValue)
Creates a boolean variable with the given name and initial value for the macro. |
void |
createVariableCustom(java.lang.String name,
java.lang.String type,
java.lang.String initValue)
Creates a custom type variable with the given name, type and initial value for the macro. |
void |
createVariableDouble(java.lang.String name,
java.lang.String initValue)
Creates a double variable with the given name and initial value for the macro. |
void |
createVariableField(java.lang.String name)
Creates a field variable with the given name for the macro. |
void |
createVariableInteger(java.lang.String name,
java.lang.String initValue)
Creates an integer variable with the given name and initial value for the macro. |
void |
createVariableString(java.lang.String name,
java.lang.String initValue)
Creates a string variable with the given name and initial value for the macro. |
void |
defineVariableType(java.lang.String fullName,
java.lang.String shortName)
Defines a custom class to be used as a variable type in the macro. |
java.lang.String |
format(int argType,
boolean displayAll)
Formats the contents of the object into a readable string. |
MacroScreen |
get(int argIndex)
Returns the macro screen at the given index |
java.lang.String |
getAuthor()
Returns the author of the macro. |
MacroScreen |
getByName(java.lang.String argName)
Convenience method that returns a macro screen that has the given Name. |
java.lang.String |
getDate()
Returns the date the macro was created or changed. |
int |
getDelayIfNotEnhancedTN()
Returns delay in milliseconds to be inserted into each OIA notification if the session is not operating in contention-resolution mode. |
java.lang.String |
getDescription()
Returns the description of the macro. |
java.lang.String |
getName()
Returns the name of the macro. |
int |
getPauseTime()
Returns the pause time for the macro. |
int |
getTimeout()
Returns the default next screens timeout value for the macro. |
java.lang.String |
getUniqueName()
Returns a unique screen Name string for a possible MacroScreen object to be added to the collection. |
int |
indexOf(MacroScreen argMS)
Returns the index of the given macro screen. |
boolean |
isEmpty()
Tests to see if the macro screen collection is empty. |
boolean |
isIgnorePauseForEnhancedTN()
Returns if pause actions will be ignored if the session is operating in contention-resolution mode |
boolean |
isInitialPrompt()
Returns whether the Macro bean should scan this macro for prompts at the beginning of play and fire them all at once to prompt listeners. |
boolean |
isSuppressClearEvent()
Returns whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream. |
boolean |
isUseVars()
Returns whether this macro should be scanned for variables and expressions |
void |
remove(int argIndex)
Removes the macro screen at the given index from the collection. |
void |
remove(MacroScreen argMS)
Removes the given macro screen from the collection. |
java.util.Enumeration |
screens()
Returns an enumeration of the macro screens in the collection. |
void |
set(MacroScreen argMS,
int argIndex)
Replaces the macro screen object at the given index in the collection. |
void |
setAuthor(java.lang.String argAuthor)
Sets the author of the macro. |
void |
setDate(java.lang.String argDate)
Sets the date the macro was created or changed. |
void |
setDelayIfNotEnhancedTN(int delay)
Sets delay in milliseconds to be inserted into each OIA notification if the session is not operating in contention-resolution mode |
void |
setDescription(java.lang.String argDesc)
Sets the description of the macro. |
void |
setIgnorePauseForEnhancedTN(boolean argIgnore)
Sets if pause actions should be ignored if the session is operating in contention-resolution mode |
void |
setInitialPrompt(boolean argVal)
Sets whether the Macro bean should scan this macro for prompts at the beginning of play and fire them all at once to prompt listeners. |
void |
setName(java.lang.String argName)
Sets the name of the macro. |
void |
setOwner(Macro mac)
Sets the owner of the action. |
void |
setPauseTime(int argPause)
Sets the pause time for the macro. |
void |
setSuppressClearEvent(boolean argVal)
Sets whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream. |
void |
setTimeout(int argTimeout)
Sets the default next screens timeout value for the macro. |
void |
setUseVars(boolean argVal)
Sets whether this macro should be scanned for variables and expressions |
int |
size()
Returns the number of screens in the macro screen collection. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable |
---|
setAttributes, setError |
Constructor Detail |
public MacroScreens()
public MacroScreens(java.util.Vector argScreens)
argScreens
- Vector of MacroScreen objectsMacroScreen
Method Detail |
public MacroScreen get(int argIndex)
argIndex
- index for the MacroScreen objectpublic void set(MacroScreen argMS, int argIndex)
argMS
- MacroScreen object to place in collectionargIndex
- index for the MacroScreen object The name of the screen must be set to use this methodpublic void add(MacroScreen argMS)
argMS
- MacroScreen object to place in collectionpublic void add(int argIndex, MacroScreen argMS)
argMS
- MacroScreen object to place in collectionargIndex
- index for the MacroScreen objectpublic boolean contains(MacroScreen argMS)
argMS
- MacroScreen object to search forpublic boolean contains(java.lang.String argName)
argName
- MacroScreen object Namepublic java.lang.String getUniqueName()
public boolean isEmpty()
public int size()
public void clear()
public void remove(MacroScreen argMS)
argMS
- MacroScreen object to remove from the collectionMacroScreen.setName(String)
public void remove(int argIndex)
argIndex
- index for the MacroScreen object to removepublic int indexOf(MacroScreen argMS)
argMS
- MacroScreen object to find index ofpublic java.util.Enumeration screens()
public MacroScreen getByName(java.lang.String argName)
argName
- string Name to search forpublic boolean containsStartScreen()
public boolean containsStopScreen()
public java.lang.String getName()
public void setName(java.lang.String argName)
argName
- new name for the macropublic java.lang.String getDescription()
public void setDescription(java.lang.String argDesc)
argDesc
- new macro descriptionpublic java.lang.String getAuthor()
public void setAuthor(java.lang.String argAuthor)
argAuthor
- new macro authorpublic java.lang.String getDate()
public void setDate(java.lang.String argDate)
argDate
- new macro datepublic boolean isInitialPrompt()
public void setInitialPrompt(boolean argVal)
argVal
- if true, Macro bean will prescan for promptspublic boolean isUseVars()
public void setUseVars(boolean argVal)
argVal
- if true, macro will be scanned for variables and expressionspublic boolean isSuppressClearEvent()
This is an advanced feature and the default is false. You may want to set this value to true if you have screens in your application flow that have all blanks in them. If there is a valid blank screen in the macro and clear events are not ignored, it is possible that an ill-behaved host application can send a clear then end of record, a screen recognition event is processed, and the valid blank screen matches when it shouldn't have.
public void setSuppressClearEvent(boolean argVal)
This is an advanced feature and the default is false. You may want to set this value to true if you have screens in your application flow that have all blanks in them. If there is a valid blank screen in the macro and clear events are not ignored, it is possible that an ill-behaved host application can send a clear then end of record, a screen recognition event is processed, and the valid blank screen matches when it shouldn't have.
argVal
- if true, system ignores clear screen commands followed by
end of record indicatorspublic int getTimeout()
public void setTimeout(int argTimeout)
argTimeout
- new timeout value in millisecondspublic int getPauseTime()
public void setPauseTime(int argPause)
argPause
- new pause time in millisecondspublic boolean isIgnorePauseForEnhancedTN()
public void setIgnorePauseForEnhancedTN(boolean argIgnore)
argIgnore
- true to ignore pause actions if operating in contention-resolution mode, false otherwisepublic int getDelayIfNotEnhancedTN()
public void setDelayIfNotEnhancedTN(int delay)
delay
- in millisecondspublic void createVariableString(java.lang.String name, java.lang.String initValue)
name
- name of the variable, in $var_name$ formatinitValue
- initial value of the variable. if null, the default value of "''"
will be usedpublic void createVariableInteger(java.lang.String name, java.lang.String initValue)
name
- name of the variable, in $var_name$ formatinitValue
- initial value of the variable. if null, the default value of 0
will be usedpublic void createVariableDouble(java.lang.String name, java.lang.String initValue)
name
- name of the variable, in $var_name$ formatinitValue
- initial value of the variable. if null, the default value of 0.0
will be usedpublic void createVariableField(java.lang.String name)
name
- name of the variable, in $var_name$ formatpublic void createVariableBoolean(java.lang.String name, java.lang.String initValue)
name
- name of the variable, in $var_name$ formatinitValue
- initial value of the variable. if null, the default value of false
will be usedpublic void createVariableCustom(java.lang.String name, java.lang.String type, java.lang.String initValue)
name
- name of the variable, in $var_name$ formattype
- type of the variable. must have already been created with createVariableType()initValue
- initial value of the variable. if null, the object will be nullpublic void defineVariableType(java.lang.String fullName, java.lang.String shortName)
fullName
- fully qualified name of the classshortName
- short name (nickname) for the class - optionalpublic java.lang.Object clone()
public java.lang.String format(int argType, boolean displayAll)
format
in interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
argType
- reserved, currently only XML strings are supporteddisplayAll
- if true, optional parameters are formatted alsopublic void setOwner(Macro mac)
mac
- new Macro bean owner of the action
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |