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
-
ALTCUR_STR
-
-
ATTN_STR
-
-
AUTOPUSH_STR
-
-
AUTOREV_STR
-
-
BACKSP_STR
-
-
BACKTAB_STR
-
-
BASE_STR
-
-
BIDIL_STR
-
-
CLEAR_STR
-
-
CLOSE_STR
-
-
CRSEL_STR
-
-
CSD_STR
-
-
CURDOWN_STR
-
-
CURLEFT_STR
-
-
CURRIGHT_STR
-
-
CURUP_STR
-
-
DELCHAR_STR
-
-
DSPSOSI_STR
-
-
DUP_STR
-
-
ENDLINE_STR
-
-
ENDPUSH_STR
-
-
ENTER_STR
-
-
ERASEEOF_STR
-
-
ERASEINPUT_STR
-
-
F10_STR
-
-
F11_STR
-
-
F12_STR
-
-
F13_STR
-
-
F14_STR
-
-
F15_STR
-
-
F16_STR
-
-
F17_STR
-
-
F18_STR
-
-
F19_STR
-
-
F1_STR
-
-
F20_STR
-
-
F21_STR
-
-
F22_STR
-
-
F23_STR
-
-
F24_STR
-
-
F2_STR
-
-
F3_STR
-
-
F4_STR
-
-
F5_STR
-
-
F6_STR
-
-
F7_STR
-
-
F8_STR
-
-
F9_STR
-
-
FINAL_STR
-
-
FLDBASE_STR
-
-
FLDEXT_STR
-
-
FLDMINUS_STR
-
-
FLDMRK_STR
-
-
FLDPLUS_STR
-
-
FLDREV_STR
-
-
FLDSHAPE_STR
-
-
FWDTAB_STR
-
-
HELP_STR
-
-
HOME_STR
-
-
INITIAL_STR
-
-
INSERT_STR
-
-
ISOLATED_STR
-
-
LATINL_STR
-
-
MIDDLE_STR
-
-
NEWLINE_STR
-
-
PA1_STR
-
-
PA2_STR
-
-
PA3_STR
-
-
PAGEDWN_STR
-
-
PAGEUP_STR
-
-
PUSH_STR
-
-
RESET_STR
-
-
SCREENREV_STR
-
-
SYSREQ_STR
-
-
TEST_STR
-
-
addMacroCommand(SCMacroCommand)
- Adds the specified command at the end of the command vector.
-
addMacroCommand(SCMacroCommand, int)
- Inserts the specified command in the command vector at the specified index.
-
deleteMacroCommand(int)
- Delete the command from the command vector at the specified index.
-
getFunctionKey()
- Gets the host function key.
-
getMacroCommand(int)
- Gets the command from the command vector at specified index.
-
getMacroCommandCount()
- Gets the number of commands in the commmand vector.
-
getMacroCommands()
- Gets the command vector.
-
setFunctionKey(String)
- Sets the host function key to the specfied function key.
-
setMacroCommands(Vector)
- Sets the command vector to the specified vector.
ALTCUR_STR
public static final String ALTCUR_STR
ATTN_STR
public static final String ATTN_STR
BACKSP_STR
public static final String BACKSP_STR
BACKTAB_STR
public static final String BACKTAB_STR
CLEAR_STR
public static final String CLEAR_STR
CURDOWN_STR
public static final String CURDOWN_STR
CURLEFT_STR
public static final String CURLEFT_STR
CURRIGHT_STR
public static final String CURRIGHT_STR
CURUP_STR
public static final String CURUP_STR
DELCHAR_STR
public static final String DELCHAR_STR
ENTER_STR
public static final String ENTER_STR
FWDTAB_STR
public static final String FWDTAB_STR
ENDLINE_STR
public static final String ENDLINE_STR
ERASEEOF_STR
public static final String ERASEEOF_STR
ERASEINPUT_STR
public static final String ERASEINPUT_STR
F1_STR
public static final String F1_STR
F2_STR
public static final String F2_STR
F3_STR
public static final String F3_STR
F4_STR
public static final String F4_STR
F5_STR
public static final String F5_STR
F6_STR
public static final String F6_STR
F7_STR
public static final String F7_STR
F8_STR
public static final String F8_STR
F9_STR
public static final String F9_STR
F10_STR
public static final String F10_STR
F11_STR
public static final String F11_STR
F12_STR
public static final String F12_STR
F13_STR
public static final String F13_STR
F14_STR
public static final String F14_STR
F15_STR
public static final String F15_STR
F16_STR
public static final String F16_STR
F17_STR
public static final String F17_STR
F18_STR
public static final String F18_STR
F19_STR
public static final String F19_STR
F20_STR
public static final String F20_STR
F21_STR
public static final String F21_STR
F22_STR
public static final String F22_STR
F23_STR
public static final String F23_STR
F24_STR
public static final String F24_STR
NEWLINE_STR
public static final String NEWLINE_STR
PA1_STR
public static final String PA1_STR
PA2_STR
public static final String PA2_STR
PA3_STR
public static final String PA3_STR
PAGEDWN_STR
public static final String PAGEDWN_STR
PAGEUP_STR
public static final String PAGEUP_STR
SYSREQ_STR
public static final String SYSREQ_STR
INSERT_STR
public static final String INSERT_STR
HOME_STR
public static final String HOME_STR
CRSEL_STR
public static final String CRSEL_STR
RESET_STR
public static final String RESET_STR
DUP_STR
public static final String DUP_STR
FLDMRK_STR
public static final String FLDMRK_STR
FLDEXT_STR
public static final String FLDEXT_STR
FLDPLUS_STR
public static final String FLDPLUS_STR
FLDMINUS_STR
public static final String FLDMINUS_STR
TEST_STR
public static final String TEST_STR
DSPSOSI_STR
public static final String DSPSOSI_STR
HELP_STR
public static final String HELP_STR
SCREENREV_STR
public static final String SCREENREV_STR
LATINL_STR
public static final String LATINL_STR
BIDIL_STR
public static final String BIDIL_STR
BASE_STR
public static final String BASE_STR
FLDREV_STR
public static final String FLDREV_STR
CLOSE_STR
public static final String CLOSE_STR
AUTOREV_STR
public static final String AUTOREV_STR
PUSH_STR
public static final String PUSH_STR
ENDPUSH_STR
public static final String ENDPUSH_STR
AUTOPUSH_STR
public static final String AUTOPUSH_STR
CSD_STR
public static final String CSD_STR
FINAL_STR
public static final String FINAL_STR
INITIAL_STR
public static final String INITIAL_STR
MIDDLE_STR
public static final String MIDDLE_STR
ISOLATED_STR
public static final String ISOLATED_STR
FLDSHAPE_STR
public static final String FLDSHAPE_STR
FLDBASE_STR
public static final String FLDBASE_STR
addMacroCommand
public abstract void addMacroCommand(SCMacroCommand command)
- Adds the specified command at the end of the command vector.
- Parameters:
-
command
- the command to add
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
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
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
setMacroCommands
public abstract void setMacroCommands(Vector commands)
- Sets the command vector to the specified vector.
- Parameters:
-
commands
- the command vector to set
getMacroCommands
public abstract Vector getMacroCommands()
- Gets the command vector.
- Returns:
- the command vector
getMacroCommandCount
public abstract int getMacroCommandCount()
- Gets the number of commands in the commmand vector.
- Returns:
- the number of commands in the command vector
setFunctionKey
public abstract void setFunctionKey(String functionKey)
- Sets the host function key to the specfied function key.
- Parameters:
-
functionKey
- the host function key
getFunctionKey
public abstract String getFunctionKey()
- Gets the host function key.
- Returns:
- the host function key
All Packages Class Hierarchy This Package Previous Next Index