|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.eNetwork.beans.HOD.MacroPrompts
MacroPrompts class contains functionality for iterating through and setting prompt values fired in a MacroPromptEvent.
When the macro runs it will be scanned for all prompt lines. Each new prompt identifier will be loaded into an object of the MacroPrompts class. This object will then be fired in a MacroPromptEvent, whereby a listener should set all values in the MacroPrompts object. After the object is set, the listener should call setPrompts on Macro to play the macro after prescan. If a value was not set, and there is a value specified on the prompt line, that value will be used. If there is no value on the prompt line, another event will be fired to try to retrieve the prompt data. If still no data is returned, the macro will end in an error.
MacroPromptEvent
,
Macro
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, DOCMODE_STR, 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, WORDWRAP_STR, YELLOW_3270 |
Constructor Summary | |
---|---|
MacroPrompts(Macro mac)
Constructs an instance of a prompt collection object. |
Method Summary | |
---|---|
void |
add(int argIndex,
MacroActionPrompt argMA)
Inserts the macro prompt action at the given index. |
void |
add(MacroActionPrompt argMA)
Appends the macro prompt action to the end of the collection. |
void |
clear()
Removes all macro prompt actions from the collection |
void |
clearPromptValues()
Removes all prompt values |
boolean |
contains(MacroActionPrompt argMA)
Tests to see if given macro prompt action is in the collection. |
MacroActionPrompt |
get(int argIndex)
Returns the macro prompt action at the given index |
int |
getNumPrompts()
Deprecated. |
java.lang.String |
getPromptDefault(java.lang.String name)
Gets the default value of a prompt using a prompt name. |
int |
getPromptLength(java.lang.String name)
Gets the length of a prompt using a prompt name |
java.lang.String |
getPromptName(int i)
Gets the name of a prompt at a given index. |
java.lang.String |
getPromptValue(java.lang.String name)
Gets the value of a prompt using a prompt name. |
int |
indexOf(MacroActionPrompt argMA)
Returns the index of the given macro prompt action. |
boolean |
isEmpty()
Tests to see if the macro prompt action collection is empty. |
boolean |
isPromptPassword(java.lang.String name)
Returns whether a prompt is a password display using a prompt name. |
void |
remove(int argIndex)
Removes the macro prompt action at the given index from the collection. |
void |
remove(MacroActionPrompt argMA)
Removes the given macro prompt action from the collection. |
void |
set(MacroActionPrompt argMA,
int argIndex)
Replaces the macro prompt action object at the given index in the collection. |
void |
setPromptValue(java.lang.String name,
java.lang.String value)
Sets the value of a prompt using a prompt name. |
int |
size()
Returns the number of actions in the macro prompt action collection. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MacroPrompts(Macro mac)
mac
- Macro object that owns the promptsMethod Detail |
public MacroActionPrompt get(int argIndex)
argIndex
- index for the MacroAction objectpublic void set(MacroActionPrompt argMA, int argIndex)
argMA
- MacroActionPrompt object to place in collectionargIndex
- index for the MacroActionPrompt objectpublic void add(MacroActionPrompt argMA)
argMA
- MacroActionPrompt object to place in collectionpublic void add(int argIndex, MacroActionPrompt argMA)
argMA
- MacroActionPrompt object to place in collectionargIndex
- index for the MacroActionPrompt objectpublic boolean contains(MacroActionPrompt argMA)
argMA
- MacroActionPrompt object to place in collectionpublic boolean isEmpty()
public int size()
public void clear()
public void remove(MacroActionPrompt argMA)
argMA
- MacroActionPrompt object to remove from the collectionpublic void remove(int argIndex)
argIndex
- index for the MacroActionPrompt object to removepublic int indexOf(MacroActionPrompt argMA)
argMA
- MacroActionPrompt object to find index ofpublic java.lang.String getPromptName(int i)
i
- Index for namepublic java.lang.String getPromptDefault(java.lang.String name)
name
- Name of the promptMacroPromptEvent
public java.lang.String getPromptValue(java.lang.String name)
name
- Name of the promptsetPromptValue(java.lang.String, java.lang.String)
,
MacroActionPrompt
public void setPromptValue(java.lang.String name, java.lang.String value)
name
- Name of the promptvalue
- Value of the prompt to setMacroPromptEvent.setPrompts(com.ibm.eNetwork.beans.HOD.MacroPrompts)
public int getPromptLength(java.lang.String name)
name
- Name of the promptpublic boolean isPromptPassword(java.lang.String name)
name
- Name of the promptpublic void clearPromptValues()
public int getNumPrompts()
size()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |