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 SetCursorPositionAction

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

public class SetCursorPositionAction
extends ScriptAction

This class represents the action to set the cursor position.

The current implementation of this class generates code similar to the following:

     setCursorPosition(123, 'HSRForm')
 
where "123" is the linear, 1-based cursor position and where "HSRForm" is the name of HTML form to set the cursor position on (only applicable when running under WebSphere Portal Server).


Field Summary
 
Fields inherited from class com.ibm.hats.transform.actions.ScriptAction
LANG_JAVASCRIPT
 
Constructor Summary
SetCursorPositionAction(int pos)
          Constructs a new SetCursorPositionAction object.
 
Method Summary
 String generateScript(String language, ContextAttributes contextAttributes)
          Returns the generated script.
 
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

SetCursorPositionAction

public SetCursorPositionAction(int pos)
Constructs a new SetCursorPositionAction object.

Parameters:
pos - linear, 1-based cursor position
Method Detail

generateScript

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

     setCursorPosition(123, 'HSRForm')
 

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

HATS 7.5.1 (201005110649)