com.ibm.hi.customizer.beans.scci
Interface 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

Field Summary
static java.lang.String ALTCUR_STR
           
static java.lang.String ATTN_STR
           
static java.lang.String AUTOPUSH_STR
           
static java.lang.String AUTOREV_STR
           
static java.lang.String BACKSP_STR
           
static java.lang.String BACKTAB_STR
           
static java.lang.String BASE_STR
           
static java.lang.String BIDIL_STR
           
static java.lang.String CLEAR_STR
           
static java.lang.String CLOSE_STR
           
static java.lang.String CRSEL_STR
           
static java.lang.String CSD_STR
           
static java.lang.String CURDOWN_STR
           
static java.lang.String CURLEFT_STR
           
static java.lang.String CURRIGHT_STR
           
static java.lang.String CURUP_STR
           
static java.lang.String DELCHAR_STR
           
static java.lang.String DSPSOSI_STR
           
static java.lang.String DUP_STR
           
static java.lang.String ENDLINE_STR
           
static java.lang.String ENDPUSH_STR
           
static java.lang.String ENTER_STR
           
static java.lang.String ERASEEOF_STR
           
static java.lang.String ERASEINPUT_STR
           
static java.lang.String F1_STR
           
static java.lang.String F10_STR
           
static java.lang.String F11_STR
           
static java.lang.String F12_STR
           
static java.lang.String F13_STR
           
static java.lang.String F14_STR
           
static java.lang.String F15_STR
           
static java.lang.String F16_STR
           
static java.lang.String F17_STR
           
static java.lang.String F18_STR
           
static java.lang.String F19_STR
           
static java.lang.String F2_STR
           
static java.lang.String F20_STR
           
static java.lang.String F21_STR
           
static java.lang.String F22_STR
           
static java.lang.String F23_STR
           
static java.lang.String F24_STR
           
static java.lang.String F3_STR
           
static java.lang.String F4_STR
           
static java.lang.String F5_STR
           
static java.lang.String F6_STR
           
static java.lang.String F7_STR
           
static java.lang.String F8_STR
           
static java.lang.String F9_STR
           
static java.lang.String FINAL_STR
           
static java.lang.String FLDBASE_STR
           
static java.lang.String FLDEXT_STR
           
static java.lang.String FLDMINUS_STR
           
static java.lang.String FLDMRK_STR
           
static java.lang.String FLDPLUS_STR
           
static java.lang.String FLDREV_STR
           
static java.lang.String FLDSHAPE_STR
           
static java.lang.String FWDTAB_STR
           
static java.lang.String HELP_STR
           
static java.lang.String HOME_STR
           
static java.lang.String INITIAL_STR
           
static java.lang.String INSERT_STR
           
static java.lang.String ISOLATED_STR
           
static java.lang.String LATINL_STR
           
static java.lang.String MIDDLE_STR
           
static java.lang.String NEWLINE_STR
           
static java.lang.String NONE_STR
           
static java.lang.String PA1_STR
           
static java.lang.String PA2_STR
           
static java.lang.String PA3_STR
           
static java.lang.String PAGEDWN_STR
           
static java.lang.String PAGEUP_STR
           
static java.lang.String PUSH_STR
           
static java.lang.String RESET_STR
           
static java.lang.String SCREENREV_STR
           
static java.lang.String SYSREQ_STR
           
static java.lang.String TEST_STR
           
 
Method Summary
 void addMacroCommand(SCMacroCommand command)
          Adds the specified command at the end of the command vector.
 void addMacroCommand(SCMacroCommand command, int index)
          Inserts the specified command in the command vector at the specified index.
 void deleteMacroCommand(int index)
          Delete the command from the command vector at the specified index.
 java.lang.String getFunctionKey()
          Gets the host function key.
 SCMacroCommand getMacroCommand(int index)
          Gets the command from the command vector at specified index.
 int getMacroCommandCount()
          Gets the number of commands in the commmand vector.
 java.util.Vector getMacroCommands()
          Gets the command vector.
 void setFunctionKey(java.lang.String functionKey)
          Sets the host function key to the specfied function key.
 void setMacroCommands(java.util.Vector commands)
          Sets the command vector to the specified vector.
 

Field Detail

ALTCUR_STR

public static final java.lang.String ALTCUR_STR

ATTN_STR

public static final java.lang.String ATTN_STR

BACKSP_STR

public static final java.lang.String BACKSP_STR

BACKTAB_STR

public static final java.lang.String BACKTAB_STR

CLEAR_STR

public static final java.lang.String CLEAR_STR

CURDOWN_STR

public static final java.lang.String CURDOWN_STR

CURLEFT_STR

public static final java.lang.String CURLEFT_STR

CURRIGHT_STR

public static final java.lang.String CURRIGHT_STR

CURUP_STR

public static final java.lang.String CURUP_STR

DELCHAR_STR

public static final java.lang.String DELCHAR_STR

ENTER_STR

public static final java.lang.String ENTER_STR

FWDTAB_STR

public static final java.lang.String FWDTAB_STR

ENDLINE_STR

public static final java.lang.String ENDLINE_STR

ERASEEOF_STR

public static final java.lang.String ERASEEOF_STR

ERASEINPUT_STR

public static final java.lang.String ERASEINPUT_STR

F1_STR

public static final java.lang.String F1_STR

F2_STR

public static final java.lang.String F2_STR

F3_STR

public static final java.lang.String F3_STR

F4_STR

public static final java.lang.String F4_STR

F5_STR

public static final java.lang.String F5_STR

F6_STR

public static final java.lang.String F6_STR

F7_STR

public static final java.lang.String F7_STR

F8_STR

public static final java.lang.String F8_STR

F9_STR

public static final java.lang.String F9_STR

F10_STR

public static final java.lang.String F10_STR

F11_STR

public static final java.lang.String F11_STR

F12_STR

public static final java.lang.String F12_STR

F13_STR

public static final java.lang.String F13_STR

F14_STR

public static final java.lang.String F14_STR

F15_STR

public static final java.lang.String F15_STR

F16_STR

public static final java.lang.String F16_STR

F17_STR

public static final java.lang.String F17_STR

F18_STR

public static final java.lang.String F18_STR

F19_STR

public static final java.lang.String F19_STR

F20_STR

public static final java.lang.String F20_STR

F21_STR

public static final java.lang.String F21_STR

F22_STR

public static final java.lang.String F22_STR

F23_STR

public static final java.lang.String F23_STR

F24_STR

public static final java.lang.String F24_STR

NEWLINE_STR

public static final java.lang.String NEWLINE_STR

PA1_STR

public static final java.lang.String PA1_STR

PA2_STR

public static final java.lang.String PA2_STR

PA3_STR

public static final java.lang.String PA3_STR

PAGEDWN_STR

public static final java.lang.String PAGEDWN_STR

PAGEUP_STR

public static final java.lang.String PAGEUP_STR

SYSREQ_STR

public static final java.lang.String SYSREQ_STR

INSERT_STR

public static final java.lang.String INSERT_STR

HOME_STR

public static final java.lang.String HOME_STR

CRSEL_STR

public static final java.lang.String CRSEL_STR

RESET_STR

public static final java.lang.String RESET_STR

DUP_STR

public static final java.lang.String DUP_STR

FLDMRK_STR

public static final java.lang.String FLDMRK_STR

FLDEXT_STR

public static final java.lang.String FLDEXT_STR

FLDPLUS_STR

public static final java.lang.String FLDPLUS_STR

FLDMINUS_STR

public static final java.lang.String FLDMINUS_STR

TEST_STR

public static final java.lang.String TEST_STR

DSPSOSI_STR

public static final java.lang.String DSPSOSI_STR

HELP_STR

public static final java.lang.String HELP_STR

SCREENREV_STR

public static final java.lang.String SCREENREV_STR

LATINL_STR

public static final java.lang.String LATINL_STR

BIDIL_STR

public static final java.lang.String BIDIL_STR

BASE_STR

public static final java.lang.String BASE_STR

FLDREV_STR

public static final java.lang.String FLDREV_STR

CLOSE_STR

public static final java.lang.String CLOSE_STR

AUTOREV_STR

public static final java.lang.String AUTOREV_STR

PUSH_STR

public static final java.lang.String PUSH_STR

ENDPUSH_STR

public static final java.lang.String ENDPUSH_STR

AUTOPUSH_STR

public static final java.lang.String AUTOPUSH_STR

CSD_STR

public static final java.lang.String CSD_STR

FINAL_STR

public static final java.lang.String FINAL_STR

INITIAL_STR

public static final java.lang.String INITIAL_STR

MIDDLE_STR

public static final java.lang.String MIDDLE_STR

ISOLATED_STR

public static final java.lang.String ISOLATED_STR

FLDSHAPE_STR

public static final java.lang.String FLDSHAPE_STR

FLDBASE_STR

public static final java.lang.String FLDBASE_STR

NONE_STR

public static final java.lang.String NONE_STR
Method Detail

addMacroCommand

public void addMacroCommand(SCMacroCommand command)
Adds the specified command at the end of the command vector.
Parameters:
command - the command to add

addMacroCommand

public 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 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 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 void setMacroCommands(java.util.Vector commands)
Sets the command vector to the specified vector.
Parameters:
commands - the command vector to set

getMacroCommands

public java.util.Vector getMacroCommands()
Gets the command vector.
Returns:
the command vector

getMacroCommandCount

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

setFunctionKey

public void setFunctionKey(java.lang.String functionKey)
Sets the host function key to the specfied function key.
Parameters:
functionKey - the host function key

getFunctionKey

public java.lang.String getFunctionKey()
Gets the host function key.
Returns:
the host function key