HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.actions
Class SendKeyAction

java.lang.Object
  extended by com.ibm.hats.transform.actions.ScriptAction
      extended by com.ibm.hats.transform.actions.SendKeyAction

public class SendKeyAction
extends ScriptAction

This class represents the action to send an aid key (F1 for example) to the host system.


Field Summary
 
Fields inherited from class com.ibm.hats.transform.actions.ScriptAction
LANG_JAVASCRIPT
 
Constructor Summary
SendKeyAction()
          Constructs a new SendKeyAction object.
SendKeyAction(String key)
          Constructs a new SendKeyAction object.
SendKeyAction(String key, int pos)
          Constructs a new SendKeyAction object.
 
Method Summary
 String generateScript(String language, ContextAttributes contextAttributes)
          Returns the generated script.
 boolean getAllowBlankKey()
          Returns a boolean value indicating whether or not the blank key is allowed.
 String getKey()
          Returns the aid key to send.
 void setAllowBlankKey(boolean allow)
          Sets the flag indication for the allow blank key.
 void setKey(String string)
          Sets the aid key to send.
 
Methods inherited from class com.ibm.hats.transform.actions.ScriptAction
combineScriptActions, combineScriptActions, generateScript, generateScript, generateScript, generateScript, generateScript
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SendKeyAction

public SendKeyAction()
Constructs a new SendKeyAction object.


SendKeyAction

public SendKeyAction(String key)
Constructs a new SendKeyAction object.

Parameters:
key - HOD mnemonic to send. Example: "[pf1]"

SendKeyAction

public SendKeyAction(String key,
                     int pos)
Constructs a new SendKeyAction object.

Parameters:
key - HOD mnemonic to send. Example: "[pf1]"
pos - linear, 1-based screen position to place the cursor at prior to sending the key.
Method Detail

generateScript

public String generateScript(String language,
                             ContextAttributes contextAttributes)
Returns the generated script. Example of a script generated with this method:

     ms('[pf1]', 'HSRForm')
 

Specified by:
generateScript in class ScriptAction
Parameters:
language - The language.
contextAttributes - The context attributes.
Returns:
The generated script.

getKey

public String getKey()
Returns the aid key to send.

Returns:
The aid key to send.

setKey

public void setKey(String string)
Sets the aid key to send.

Parameters:
string - The aid key.

getAllowBlankKey

public boolean getAllowBlankKey()
Returns a boolean value indicating whether or not the blank key is allowed.

Returns:
A boolean value indicating whether or not the blank key is allowed.

setAllowBlankKey

public void setAllowBlankKey(boolean allow)
Sets the flag indication for the allow blank key.

Parameters:
allow - Flag indicating whether or not the blank key is allowed.

HATS 7.5.1 (201005110649)