All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.hi.customizer.beans.scci.SCMacro

public interface SCMacro
SCMacros are associated with SCButtons, SCImageButtons, and SCWebLinks. An SCMacro has two parts: a vector of SCMacroCommands and one host function key. When executed the SCMacro first invokes all the SCMacroCommands in their respective order in the command vector; then the host function key is sent to the host. SCMacros and SCMacroCommands can be created using methods in the SCFactory class.

See Also:
SCFactory, SCMacroCommand

Variable Index

 o ALTCUR_STR
 o ATTN_STR
 o AUTOPUSH_STR
 o AUTOREV_STR
 o BACKSP_STR
 o BACKTAB_STR
 o BASE_STR
 o BIDIL_STR
 o CLEAR_STR
 o CLOSE_STR
 o CRSEL_STR
 o CSD_STR
 o CURDOWN_STR
 o CURLEFT_STR
 o CURRIGHT_STR
 o CURUP_STR
 o DELCHAR_STR
 o DSPSOSI_STR
 o DUP_STR
 o ENDLINE_STR
 o ENDPUSH_STR
 o ENTER_STR
 o ERASEEOF_STR
 o ERASEINPUT_STR
 o F10_STR
 o F11_STR
 o F12_STR
 o F13_STR
 o F14_STR
 o F15_STR
 o F16_STR
 o F17_STR
 o F18_STR
 o F19_STR
 o F1_STR
 o F20_STR
 o F21_STR
 o F22_STR
 o F23_STR
 o F24_STR
 o F2_STR
 o F3_STR
 o F4_STR
 o F5_STR
 o F6_STR
 o F7_STR
 o F8_STR
 o F9_STR
 o FINAL_STR
 o FLDBASE_STR
 o FLDEXT_STR
 o FLDMINUS_STR
 o FLDMRK_STR
 o FLDPLUS_STR
 o FLDREV_STR
 o FLDSHAPE_STR
 o FWDTAB_STR
 o HELP_STR
 o HOME_STR
 o INITIAL_STR
 o INSERT_STR
 o ISOLATED_STR
 o LATINL_STR
 o MIDDLE_STR
 o NEWLINE_STR
 o PA1_STR
 o PA2_STR
 o PA3_STR
 o PAGEDWN_STR
 o PAGEUP_STR
 o PUSH_STR
 o RESET_STR
 o SCREENREV_STR
 o SYSREQ_STR
 o TEST_STR

Method Index

 o addMacroCommand(SCMacroCommand)
Adds the specified command at the end of the command vector.
 o addMacroCommand(SCMacroCommand, int)
Inserts the specified command in the command vector at the specified index.
 o deleteMacroCommand(int)
Delete the command from the command vector at the specified index.
 o getFunctionKey()
Gets the host function key.
 o getMacroCommand(int)
Gets the command from the command vector at specified index.
 o getMacroCommandCount()
Gets the number of commands in the commmand vector.
 o getMacroCommands()
Gets the command vector.
 o setFunctionKey(String)
Sets the host function key to the specfied function key.
 o setMacroCommands(Vector)
Sets the command vector to the specified vector.

Variables

 o ALTCUR_STR
 public static final String ALTCUR_STR
 o ATTN_STR
 public static final String ATTN_STR
 o BACKSP_STR
 public static final String BACKSP_STR
 o BACKTAB_STR
 public static final String BACKTAB_STR
 o CLEAR_STR
 public static final String CLEAR_STR
 o CURDOWN_STR
 public static final String CURDOWN_STR
 o CURLEFT_STR
 public static final String CURLEFT_STR
 o CURRIGHT_STR
 public static final String CURRIGHT_STR
 o CURUP_STR
 public static final String CURUP_STR
 o DELCHAR_STR
 public static final String DELCHAR_STR
 o ENTER_STR
 public static final String ENTER_STR
 o FWDTAB_STR
 public static final String FWDTAB_STR
 o ENDLINE_STR
 public static final String ENDLINE_STR
 o ERASEEOF_STR
 public static final String ERASEEOF_STR
 o ERASEINPUT_STR
 public static final String ERASEINPUT_STR
 o F1_STR
 public static final String F1_STR
 o F2_STR
 public static final String F2_STR
 o F3_STR
 public static final String F3_STR
 o F4_STR
 public static final String F4_STR
 o F5_STR
 public static final String F5_STR
 o F6_STR
 public static final String F6_STR
 o F7_STR
 public static final String F7_STR
 o F8_STR
 public static final String F8_STR
 o F9_STR
 public static final String F9_STR
 o F10_STR
 public static final String F10_STR
 o F11_STR
 public static final String F11_STR
 o F12_STR
 public static final String F12_STR
 o F13_STR
 public static final String F13_STR
 o F14_STR
 public static final String F14_STR
 o F15_STR
 public static final String F15_STR
 o F16_STR
 public static final String F16_STR
 o F17_STR
 public static final String F17_STR
 o F18_STR
 public static final String F18_STR
 o F19_STR
 public static final String F19_STR
 o F20_STR
 public static final String F20_STR
 o F21_STR
 public static final String F21_STR
 o F22_STR
 public static final String F22_STR
 o F23_STR
 public static final String F23_STR
 o F24_STR
 public static final String F24_STR
 o NEWLINE_STR
 public static final String NEWLINE_STR
 o PA1_STR
 public static final String PA1_STR
 o PA2_STR
 public static final String PA2_STR
 o PA3_STR
 public static final String PA3_STR
 o PAGEDWN_STR
 public static final String PAGEDWN_STR
 o PAGEUP_STR
 public static final String PAGEUP_STR
 o SYSREQ_STR
 public static final String SYSREQ_STR
 o INSERT_STR
 public static final String INSERT_STR
 o HOME_STR
 public static final String HOME_STR
 o CRSEL_STR
 public static final String CRSEL_STR
 o RESET_STR
 public static final String RESET_STR
 o DUP_STR
 public static final String DUP_STR
 o FLDMRK_STR
 public static final String FLDMRK_STR
 o FLDEXT_STR
 public static final String FLDEXT_STR
 o FLDPLUS_STR
 public static final String FLDPLUS_STR
 o FLDMINUS_STR
 public static final String FLDMINUS_STR
 o TEST_STR
 public static final String TEST_STR
 o DSPSOSI_STR
 public static final String DSPSOSI_STR
 o HELP_STR
 public static final String HELP_STR
 o SCREENREV_STR
 public static final String SCREENREV_STR
 o LATINL_STR
 public static final String LATINL_STR
 o BIDIL_STR
 public static final String BIDIL_STR
 o BASE_STR
 public static final String BASE_STR
 o FLDREV_STR
 public static final String FLDREV_STR
 o CLOSE_STR
 public static final String CLOSE_STR
 o AUTOREV_STR
 public static final String AUTOREV_STR
 o PUSH_STR
 public static final String PUSH_STR
 o ENDPUSH_STR
 public static final String ENDPUSH_STR
 o AUTOPUSH_STR
 public static final String AUTOPUSH_STR
 o CSD_STR
 public static final String CSD_STR
 o FINAL_STR
 public static final String FINAL_STR
 o INITIAL_STR
 public static final String INITIAL_STR
 o MIDDLE_STR
 public static final String MIDDLE_STR
 o ISOLATED_STR
 public static final String ISOLATED_STR
 o FLDSHAPE_STR
 public static final String FLDSHAPE_STR
 o FLDBASE_STR
 public static final String FLDBASE_STR

Methods

 o addMacroCommand
 public abstract void addMacroCommand(SCMacroCommand command)
Adds the specified command at the end of the command vector.

Parameters:
command - the command to add
 o addMacroCommand
 public abstract void addMacroCommand(SCMacroCommand command,
                                      int index)
Inserts the specified command in the command vector at the specified index. The index is zero-based. If the value of the index is -1 then the command is added to the end. If value of the index is greater than the number of commands in the list, the command is added at the end.

Parameters:
command - the command to insert
index - the index at which to insert the command
 o deleteMacroCommand
 public abstract void deleteMacroCommand(int index)
Delete the command from the command vector at the specified index.

Parameters:
index - the index of the command to delete
 o getMacroCommand
 public abstract SCMacroCommand getMacroCommand(int index)
Gets the command from the command vector at specified index.

Parameters:
index - the index of the command to get
Returns:
the command at the specified index
 o setMacroCommands
 public abstract void setMacroCommands(Vector commands)
Sets the command vector to the specified vector.

Parameters:
commands - the command vector to set
 o getMacroCommands
 public abstract Vector getMacroCommands()
Gets the command vector.

Returns:
the command vector
 o getMacroCommandCount
 public abstract int getMacroCommandCount()
Gets the number of commands in the commmand vector.

Returns:
the number of commands in the command vector
 o setFunctionKey
 public abstract void setFunctionKey(String functionKey)
Sets the host function key to the specfied function key.

Parameters:
functionKey - the host function key
 o getFunctionKey
 public abstract String getFunctionKey()
Gets the host function key.

Returns:
the host function key

All Packages  Class Hierarchy  This Package  Previous  Next  Index