com.ibm.eNetwork.beans.HOD
Class MacroManager

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ibm.eNetwork.HOD.common.gui.HPanel
                                |
                                +--com.ibm.eNetwork.beans.HOD.HODPanelBean
                                      |
                                      +--com.ibm.eNetwork.beans.HOD.MacroManager
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.lang.Cloneable, CommListener, com.ibm.eNetwork.ECL.ECLConstants, java.util.EventListener, java.io.Externalizable, GUIListener, com.ibm.eNetwork.HOD.help.HelpSource, com.ibm.eNetwork.HOD.common.HODConstants, java.awt.image.ImageObserver, java.awt.event.ItemListener, MacroDebugListener, MacroIOProvider, com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf, MacroParseListener, MacroRuntimeListener, java.awt.MenuContainer, java.beans.PropertyChangeListener, ScreenListener, ScreenMouseListener, SendKeyListener, java.io.Serializable, TraceProducer, java.awt.event.WindowListener

public class MacroManager
extends HODPanelBean
implements SendKeyListener, CommListener, ScreenListener, java.awt.event.ActionListener, java.awt.event.WindowListener, com.ibm.eNetwork.ECL.ECLConstants, com.ibm.eNetwork.HOD.help.HelpSource, com.ibm.eNetwork.HOD.common.HODConstants, java.awt.event.ItemListener, MacroRuntimeListener, MacroParseListener, MacroDebugListener, MacroIOProvider, com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf, ScreenMouseListener, GUIListener

The MacroManager bean is a Graphical User Interface for creating, playing, and managing macros when it is wired to either a Terminal bean or a Session bean.

MacroManager is a button bar (toolbar) that lets you take full advantage of the recording and playing capabilities of the Macro bean. You can do simple or advanced recording of a macro.

With simple recording, general and reliable screen recognition will be used automatically in the macro(s). This screen recognition will take full advantage of the screen recognition technology in the IBM Host Access Class Library.

With advanced recording, you can specifically tailor the screen matching to your host application screens. You can define characteristics of a screen by number of fields, number of input fields, cursor position, keywords, and the Operator Information Area (OIA) state.

You can also insert prompts into the macro with advanced recording. These prompts can be defined as either password or normal display and will automatically place the text the user inputs into the prompt dialog during playback. The final feature of advanced recording is inserting extracts into a macro. When the extract button is toggled down, you may mark any part of the Presentation Space of the Terminal or Screen bean you are wired to and the area marked is retrieved and fired in an event during playback.

MacroManager contains a list of all macros currently available through the connected MacroIOProvider (see below). You may choose any macro from the list to play, record (overwrite or append), edit, and delete.

IMPORTANT: It is essential that an object which implements MacroIOProvider be wired to this bean. Without an IO provider this bean will disable all functions. MacroManager does not perform its own file I/O. Instead, it defers it to the application surrounding MacroManager. MacroIOProviders are responsible for listing all available macros and saving and retrieving those macros from persistent storage.

Properties

The following table lists the properties of the MacroManager Bean:

* - Properties with type "enum" are String types that accept a specific set of string values. The valid values for an enum property can be obtained by calling the list <property name> method. The set method for enum properties validates the value before any changes are accepted, and a PropertyVetoException is thrown if an incorrect value is given.

Note: All properties are bound and vetoable. A PropertyChangeEvent is fired to all PropertyChangeListeners after a property is changed. A vetoable PropertyChangeEvent is fired to all VetoableChangeListeners before a property is changed. VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

Property Name Type Default Access
recordEnabled boolean true read/write
advRecordEnabled boolean true read/write
buttonTextVisible boolean true read/write
recordUI boolean false read/write
state int STATE_DISCONNECTED read

Events Fired

Event Type Fired To Event Handler Method
MacroPromptEvent - Fired when a macro contains prompt commands. Any MacroRuntimeListener macroPromptEvent(MacroPromptEvent)
MacroExtractEvent - Fired when a macro contains extract commands. Any MacroRuntimeListener macroExtractEvent(MacroExtractEvent)
MacroStateEvent - Fired when a macro changes state. Any MacroRuntimeListener macroStateEvent(MacroStateEvent)
PropertyChangeEvent - Fired when a property of the Bean is changed. Any PropertyChangeListener propertyChange(propertyChangeEvent)
Vetoable PropertyChangeEvent - Fired when a vetoable property of the Bean is changed. Any VetoableChangeListener vetoableChange(PropertyChangeEvent)

Events Accepted

Event Type Fired From Event Handler Method
CommEvent Terminal, Session commEvent(commEvent)
SendKeyEvent Terminal, Screen sendKeyEvent(SendKeyEvent)
ScreenEvent Terminal, Screen boxSelected(ScreenEvent)

Class Inheritance

The libraries containing this class are available in two versions: java2 and jdk1.1.8. This class document represents a compilation using Java 2 and its core libraries. The class inheritance scheme is shown above.

The alternative library was compiled with JDK 1.1.8. The result is a slightly different derivation, illustrated in this following class inheritance fragment.

         |
         +--java.awt.Container
               |
               +--java.awt.Panel
                     |
                     +--com.ibm.eNetwork.HOD.common.gui.HPanel
                           |
                           +--
 

See Also:
Macro, MacroIOProvider, Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
static java.lang.String ADVRECORD_ENABLED
          AdvRecordEnabled property keyword.
static java.lang.String BUTTON_TEXT_VISIBLE
          ButtonTextVisible property keyword.
static java.lang.String MACRO_LIST
          MacroList property keyword.
static java.lang.String RECORD_ENABLED
          RecordEnabled property keyword.
static java.lang.String RECORD_UI
          RecordUI property keyword.
static java.lang.String STATE
          State property keyword.
 
Fields inherited from class com.ibm.eNetwork.beans.HOD.HODPanelBean
BEAN_VERSION_STRING, TRACE_LEVEL, TRACE_MAXIMUM, TRACE_MINIMUM, TRACE_NONE, TRACE_NORMAL
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface com.ibm.eNetwork.ECL.ECLConstants
ALL_FIELDS, ALL_PLANES, ALPHANUM_FIELD, ALTCUR_STR, ALTVIEW_STR, ATTN_STR, ATTR_5250_ALPHA_ONLY, ATTR_5250_ALPHANUM, ATTR_5250_ALPHANUM_MASK, ATTR_5250_BIDI_RTL, ATTR_5250_BRIGHT, ATTR_5250_DBCS_KATAKANA, ATTR_5250_DISPLAY, ATTR_5250_MAG_STRIPE, ATTR_5250_MODIFIED, ATTR_5250_NORMAL, ATTR_5250_NUM_ONLY, ATTR_5250_NUM_PLUS, ATTR_5250_NUM_SHIFT, ATTR_5250_NUM_SIGNED, ATTR_5250_PROTECTED, ATTR_ALPHANUM, ATTR_DISPLAY1, ATTR_DISPLAY2, ATTR_MDT, ATTR_PROTECTED, AUTOPUSH_STR, AUTOREV_STR, BACKSP_STR, BACKTAB_STR, BACKTABWORD_STR, BASE_STR, BEGINFLD_STR, BIDI_MODE_OFF_STR, BIDI_MODE_ON_STR, BIDIL_STR, BLUE_3270, CANCELPJOB_STR, CLEAR_STR, CLEARRECT_STR, CLOSE_STR, COLOR_ATTRIBUTES_PLANE, COLOR_PLANE, COLUMNHEAD_STR, CONTEXT_DISP_STR, CONTINUEPJOB_STR, COPY_STR, COPY_TABLE_STR, COPYALL_STR, COPYAPPEND_STR, CRSEL_STR, CSD_STR, CURDOWN_STR, CURLEFT_STR, CURRIGHT_STR, CURSOR_DIRECTION_STR, CURUP_STR, CUT_STR, DB_CA_EXIST, DB_CLEAR, DB_DB1, DB_DBCS, DB_DBHIGH, DB_DEAD, DB_MIX, DB_SI, DB_SO, DB_SOSI_EXIST, DBATTR_DEFAULT, DBATTR_EITHER, DBATTR_ONLY, DBATTR_OPEN, DBATTR_PURE, DBCS_PLANE, DBCSINP_STR, DBDEFALT, DEF_3270, DELCHAR_STR, DELWORD_STR, DISPLAYABLE_FIELD, DSPSOSI_STR, DUP_CHAR, DUP_STR, EBC_SI, EBC_SO, ENDLINE_STR, ENDPUSH_STR, ENTER_STR, ENTERRESET_STR, ERASEEOF_STR, ERASEFLD_STR, ERASEINPUT_STR, EXFIELD_PLANE, EXT_ATTR_3270_APL, EXT_ATTR_3270_BLINK, EXT_ATTR_3270_CHAR, EXT_ATTR_3270_DBCS, EXT_ATTR_3270_EBCDIC, EXT_ATTR_3270_REVERSE, EXT_ATTR_3270_UNDERLINE, EXT_ATTR_5250_BLINK, EXT_ATTR_5250_COLUMN_SEP, EXT_ATTR_5250_REVERSE, EXT_ATTR_5250_UNDERLINE, EXT_BLINK, EXT_COL_SEP, EXT_D_BOTH, EXT_D_LEFT, EXT_D_OVER, EXT_D_RIGHT, EXT_D_UNDER, EXT_DBCS, EXT_EFA_APL_SET, EXT_EFA_FG_SET, EXT_G_ALL, EXT_G_LEFT, EXT_G_OVER, EXT_G_RIGHT, EXT_G_UNDER, EXT_LINEATTR_CHECK, EXT_LINEATTR_DBLWID, EXT_LINEATTR_DBLWID_DBLHT_BOT, EXT_LINEATTR_DBLWID_DBLHT_TOP, EXT_LINEATTR_NORMAL, EXT_NON_ERASEABLE, EXT_NORMAL, EXT_OPAQUE, EXT_REVERSE, EXT_UNDERLN, F1_STR, F10_STR, F11_STR, F12_STR, F13_STR, F14_STR, F15_STR, F16_STR, F17_STR, F18_STR, F19_STR, F2_STR, F20_STR, F21_STR, F22_STR, F23_STR, F24_STR, F3_STR, F4_STR, F5_STR, F6_STR, F7_STR, F8_STR, F9_STR, FIELD_MARK, FIELD_PLANE, FINAL_STR, FLDBASE_STR, FLDEXT_STR, FLDMINUS_STR, FLDMRK_STR, FLDPLUS_STR, FLDREV_STR, FLDSHAPE_STR, FORMFEED_STR, FWDTAB_STR, GRCURSOR_STR, GREEN_3270, GRID_PLANE, HELP_STR, HILIGHT_FIELD, HINDIL_STR, HOME_STR, HOST_PLANE, HOSTPRT_STR, INITIAL_STR, INSERT_STR, ISOLATED_STR, JUMP_STR, KEYPAD0_STR, KEYPAD1_STR, KEYPAD2_STR, KEYPAD3_STR, KEYPAD4_STR, KEYPAD5_STR, KEYPAD6_STR, KEYPAD7_STR, KEYPAD8_STR, KEYPAD9_STR, KEYPADCOMMA_STR, KEYPADDOT_STR, KEYPADENTER_STR, KEYPADMINUS_STR, LATINL_STR, LOGICAL_DISP_STR, LOLIGHT_FIELD, MARKDOWN_STR, MARKLEFT_STR, MARKRIGHT_STR, MARKUP_STR, MIDDLE_STR, MODIFIED_FIELD, MOVEDOWN_STR, MOVELEFT_STR, MOVERIGHT_STR, MOVEUP_STR, MSR_STR, NATIONAL_DISP_STR, NEUT_3270, NEWLINE_STR, NEXTWORD_STR, NLS_PLANE, NO_TIMEOUT, NOMINAL_DISP_STR, NON_DISPLAYABLE_FIELD, NON_PENDETECTABLE_FIELD, NUMCONTEXT_STR, NUMERIC_FIELD, NUMNATIONAL_STR, NUMNOMINAL_STR, OICR_STR, PA1_STR, PA2_STR, PA3_STR, PAGEDWN_STR, PAGEUP_STR, PASTE_STR, PASTENEXT_STR, PENDETECTABLE_FIELD, PINK_3270, PREVIOUSWORD_STR, PRINT_STR, PROTECTED_FIELD, PRTESTPAGE_STR, PUSH_STR, RAWTEXT_PLANE, RED_3270, RESET_STR, RETRYPRT_STR, ROUNDTRIP_OFF_STR, ROUNDTRIP_ON_STR, RULE_STR, SCREENREV_STR, SEARCH_BACKWARD, SEARCH_FORWARD, SELECTALL_STR, SHIFT_F1_STR, SHIFT_F10_STR, SHIFT_F11_STR, SHIFT_F12_STR, SHIFT_F13_STR, SHIFT_F14_STR, SHIFT_F15_STR, SHIFT_F16_STR, SHIFT_F17_STR, SHIFT_F18_STR, SHIFT_F19_STR, SHIFT_F2_STR, SHIFT_F20_STR, SHIFT_F3_STR, SHIFT_F4_STR, SHIFT_F5_STR, SHIFT_F6_STR, SHIFT_F7_STR, SHIFT_F8_STR, SHIFT_F9_STR, SMARTORDERING_OFF_STR, SMARTORDERING_ON_STR, STARTMAC_STR, SYSREQ_STR, TABWORD_STR, TEST_STR, TEXT_PLANE, THAIL_STR, TOGGLEHEB_STR, TURQ_3270, TXTORL2R_STR, TXTORR2L_STR, TXTTYPEL_STR, TXTTYPEV_STR, UNMARK_STR, UNMODIFIED_FIELD, UNPROTECTED_FIELD, VISUAL_DISP_STR, VTPRINTCONVERT_STR, WORDLFT_STR, WORDRGT_STR, YELLOW_3270
 
Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, 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_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_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
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
MacroManager()
          Constructs a MacroManager bean.
MacroManager(Macro mac)
          Constructs a MacroManager bean and sets the Macro bean contained by MacroManager.
MacroManager(java.util.Properties p)
          Constructs a MacroManager bean from a Properties object.
 
Method Summary
 void addMacroDebugListener(MacroDebugListener listener)
          Adds the given MacroDebugListener to list of listeners.
 void addMacroParseListener(MacroParseListener listener)
          Adds the given MacroParseListener to list of listeners.
 void addMacroRuntimeListener(MacroRuntimeListener listener)
          Adds the given MacroRuntimeListener to list of listeners.
 java.lang.Object clone()
          Returns a new instance of MacroManager with the same state as the current one.
 Macro getMacroBean()
          Returns the Macro object contained by MacroManager.
 java.util.Vector getMacroList()
          Returns the list of currently available macros.
 int getState()
          Returns the state of the current macro.
 java.lang.String getTraceName()
          Returns a trace identifier for this bean
 boolean isAdvRecordEnabled()
          Returns advanced recording capabilities state of MacroManager.
 boolean isButtonTextVisible()
          Returns the text visibility state of the text in the buttons of MacroManager.
 boolean isRecordEnabled()
          Returns recording capabilities state of MacroManager.
 boolean isRecordUI()
          Returns whether the Macro will record user interface events on the Terminal bean.
 void pause()
          Toggles pause recording or playing the macro.
 void play()
          Toggles the play state of the current macro.
 void record()
          Starts recording a macro or resumes recording a paused macro.
 void removeMacroDebugListener(MacroDebugListener listener)
          Removes the given MacroDebugListener from list of listeners.
 void removeMacroIOProvider(MacroIOProvider o)
          Removes the given MacroIOProvider from MacroManager.
 void removeMacroParseListener(MacroParseListener listener)
          Removes the given MacroParseListener from the list of listeners.
 void removeMacroRuntimeListener(MacroRuntimeListener listener)
          Removes the given MacroRuntimeListener from list of listeners.
 void setAdvRecordEnabled(boolean advrec)
          Turns off/on advanced recording capabilities of MacroManager.
 void setButtonTextVisible(boolean state)
          Sets the text visibility state of the text in the buttons of MacroManager.
 void setMacroBean(Macro val)
          Sets the Macro object contained by MacroManager.
 void setMacroIOProvider(MacroIOProvider o)
          Sets the given MacroIOProvider for MacroManager.
 void setMacroList(java.util.Vector propList)
          Sets the list of currently available macros.
 void setPrompts(MacroPrompts macPrompts)
          Sets the macro prompts.
 void setRecordEnabled(boolean rec)
          Turns off/on recording capabilities of MacroManager.
 void setRecordUI(boolean newVal)
          Sets whether the Macro will record user interface events on the Terminal bean.
 void setSelectedMacro(java.lang.String name)
          Sets the macro with the given name to the current macro in MacroManager.
 void stop()
          Stops recording or playing the macro.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.HODPanelBean
addPropertyChangeListener, addTraceListener, addVetoableChangeListener, dispose, getComponent, getFunction, getProperties, getTraceLevel, propertyChange, readExternal, removePropertyChangeListener, removeTraceListener, removeVetoableChangeListener, setProperties, setTraceLevel, toString, writeExternal
 
Methods inherited from class com.ibm.eNetwork.HOD.common.gui.HPanel
add, createAssociation, paintComponent, setAccessDesc, setAccessibleName
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.SendKeyListener
sendKeys
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.CommListener
CommEvent
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.ScreenListener
boxSelected, boxUnSelected, URLSelected
 
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
 
Methods inherited from interface java.awt.event.WindowListener
windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened
 
Methods inherited from interface com.ibm.eNetwork.HOD.help.HelpSource
addHelpListener, fireHelpEvent, getHelpContext, removeHelpListener
 
Methods inherited from interface java.awt.event.ItemListener
itemStateChanged
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener
macroErrorEvent, macroExtractEvent, macroMessageEvent, macroPromptEvent, macroStateEvent, macroTraceEvent
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroParseListener
parseFailed, parsePassed
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.MacroDebugListener
executeAction, macroDebugStart, macroDebugStop, screensCompared
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.MacroIOProvider
getMacro, listMacros, putMacro, removeMacro
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf
addFocusListener, addHelpListener, dispose, isVisible, removeFocusListener, removeHelpListener, setVisible
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.ScreenMouseListener
mouseEvent
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.event.GUIListener
GUIEvent
 

Field Detail

RECORD_ENABLED

public static final java.lang.String RECORD_ENABLED
RecordEnabled property keyword.

ADVRECORD_ENABLED

public static final java.lang.String ADVRECORD_ENABLED
AdvRecordEnabled property keyword.

STATE

public static final java.lang.String STATE
State property keyword.

MACRO_LIST

public static final java.lang.String MACRO_LIST
MacroList property keyword.

BUTTON_TEXT_VISIBLE

public static final java.lang.String BUTTON_TEXT_VISIBLE
ButtonTextVisible property keyword.

RECORD_UI

public static final java.lang.String RECORD_UI
RecordUI property keyword.
Constructor Detail

MacroManager

public MacroManager()
Constructs a MacroManager bean.

MacroManager

public MacroManager(Macro mac)
Constructs a MacroManager bean and sets the Macro bean contained by MacroManager.
Parameters:
mac - Macro bean object to set in MacroManager

MacroManager

public MacroManager(java.util.Properties p)
             throws java.beans.PropertyVetoException
Constructs a MacroManager bean from a Properties object.
Throws:
java.beans.PropertyVetoException - Thrown if error in setting property
Method Detail

getMacroBean

public Macro getMacroBean()
Returns the Macro object contained by MacroManager.
Returns:
Macro object in the MacroManager object

setMacroBean

public void setMacroBean(Macro val)
                  throws MacroException
Sets the Macro object contained by MacroManager.
Parameters:
val - new Macro object for the MacroManager object
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.

addMacroDebugListener

public void addMacroDebugListener(MacroDebugListener listener)
                           throws MacroException
Adds the given MacroDebugListener to list of listeners.
Parameters:
listener - The MacroDebugListener to be added
Throws:
MacroException - thrown if an incorrect parameter is passed or if Macro experiences an internal error
See Also:
removeMacroDebugListener(com.ibm.eNetwork.beans.HOD.event.MacroDebugListener)

removeMacroDebugListener

public void removeMacroDebugListener(MacroDebugListener listener)
                              throws MacroException
Removes the given MacroDebugListener from list of listeners.
Parameters:
listener - The MacroDebugListener to be removed
Throws:
MacroException - thrown if an incorrect parameter is passed or if Macro experiences an internal error
See Also:
addMacroDebugListener(com.ibm.eNetwork.beans.HOD.event.MacroDebugListener)

addMacroRuntimeListener

public void addMacroRuntimeListener(MacroRuntimeListener listener)
Adds the given MacroRuntimeListener to list of listeners.
Specified by:
addMacroRuntimeListener in interface com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf
Parameters:
listener - The MacroRuntimeListener to be added
See Also:
removeMacroRuntimeListener(com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener)

removeMacroRuntimeListener

public void removeMacroRuntimeListener(MacroRuntimeListener listener)
                                throws MacroException
Removes the given MacroRuntimeListener from list of listeners.
Specified by:
removeMacroRuntimeListener in interface com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf
Parameters:
listener - The MacroRuntimeListener to be removed
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.
See Also:
addMacroRuntimeListener(com.ibm.eNetwork.beans.HOD.event.MacroRuntimeListener)

addMacroParseListener

public void addMacroParseListener(MacroParseListener listener)
                           throws MacroException
Adds the given MacroParseListener to list of listeners.
Parameters:
listener - The MacroParseListener to be added
Throws:
MacroException - thrown if an incorrect parameter is passed or if Macro experiences an internal error
See Also:
removeMacroParseListener(com.ibm.eNetwork.beans.HOD.event.MacroParseListener)

removeMacroParseListener

public void removeMacroParseListener(MacroParseListener listener)
                              throws MacroException
Removes the given MacroParseListener from the list of listeners.
Parameters:
listener - The MacroParseListener to be removed
Throws:
MacroException - thrown if an incorrect parameter is passed or if Macro experiences an internal error
See Also:
addMacroParseListener(com.ibm.eNetwork.beans.HOD.event.MacroParseListener)

setMacroIOProvider

public void setMacroIOProvider(MacroIOProvider o)
                        throws MacroException
Sets the given MacroIOProvider for MacroManager. One and only one provider may be attached to MacroManager at a time. MacroManager has a default MacroIOProvider implementation internally implemented that saves, retrieves, and deletes macros in the directory from which the class was loaded. This internal MacroIOProvider is active if no external MacroIOProvider is set.

An object that implements the MacroIOProvider interface is responsible for providing MacroManager with its Macros. It is also responsible for saving macros that MacroManager records. MacroManager purposefully does not perform any file I/O. It was designed so to allow for the maximum amount of flexibility concerning input and output. See MacroIOProvider for a more detailed discussion.

Parameters:
o - The MacroIOProvider to be added.
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.
See Also:
removeMacroIOProvider(com.ibm.eNetwork.beans.HOD.MacroIOProvider), MacroIOProvider

removeMacroIOProvider

public void removeMacroIOProvider(MacroIOProvider o)
                           throws MacroException
Removes the given MacroIOProvider from MacroManager.
Parameters:
listener - The MacroIOProvider to be removed
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.
See Also:
setMacroIOProvider(com.ibm.eNetwork.beans.HOD.MacroIOProvider)

setRecordEnabled

public void setRecordEnabled(boolean rec)
                      throws java.beans.PropertyVetoException
Turns off/on recording capabilities of MacroManager.
Parameters:
rec - If true, enables recording functions.
Throws:
java.beans.PropertyVetoException - Thrown if error in setting property

isRecordEnabled

public boolean isRecordEnabled()
Returns recording capabilities state of MacroManager.

setAdvRecordEnabled

public void setAdvRecordEnabled(boolean advrec)
                         throws java.beans.PropertyVetoException
Turns off/on advanced recording capabilities of MacroManager. These include inserting a smart wait, a prompt, and an extract.
Parameters:
advrec - If true, enables advanced recording functions.
Throws:
java.beans.PropertyVetoException - Thrown if error in setting property

isAdvRecordEnabled

public boolean isAdvRecordEnabled()
Returns advanced recording capabilities state of MacroManager.

getState

public int getState()
Returns the state of the current macro. Returned value is one of the Macro state constants.
Specified by:
getState in interface com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf
See Also:
Macro

setMacroList

public void setMacroList(java.util.Vector propList)
                  throws java.beans.PropertyVetoException
Sets the list of currently available macros. These macros must be provided by the current MacroIOProvider.
Parameters:
propList - Vector of Property objects, each of which represents a single macro.
Throws:
java.beans.PropertyVetoException - Thrown if error in setting property
See Also:
getMacroList()

getMacroList

public java.util.Vector getMacroList()
Returns the list of currently available macros. This list was set by the current MacroIOProvider. The returned Vector contains a set of Property objects.
See Also:
setMacroList(java.util.Vector)

setButtonTextVisible

public void setButtonTextVisible(boolean state)
                          throws java.beans.PropertyVetoException
Sets the text visibility state of the text in the buttons of MacroManager.
Parameters:
state - true for visible, false for invisible
Throws:
java.beans.PropertyVetoException - Thrown if an incorrect property value is given.

isButtonTextVisible

public boolean isButtonTextVisible()
Returns the text visibility state of the text in the buttons of MacroManager.

setRecordUI

public void setRecordUI(boolean newVal)
                 throws java.beans.PropertyVetoException
Sets whether the Macro will record user interface events on the Terminal bean. These are events like mouse clicks and box selection. The default is for Macro to not record UI events.

Note: if this property is set to true, cursor position will not be automatically recorded in the screen descriptions. This happens because the Macro bean is unable to reliably determine the place of the cursor when mouse clicks move the cursor.

Specified by:
setRecordUI in interface com.ibm.eNetwork.beans.HOD.intf.MacroManagerIntf
Parameters:
newVal - if true, UI events will be recorded.
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isRecordUI

public boolean isRecordUI()
Returns whether the Macro will record user interface events on the Terminal bean. These are events like mouse clicks and box selection. The default is for Macro to not record UI events.
Returns:
if true, UI events will be recorded.

clone

public java.lang.Object clone()
Returns a new instance of MacroManager with the same state as the current one.
Overrides:
clone in class HODPanelBean

setSelectedMacro

public void setSelectedMacro(java.lang.String name)
                      throws MacroException
Sets the macro with the given name to the current macro in MacroManager. This will cause MacroManager to call the getMacro(name) method on the connected MacroIOProvider.
Parameters:
name - Name of macro to select.
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.

record

public void record()
Starts recording a macro or resumes recording a paused macro.

stop

public void stop()
Stops recording or playing the macro.

play

public void play()
Toggles the play state of the current macro.

pause

public void pause()
Toggles pause recording or playing the macro.

setPrompts

public void setPrompts(MacroPrompts macPrompts)
                throws MacroException
Sets the macro prompts. Use when a MacroPromptEvent occurs.
Parameters:
macPrompts - MacroPrompts object with prompt data filled in.
Throws:
MacroException - thrown if a parameter is passed that is not valid or if Macro experiences an internal error.
See Also:
MacroPrompts, MacroPromptEvent

getTraceName

public java.lang.String getTraceName()
Returns a trace identifier for this bean
Overrides:
getTraceName in class HODPanelBean