        |  |
 |
 |
 |
 |
 |
 |
 |
 |
 |
|
ECMAScript API Guide
CHAPTER 2
USERID Property
PASSWORD Property
RESOURCENAME Property
String getText(Object aOffset, Object aLength)
Composer extension method. Returns text string which is part of the screen text buffer starting from position at offset aOffset and having length aLength characters. Field attributes are substituted with spaces
String getTextAt(Object aRow, Object aColumn, Object aLength)
Composer extension method. Returns text string which is part of the screen text buffer starting from position at row aRow, column aColumn and having length aLength characters. Field attributes are substituted with spaces
String getTextFromRectangle(Object aStartRow, Object aStartColumn, Object aEndRow, Object aEndColumn)
Composer extension method. Returns text string concatenated from substrings which compose rectangular area of the screen text buffer determined by coordinates: start position—aStartRow, aStartColumn end position—aEndRow, aEndColumn. Field attributes are substituted with spaces
String setText(Object aOffset, Object aText)
Composer extension method. Sets text—aText string at particular offset—aOffset of the screen text buffer. If text is longer then field text is inserted up to current fields length.
String setTextAt(Object aRow, Object aColumn, Object aText)
Composer extension method. Sets text—aText string starting at Row—aRow and Column—aColumn of the screen text buffer. If text is longer then field text is inserted up to current fields length.
USERID Property
PASSWORD Property
CopybookField getField(String cobolDataDesc)
Composer extension method. Returns a CopybookField object. To resolve duplicate named cobolDataDescs in a Copybook, reference the parent cobolDataDesc as follows: getField("PARTID IN INDATA") given the following copybook: 01 COMMAREA 05 INDATA 10 PARTID 05 OUTDATA 10 PARTID The returned CopybookField object has two methods: toString() and setValue().
void setValue(Object aValue)
Composer extension method. This method sets the value for a CopybookField object.
String toString()
Composer extension method. Returns the value set for the CopybookField object.
HOSTID As Defined in Connection
PASSWORD As Defined in Connection
USERID As Defined in Connection
int getAttribute(Object aRow, Object aColumn)
Composer extension method. Returns attribute of a character at a T27 screen position at row aRow and column aColumn.
int getCols()
Composer extension method. Returns number of columns from the T27 screen.
int getCursorCol()
Composer extension method. Returns current T27 screen cursor column position.
int getCursorRow()
Composer extension method. Returns current T27 screen cursor row position.
getNextMessage()
Composer extension method. Returns the next captured message.
String getPrompt()
Composer extension method. Returns text from cursor back to the left margin of the T27 screen.
int getRows()
Composer extension method. Returns number of rows from the T27 screen.
String getStatusLine()
Composer extension method. Returns text of the screen status line.
String getText(Object aRow, Object aColumn, Object aLength)
Composer extension method. Returns text string found at position aRow and aColumn for aLength characters.
String getTextFromRectangle(Object aStartRow, Object aStartColumn, Object aEndRow, Object aEndColumn)
Composer extension method. Returns block of text.
boolean hasMoreMessages()
Composer extension method. Returns true if more captured messages are available to obtain via the getNextMessage() method.
putString(Object aRow, Object aColumn, Object asText)
Composer extension method. Sets text asText in the screen at position aRow and aColumn.
putStringInField(Object aField, Object asText)
Composer extension method. Sets text asText in the screen at position aField.
setMessageCaptureOff()
Composer extension method. Turns off message capture.
setMessageCaptureOn()
Composer extension method. Sets up the capture of a message from the host immediately following a Transmit. Use getNextMessage() to retrieve data, then use setMessageCaptureOff() to turn off.
typeKeys(Object asKeyText)
Composer extension method. Keystroke represented by asKeyText is emulated on the screen.
Keyboard equivalent: Ctrl+Home
Keyboard equivalent: Esc, Alt+S, O
Keyboard equivalent: F10 or F6
Keyboard equivalent: PageDown
Keyboard equivalent: PageUp
Keyboard equivalent: F11 or F7
Keyboard equivalent: F9 or F5
Keyboard equivalent: F12 or F8
Returns true if the Transmission contains more Interchanges for processing. Returns false if no additional Interchanges are available.
Returns the contents of an Transmission as a raw string in native EDI text format.
Returns a DOM Element Node containing the XML representation of an EDI Interchange header and footer.
Returns the SenderID field data from an Interchange.
Example:
myInterchangeName.getSenderID()
Returns a table code value used to resolve the SenderID.
Returns a string indicating the EDI encoding standard of the Interchange (e.g. ANSIX12 or EDIFACT).
An X12 document returns a value of: P,T, or U. P = a production transaction, T = a test transaction, and U = `unknown'. An EDIFACT document returns a value of: 0 or 1 where 1 = a test transaction, and 0 = a production transaction.
Returns the contents of an Interchange in native EDI text format.
Returns true if the Interchange contains more Documents for processing.
Returns the Control ID assigned by the sender of a document used to uniquely identify each document. Example:
myDocumentName.getControlID()
Returns the particular type of document within the EDI standard. For instance, 850 might be returned for an ANSI X12 Purchase Order. Example:
myDocumentName.getDocType()
Returns the SenderID field data in an Interchange. Example:
myDocumentName.getSenderID()
Returns a table code value used to resolve the SenderID. Example:
myDocumentName.getSenderIDQualifier()
Returns a string indicating the EDI encoding standard of the Interchange (e.g. ANSIX12 or EDIFACT). Example:
myDocumentName.getStandard()
Returns the contents of an EDI Document in native EDI text format. Example:
myDocumentName.getValue()
Returns the version number of the EDI standard used to encode the EDI transmission. Example:
myDocumentName.getVersion()
NOTE: In the HTML component editor environment, you can utilize standard HTML DOM-2 ECMAScript extensions as defined by W3C. For the complete API breakout, consult http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109/ecma-script-binding.html.
HTTP Response Message
HTTP Status Code
A numeric code indicating whether the SQL statement executed successfully. In General 0 = success, 100 = no data found, a number > 0 = success with a warning, and a number < 0 = execution not successful. The meaning of SQLCODEs other than 0 and 100 varies with the particular product implementing SQL.
An SQL implementation specific numeric code indicating the success of an SQL command. See your database engine's documentation for details.
A number indicating how many records were updated by an SQL UPDATE command.
Contains a string of the last SQL statement issued.
Root reference name for JMS message methods.
CopybookField getField(String cobolDataDesc)
Composer extension method. Returns a CopybookField object. To resolve duplicate named cobolDataDescs in a Copybook, reference the parent cobolDataDesc as follows:
getField("PARTID IN INDATA")
given the following copybook:
01 COMMAREA 05 INDATA 10 PARTID 05 OUTDATA 10 PARTID
The returned CopybookField object has two methods: toString() and setValue().
Composer extension method. This method gets the value for a JMS BytesMessage objects body and repositions the stream to the beginning. Returns a Base64 encoded String.
String getJMSBytesBody(int aiBufSize)
Composer extension method. This method gets the value for a JMS BytesMessage objects body The aiBufSize parameter is the size of the body in bytes. Returns a Base64 encoded String.
Object getJMSBytesBodyAsBytes()
Composer extension method. This method gets the value for a JMS BytesMessage objects body and repositions the stream to the beginning. Returns a Java byte[] Object.
Object getJMSBytesBodyAsBytes(int aiBufSize)
Composer extension method. This method gets the value for a JMS BytesMessage objects body The aiBufSize parameter is the size of the body in bytes. Returns a Java byte[] object (i.e., byte array).
String getJMSMapBody()
Composer extension method. This method gets a string representation of the JMS MapMessage body. Returns a String. If a field is type BYTES it is represented as a Base64 encoded String.
String getJMSMapField(String asName, String asType)
Composer extension method. This method gets the value for a JMS MapMessage object body field. Returns a String. If asType is BYTES returns a Base64 encoded String.
Message getJMSMessage()
Composer extension method. Returns a JMS Message object. To work with a specific type of JMS Message body, cast the returned message. For Example: TextMessage lMsg = (TextMessage)getJMSMessage().
String getJMSMsgBody()
Composer extension method. Returns a JMS Message objects body as a String.
String getJMSMsgType()
Composer extension method. Returns a JMS Message objects type.
Serializable getJMSObjectBody()
Composer extension method. This method gets the value for a JMS ObjectMessage object body. Returns a Serializable.
String getJMSStreamBody()
Composer extension method. This method gets a string representation of the JMS StreamMessage body. Returns a String. If a field is type BYTES it is represented as a Base64 encoded String. The stream is reset.
String getJMSStreamField(String asName, String asType)
Composer extension method. This method gets the value for a JMS StreamMessage object body field. Returns a String. If asType is BYTES returns a Base64 encoded String.
String getJMSTextBody()
Composer extension method. This method gets the value for a JMS TextMessage object body. Returns a String.
String hasMessages()
Composer extension method. This method returns true if there are more messages to browse. Returns a boolean.
resetPosition()
Composer extension method. This method puts the bytes message body in read-only mode, and repositions the stream to the beginning.
setJMSBytesBody()
Composer extension method. This method sets the body for a JMS BytesMessage objects. Source data type is a Base64 String or a java byte[].
setJMSMapField(String asName, String asType)
Composer extension method. This method sets the name and type of a JMS MapMessage object body field. If asType is BYTES the source data type is a Base64 String or a java byte[].
void setJMSMsgProperty(String asName, String asType, String asValue)
Composer extension method. This method sets a JMS header property of a passed in name and type to a passed in value.
setJMSObjectBody(Serializable aObject)
Composer extension method. This method sets the body of a JMS ObjectMessage object.
setJMSStreamField(String asName, String asType)
Composer extension method. This method sets the value of a JMS StreamMessage object body field. If asType is BYTES the source data type is a Base64 String or a java byte[].
void setMessageSize(int aiSize)
xComposer extension method. This method allows the user to override the default copybook message size. By default, the maximum size defined by the copybook will be transmitted. The user's responsibility is to assign the message size such a way that it provides preserving all necessary data.
void setValue(Object aValue)
Composer extension method. This method sets the value for a CopybookField object.
String toString()
Composer extension method. Returns the value set for the CopybookField object.
String createAttrACL(boole Compare, boolean read, boolean write, boolean self, boolean supervisor, boolean inherit, String trusteeDN, String attrName)
Creates an eDirectory ACL in the form: "31#entry#cn=test,o=corp#attrName" Attribute rights give a trustee rights to the specifed attribute of an LDAP object. Rights may be applied to all attributes by specifying null as the "attrName".
String createEntryACL(boolean browse, boolean add, boolean delete, boolean rename, boolean supervisor, boolean inherit, String trusteeDN)
Creates an eDirectory ACL in the form: "31#entry#cn=test,o=corp#[Entry Rights]" Entry rights give a trustee rights to an LDAP object. Specify true for "inherit" to allow the whole subtree to inherit these rights.
String getLDAPAttr(String connection, String DN, String attrName )
This function returns the value of an attribute from a directory object. Parameters: string connection – name of a LDAP Connection Resource string DN – Distinguished Name of a directory object string attr – name of attribute (value to be returned) e.g. addr=getLDAPAttr(\"myCNX\",\" cn=AClark,o=NOVELL\", \"eMailAddress\")
INHERITANCE_MASK is a value of the trusteeDN parameter to both the createEntryACL() and createAttrACL() methods. Inheritance masks restrict which rights may be inherited by an LDAP object. To create an inheritance mask, specify INHERITANCE_MASK as the "trusteeDN" when creating an ACL.
PUBLIC is a value of the "trusteeDN" parameter to both the createEntryACL()
and createAttrACL() methods. To create public rights, specify PUBLIC as the "trusteeDN" when creating an ACL.
Composer extension property. It represents the DOM element "DragSource".
Composer extension property. It represents the DOM element "DropTarget".
PASSWORD Property
USERID Property
String getValue()
Composer extension method. This method gets the value for this Field object.
void setValue(Object aValue)
Composer extension method. This method sets the value for this Field object.
Object getExportField(String asName)
Composer extension method. This method gets the value of an SAP Export field. Returns an Object.
String getExportFieldInfo(String asName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Export field. Returns a String.
Object getImportField(String asName)
Composer extension method. This method gets the value of an SAP Import field. Returns an Object.
String getImportFieldInfo(String asName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Import field. Returns an String.
setImportField(String asName, String asType)
Composer extension method. This method sets the value of an SAP Import field.
Node getExportStructAsXML(String asStructName)
Composer extension method. This method gets the value of an SAP Export Structure as an XML Node. Returns a Node.
Object getExportStructField(String asStructName, String asFieldName)
Composer extension method. This method gets the value of an SAP Export Structure field. Returns an Object.
String getExportStructFieldInfo(String asStructName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Export Structure field. Returns an String.
Node getImportStructAsXML(String asStructName)
Composer extension method. This method gets the value of an SAP Import Structure as an XML Node. Returns a Node.
Object getImportStructField(String asStructName, String asFieldName)
Composer extension method. This method gets the value of an SAP Import Structure field. Returns an Object.
String getImportStructFieldInfo(String asStructName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Import Structure field. Returns an String.
setImportStructField(String asStructName, String asFieldName, String asType)
Composer extension method. This method sets the value of an SAP Import Structure field.
setImportStructWithXML(String asStructName)
Composer extension method. This method sets the value of an SAP Import Structure with an XML Node.
appendTableRow(String asTableName)
Composer extension method. This method apppends a new row into the specified SAP Table.
Node getTableAsXML(String asTableName)
Composer extension method. This method gets the value of an SAP Table an XML Node. Returns a Node.
Object getTableField(String asTableName, String asFieldName)
Composer extension method. This method gets the value of an SAP Table field. Returns an Object.
String getTableFieldInfo(String asTableName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Table field. Returns an String.
int getTableRowCount(String asTableName)
Composer extension method. This method gets the number of rows in an SAP Table. Returns a int.
boolean nextTableRow(String asTableName)
Composer extension method. This method moves the cursor to the next row in the specified SAP Table.
setTableField(String asTableName, String asFieldName, String asType)
Composer extension method. This method sets the value of an SAP Table field.
settTableRow(String asTableName, int aiRow)
Composer extension method. This method moves the cursor to the specified row in the specified SAP Table.
setTableWithXML(String asTableName)
Composer extension method. This method sets the value of an SAP Table with an XML Node.
dumpFunctionToLog()
Composer extension method. This method dumps the value of the SAP Function as a formatted XML String to the system log.
Node getFunctionAsXML()
Composer extension method. This method gets the value of the SAP Function as an XML Node. Returns a Node.
String getFunctionName()
Composer extension method. This method gets the current actions Function name. Returns a String.
Object getRFCObject()
Composer extension method. This method gets the current actions RFC Object. Returns an Object.
Object getClient()
Composer extension method. This method gets the current Client Object. Returns an Object.
String getLanguage()
Composer extension method. This method gets the SAP logon language for the current Client. Returns a String.
String getStats()
Composer extension method. This method gets the SAP performance statistics for the current Client. Requires JCOPERFORM set to true in xConfig. Returns a String.
printSAPClientInfo()
Composer extension method. This method prints SAP JCO.Client information to System.out.
resetClient()
Composer extension method. This method resets the JCO.Client.
resetStats()
Composer extension method. This method resets the SAP performance statistics for the current Client. Requires JCOPERFORM set to true in xConfig.
String getMiddlewareLayer()
Composer extension method. This method gets the current middleware layer. Returns a String.
String getMiddlewareProperty(String asKey)
Composer extension method. This method gets the current value of a middleware property. Returns a String.
setMiddlewareLayer(String asLayerName)
Composer extension method. This method sets the middleware layer.
setMiddlewareProperty(String asKey, String asValue)
Composer extension method. This method sets a middleware property value.
String getLastError()
Composer extension method. This method gets the last error thrown while processing an SAP Function. Returns a String.
printSAPInfo()
Composer extension method. This method prints SAP JCo information to System.out.
setFieldGetAsString(boolean abFlag)
Composer extension method. This method sets how field data is retrieved from a function. When true all output is retrieved as a String. When false all output is retrieved as an appropriate Object type for the field being retrieved.
setFieldSetAsString(boolean abFlag)
Composer extension method. This method sets how field data is set into a function. When true all input is converted to a String before setting into a function. When false all input is converted, if necessary, to an appropriate Object type for the field before setting.SAPSERVICE: Simple Field Methods
Object getExportField(String asName)
Composer extension method. This method gets the value of an SAP Export field. Returns an Object.
String getExportFieldInfo(String asName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Export field. Returns a String.
Object getImportField(String asName)
Composer extension method. This method gets the value of an SAP Import field. Returns an Object.
String getImportFieldInfo(String asName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Import field. Returns an String.
setExportField(String asName, String asType)
Composer extension method. This method sets the value of an SAP Export field.
setImportField(String asName, String asType)
Composer extension method. This method sets the value of an SAP Import field.
Node getExportStructAsXML(String asStructName)
Composer extension method. This method gets the value of an SAP Export Structure as an XML Node. Returns a Node.
Object getExportStructField(String asStructName, String asFieldName)
Composer extension method. This method gets the value of an SAP Export Structure field. Returns an Object.
String getExportStructFieldInfo(String asStructName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Export Structure field. Returns an String.
Node getImportStructAsXML(String asStructName)
Composer extension method. This method gets the value of an SAP Import Structure as an XML Node. Returns a Node.
Object getImportStructField(String asStructName, String asFieldName)
Composer extension method. This method gets the value of an SAP Import Structure field. Returns an Object.
String getImportStructFieldInfo(String asStructName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Import Structure field. Returns an String.
setExportStructField(String asStructName, String asFieldName, String asType)
Composer extension method. This method sets the value of an SAP Export Structure field.
setExportStructWithXML(String asStructName)
Composer extension method. This method sets the value of an SAP Export Structure with an XML Node.
setImportStructField(String asStructName, String asFieldName, String asType)
Composer extension method. This method sets the value of an SAP Import Structure field.
setImportStructWithXML(String asStructName)
Composer extension method. This method sets the value of an SAP Import Structure with an XML Node.
appendTableRow(String asTableName)
Composer extension method. This method apppends a new row into the specified SAP Table.
Node getTableAsXML(String asTableName)
Composer extension method. This method gets the value of an SAP Table an XML Node. Returns a Node.
Object getTableField(String asTableName, String asFieldName)
Composer extension method. This method gets the value of an SAP Table field. Returns an Object.
String getTableFieldInfo(String asTableName, String asFieldName, String asType)
Composer extension method. This method gets a specified type of metadata for an SAP Table field. Returns an String.
int getTableRowCount(String asTableName)
Composer extension method. This method gets the number of rows in an SAP Table. Returns a int.
boolean nextTableRow(String asTableName)
Composer extension method. This method moves the cursor to the next row in the specified SAP Table.
setTableField(String asTableName, String asFieldName, String asType)
Composer extension method. This method sets the value of an SAP Table field.
settTableRow(String asTableName, int aiRow)
Composer extension method. This method moves the cursor to the specified row in the specified SAP Table.
setTableWithXML(String asTableName)
Composer extension method. This method sets the value of an SAP Table with an XML Node.
dumpFunctionToLog()
Composer extension method. This method dumps the value of the SAP Function as a formatted XML String to the system log.
Node getFunctionAsXML()
Composer extension method. This method gets the value of the SAP Function as an XML Node. Returns a Node.
String getFunctionName()
Composer extension method. This method gets the current actions Function name. Returns a String.
Object getRFCObject()
Composer extension method. This method gets the current actions RFC Object. Returns an Object.
Object getClient()
Composer extension method. This method gets the current Client Object. Returns an Object.
String getLanguage()
Composer extension method. This method gets the SAP logon language for the current Client. Returns a String.
String getStats()
Composer extension method. This method gets the SAP performance statistics for the current Client. Requires JCOPERFORM set to true in xConfig. Returns a String.
printSAPClientInfo()
Composer extension method. This method prints SAP JCO.Client information to System.out.
resetClient()
Composer extension method. This method resets the JCO.Client.
resetStats()
Composer extension method. This method resets the SAP performance statistics for the current Client. Requires JCOPERFORM set to true in xConfig.
String getMiddlewareLayer()
Composer extension method. This method gets the current middleware layer. Returns a String.
String getMiddlewareProperty(String asKey)
Composer extension method. This method gets the current value of a middleware property. Returns a String.
setMiddlewareLayer(String asLayerName)
Composer extension method. This method sets the middleware layer.
setMiddlewareProperty(String asKey, String asValue)
Composer extension method. This method sets a middleware property value.
clearABAPException()
Composer extension method. This method clears the JCO.ABAPException.
String getLastError()
Composer extension method. This method gets the last error thrown while processing an SAP Function. Returns a String.
printSAPInfo()
Composer extension method. This method prints SAP JCo information to System.out.
raiseABAPException(String asKey, String asMessage)
Composer extension method. This method stores a JCO.ABAPException to be thrown from the SAP Services request handler.
setFieldGetAsString(boolean abFlag)
Composer extension method. This method sets how field data is retrieved from a function. When true all output is retrieved as a String. When false all output is retrieved as an appropriate Object type for the field being retrieved.
setFieldSetAsString(boolean abFlag)
Composer extension method. This method sets how field data is set into a function. When true all input is converted to a String before setting into a function. When false all input is converted, if necessary, to an appropriate Object type for the field before setting.
USERID As Defined in Connection
PASSWORD As Defined in Connection
int getAttribute(Object aRow, Object aColumn)
Composer extension method. Returns attribute of a character at a Telnet screen position at row aRow and column aColumn.
int getColumnCount()
Composer extension method. Returns number of columns from the Telnet screen.
int getCursorColumn()
Composer extension method. Returns current Telnet screen cursor column position.
int getCursorRow()
Composer extension method. Returns current Telnet screen cursor row position.
String getPrompt()
Composer extension method. Returns text from cursor back to the left margin of the Telnet screen.
int getRowCount()
Composer extension method. Returns number of rows from the Telnet screen.
String getText(Object aOffset, Object aLength)
Composer extension method. Returns text string which is part of the screen text buffer starting from position at offset aOffset and having length aLength characters.
String getTextAt(Object aRow, Object aColumn, Object aLength)
Composer extension method. Returns text string which is part of the screen text buffer starting from position at row aRow, column aColumn and having length aLength characters.
String getTextFromRectangle(Object aStartRow, Object aStartColumn, Object aEndRow, Object aEndColumn)
Composer extension method. Returns text string concatenated from substrings which compose rectangular area of the screen text buffer determined by coordinates: start position—aStartRow, aStartColumn end position—aEndRow, aEndColumn.
String setText(Object asText)
Composer extension method. Sets text asText in the screen text buffer starting from current offset.
HOSTID As Defined in Connection
PASSWORD As Defined in Connection
USERID As Defined in Connection
int getAttribute(Object aRow, Object aColumn)
Composer extension method. Returns attribute of a character at a UTS screen position at row aRow and column aColumn.
int getCols()
Composer extension method. Returns number of columns from the UTS screen.
int getCursorCol()
Composer extension method. Returns current UTS screen cursor column position.
int getCursorRow()
Composer extension method. Returns current UTS screen cursor row position.
getNextMessage()
Composer extension method. Returns the next captured screen data message.
String getPrompt()
Composer extension method. Returns text from cursor back to the left margin of the UTS screen.
int getRows()
Composer extension method. Returns number of rows from the UTS screen.
String getText(Object aRow, Object aColumn, Object aLength)
Composer extension method. Returns text string found at position aRow and aColumn for aLength characters.
String getTextFromRectangle(Object aStartRow, Object aStartColumn, Object aEndRow, Object aEndColumn)
Composer extension method. Returns block of text.
boolean hasMoreMessages()
Composer extension method. Returns true if more captured screen data messages are available to obtain via the getNextMessage() method.
putString(Object aRow, Object aColumn, Object asText)
Composer extension method. Sets text asText in the screen at position aRow and aColumn.
putStringInField(Object aField, Object asText)
Composer extension method. Sets text asText in the screen at position aField.
setMessageCaptureOff()
Composer extension method. Turns off screen data message capture.
setMessageCaptureOn()
Composer extension method. Sets up the capture of a screen data message from the host immediately following a Transmit. Use getNextMessage() to retrieve data, then use setMessageCaptureOff() to turn off.
typeKeys(Object asKeyText)
Composer extension method. Keystroke represented by asKeyText is emulated on the screen.
Keyboard equivalent: Ctrl + W
Keyboard equivalent: Ctrl + S
Keyboard equivalent: Enter
Keyboard equivalent: Esc
Keyboard equivalent: F1
Keyboard equivalent: F2
Keyboard equivalent: F3
Keyboard equivalent: F4
Keyboard equivalent: F5
Keyboard equivalent: F6
Keyboard equivalent: F7
Keyboard equivalent: F8
Keyboard equivalent: F9
Keyboard equivalent: F10
Keyboard equivalent: F11
Keyboard equivalent: F12
Keyboard equivalent: Shift + F1
Keyboard equivalent: Shift + F2
Keyboard equivalent: Shift + F3
Keyboard equivalent: Shift + F4
Keyboard equivalent: Shift + F5
Keyboard equivalent: Shift + F6
Keyboard equivalent: Shift + F7
Keyboard equivalent: Shift + F8
Keyboard equivalent: Shift + F9
Keyboard equivalent: Shift + F10
Keyboard equivalent: Shift + F11
Keyboard equivalent: Shift + F12
Number.MAX_VALUE The largest positive finite value of the number type, which is approximately 1.7976931348623157e308
Number.MIN_VALUE The smallest positive nonzero value of the number type, which is approximately 5e-324
Number.NaN The primitive value NaN represents the set of IEEE Standard "Not-a-Number" values.
Number.NEGATIVE_INFINITY The value of negative infinity.
Number()
Constructor of Number has two forms: Number(value) and Number().
Number.POSITIVE_INFINITY The value of positive infinity.
toString()
If the radix is the number 10 or not supplied, then this number value is given as an argument to the ToString operator; the resulting string value is returned. If the radix is supplied and is an integer from 2 to 36, but not 10, the result is a string, the choice of which is implementation-dependent. The toString function is not generic; it generates a runtime error if its this value is not a Number object. Therefore, it cannot be transferred to other kinds of objects for use as a method.
valueOf()
Returns this number value. The valueOf function is not generic; it generates a runtime error if its this value is not a Number object. Therefore, it cannot be transferred to other kinds of objects for use as a method.
String(x)
constructor of the string.
charAt(pos)
Method returns a string containing the character at position pos in the string resulting from converting this object to a string. If there is no character at that position, the result is the empty string. The result is a string value, not a string object.
charCodeAt(pos)
Method returns a number (a nonnegative integer less than 2^16) representing the Unicode code point encoding of the character at position pos in the string resulting from converting this object to a string. If there is no character at that position, the result is NaN.
fromCharCode(char0, char1, . . .)
returns a string value containing as many characters as the number of arguments. Each argument specifies one character of the resulting string, with the first argument specifying the first character, and so on, from left to right. An argument is converted to a character by applying the operation ToUint16 and regarding the resulting 16-bit integer as the Unicode code point encoding of a character. If no arguments are supplied, the result is the empty string.
indexOf(searchString, pos)
If the given searchString appears as a substring of the result of converting this object to a string, at one or more positions that are at or to the right of the specified position, then the index of the leftmost such position is returned; otherwise, -1 is returned. If position is undefined or not supplied, 0 is assumed, so as to search all of the string.
lastIndexOf(searchString, pos)
If the given searchString appears as a substring of the result of converting this object to a string, at one or more positions that are at or to the left of the specified position, then the index of the rightmost such position is returned; otherwise, -1 is returned. If position is undefined or not supplied, the length of the string value is assumed, so as to search all of the string.
length property equals to the number of characters in the String value represented by this string object.
String match(RegExp)
Takes a regular expression object as argument. It returns an Array of matches, else null.
String replace(RegExp, String)
Takes a regular expression and a replacement string. Returns original string with replacements accomplished.
String search(RegExp)
Takes a regular expression as the sole arg and returns the offset of the first substring that matches, or -1 on no match.
split(separator)
Method returns an Array object, into which substrings of the result of converting this object to a string have been stored. The substrings are determined by searching from left to right for occurrences of the given separator; these occurrences are not part of any substring in the returned array, but serve to divide up the string value. The separator may be a string of any length.
substring(start, end)
Method returns a substring of the result of converting this object to a string, starting from character position start and running to the position end of the string. If second parameter is not present end position is considered end of the string. The result is a string value, not a string object.
toLowerCase()
Method returns a string equal in length to the length of the result of converting this object to a string. The result is a string value, not a string object. Every character of the result is equal to the corresponding character of the string, unless that character has a Unicode 2.0 lowercase equivalent, in which case the lowercase equivalent is used instead. (The canonical Unicode 2.0 case mapping shall be used, which does not depend on implementation or locale.
toString()
Method returns this string value. When concerned with the placement and use of whitespace line terminators, and semicolons within the representation string is implementation-dependent.
toUpperCase()
Method returns a string equal in length to the length of the result of converting this object to a string. The result is a string value, not a string object. Every character of the result is equal to the corresponding character of the string, unless that character has a Unicode 2.0 uppercase equivalent, in which case the uppercase equivalent is used instead. The canonical Unicode 2.0 case mapping shall be used, which does not depend on implementation or locale.
valueOf()
Method returns this string value. The valueOf() function is not generic. Therefore it will generate a runtime error if the object is not a String object.
Date()
constructor of the Date may have various signatures. The date constructor format can accept up to 7 parameters. Here is the format: new Date(year,month,date,hrs,mins,secs,ms)
getDate()
Method returns DateFromTime(LocalTime(t)).
getDay()
Method returns WeekDay(LocalTime(t)). The days of week are numbered from 0 -6. The number 0 represents Sunday and 6 represents Saturday.
getFullYear()
Method returns YearFromTime(LocalTime(t)).
getHours()
Method returns HourFromTime(LocalTime(t)).
getMilliseconds()
Method returns msFromTime(LocalTime(t)).
getMinutes()
Method returns MinFromTime(LocalTime(t)).
getMonth()
Method returns MonthFromTime(LocalTime(t)). The months are returned as an integer value from 0-11. The number 0 represents January and 11 represents December.
getSeconds()
Method returns SecFromTime(LocalTime(t)).
getTime()
Method returns a number, which is this time value. The number value is a millisecond representation of the specified Date object.
getTimezoneOffset()
Method returns (t * LocalTime(t)) / msPerMinute. The difference is in minutes between (GMT) and local time.
getUTCDate()
Method returns DateFromTime(t).
getUTCDay()
Method returns WeekDay(t). The days of week are numbered from 0 -6. The number 0 represents Sunday and 6 represents Saturday.
getUTCFullYear()
Method returns YearFromTime(t). There does not exist a getYearUTC method, therefore this method must be used to obtain a year from an UTC Date object.
getUTCHours()
Method returns HourFromTime(t).
getUTCMilliseconds()
Method returns msFromTime(t).
getUTCMinutes()
Method returns MinFromTime(t).
getUTCSeconds()
Method returns SecFromTime(t).
getYear()
Method returns YearFromTime(LocalTime(t))—1900. \The function getFullYear() is much to be preferred for nearly all purposes, because it avoids the year 2000 problem.
parse(string)
Method applies the ToString operator to its argument and interprets the resulting string as a date; it returns a number, the UTC time value corresponding to the date. The string may be interpreted as a local time, a UTC time, or a time in some other time zone, depending on the contents of the string.
setDate(date)
Method sets the [Value] property of this value to UTC ECMAScript.Date. Returns the value of the [Value] property of the this value. If the [Value] property of this exceeds 30 or 31, the [Value] of this will then be added to the existing date value, not set.
setFullYear(year[,mon[,date]])
Method sets the [Value] property of this value to UTC ECMAScript.Date. Returns the value of the [Value] property of the this value.
setHours(hour[,min[,sec[,ms]]])
Method sets the [Value] property of this value to UTC time. Returns the value of the [Value] property of the this value. When entering a value for hours, an hour value greater than 23 will be added on to the exisitng hour value, not set.
setMilliseconds(ms)
Method computes UTC from argument and sets the [Value] property of this value to TimeClip(calculatedUTCtime). Returns the value of the [Value] property of the this value.
setMinutes(min[,sec[,ms]])
Method sets the [Value] property of this value to UTC time. Returns the value of the [Value] property of the this value.
setMonth(mon[,date])
Method sets the [Value] property of this value to UTC ECMAScript.Date. Returns the value of the [Value] property of the this value. If the [Value] property of this exceeds 11, the [Value] property for this will be added to the existing month, not set
setSeconds(sec [, ms ] )
Method sets the [Value] property of this value to UTC time. Returns the value of the [Value] property of the this value.
setTime(time)
Method sets the [Value] property of the this to TimeClip(time). Returns the value of the [Value] property of the this value. The [Value] property of this is a millisecond value that is converted by the TimeClip(time) method.
setUTCDate(date)
Method sets the [Value] property of this value to ECMAScript.Date. Returns the value of the [Value] property of the this value. If the [Value] property of this exceeds 30 or 31, the [Value] of this will then be added to the existing date value, not set.
setUTCFullYear(year[,mon[,date]])
Method sets the [Value] property of this value to ECMAScript.Date. Returns the value of the [Value] property of the this value.
toGMTString()
Returns a string value. The contents of the string are implementation-dependent, but are intended to represent the Date in a convenient, human-readable form in UTC. NOTE: This function is for backwards compatibility only. Its use is not recomended. Use toUTCString() instead.
setUTCHours(min[,sec[,ms]])
Method sets the [Value] property of this value to time. Returns the value of the [Value] property of the this value. When entering a value for hours, an hour value greater than 23 will be added on to the exisitng hour value, not set.
setUTCMilliseconds(ms)
Method sets the [Value] property of this value to time and returns the value of the [Value] property of the this value.
setUTCMinutes(min[,sec[,ms]])
Method sets the [Value] property of this value to time. Returns the value of the [Value] property of the this value.
setUTCMonth(mon[,date])
Method sets the [Value] property of this value to ECMAScript.Date. Returns the value of the [Value] property of the this value. If the [Value] property of this exceeds 11, the [Value] property for this will be added to the existing month, not set
setUTCSeconds(sec [, ms ] )
Method sets the [Value] property of this value to time. Returns the value of the [Value] property of the this value.
setYear(year)
Method sets the [Value] property of this value to UTC ECMAScript.Date. Returns the value of the [Value] property of the this value. Use of this function is not recomended. The function setFullYear is much to be preferred for nearly all purposes, because it avoids the year 2000 problem.
toLocaleString()
Method returns a string value. The contents of the string are implementation-dependent, but are intended to represent the Date in a convenient, human-readable form appropriate to the geographic or cultural locale.
toString()
Method returns this string value. The contents of the string are implementation-dependent, but are intended to represent the Date in a convenient, human-readable form in the current time zone.
toUTCString()
Method returns a string value. The contents of the string are implementation-dependent, but are intended to represent the Date in a convenient, human-readable form in UTC.
UTC()
Method, which may accept different number of arguments. UTC function differs from the Date constructor in two ways: it returns a time value as a number, rather than creating a Date object, and it interprets the arguments in UTC rather than as local time.
valueOf()
Method returns a number, which is this time value. The valueOf() function is not generic. Therefore it will generate a runtime error if the object is not a Date object.
Array()
Constructor
Array join(separator)
The elements of the array are converted to strings, and these strings are then concatenated, separated by occurrences of the separator. If no separator is provided, a single comma is used as the separator.
Array length The length property of this Array object
Array reverse()
The elements of the array are rearranged so as to reverse their order. The object is returned as the result of the call.
Array sort()
The elements of this array are sorted. The sort is not necessarily stable. If comparefn is supplied, it should be a function that accepts two arguments x and y and returns a negative value if x < y, zero if x = y, or a positive value if x > y.
Array toString()
The elements of this object are converted to strings, and these strings are then concatenated, separated by comma characters. The result is the same as if the built-in join method were invoked for this object with no argument.
BOOLEAN OBJECT
Boolean()
Constructor
Boolean toString()
If this boolean value is true, then the string "true" is returned. Otherwise, this boolean value must be false, and the string "false" is returned.
Boolean valueOf()
Returns this boolean value.
Function Constructor. The last argument specifies the body (executable code)
of a function; any preceding arguments specify formal parameters.
The value of the length property is usually an integer that indicates the "typical" number of arguments expected by the function. However, the language permits the function to be invoked with some other number of arguments. The behaviour of a function when invoked on a number of arguments other than the number specified by its length property depends on the function.
String toString()
An implementation-dependent representation of the function is returned. This representation has the syntax of a FunctionDeclaration. Note in particular that the use and placement of whitespace, line terminators, and semicolons within the representation string is implementation-dependent.
ECMAScript provides certain "top-level" methods and properties, so-called because they are not parented off any particular object.
String escape()
The escape function computes a new, URL-legal version of a string in which certain URL-illegal characters have been replaced by hexadecimal escape sequences.
eval()
When the eval function is called with one argument x, the following steps are taken: 1. If x is not a string value, return x. 2. Parse x as an ECMAScript Program. If the parse fails, generate a runtime error. 3. Evaluate the program from step 2. 4. If Result(3) is "normal" completion after value "V", return the value V. 5. Return undefined.
A special primitive value representing positive infinity.
isFinite()
Applies Number( ) to its argument, then returns false if the result is NaN, +*, or **, and otherwise returns true.
isNan()
Returns true if the argument evaluates to NaN ("not a number"), otherwise returns false.
NOTE: Any form of logical comparison of NaN against anything else, including itself, returns false. Use isNaN( ) to determine whether a variable (or a return value, etc.) is equal to NaN.
The primitive value NaN represents the set of IEEE standard "Not-a-Number" values.
number parseFloat()
Produces a floating-point number by interpretation of the contents of the string argument. If the string cannot be converted to a number, the special value NaN (see above) is returned.
number parseInt()
Produces an integer value dictated by interpretation of the contents of the string argument, according to the specified radix.
String unescape()
The unescape function computes a new version of a string value in which each escape sequences of the sort that might be introduced by the escape function is replaced with the character that it represents.
All of the Math object's properties and methods are static, which means you should prepend "Math" to the property or method name in your code. For example, use "Math.PI," not simply "PI."
The number value for e, the base of the natural logarithms, which is approximately 2.7182818284590452354.
The number value for the natural logarithm of 10, which is approximately 2.302585092994046.
The number value for the natural logarithm of 2, which is approximately 0.6931471805599453.
The number value for the base-2 logarithm of e, the base of the natural logarithms; this value is approximately 1.4426950408889634. (Note that the value of Math.LOG2E is approximately the reciprocal of the value of Math.LN2.)
The number value for the base-10 logarithm of e, the base of the natural logarithms; this value is approximately 0.4342944819032518. (Note that the value of Math.LOG10E is approximately the reciprocal of the value of Math.LN10.)
The number value for *, the ratio of the circumference of a circle to its diameter, which is approximately 3.14159265358979323846.
The number value for the square root of 1/2, which is approximately 0.7071067811865476. (Note that the value of Math.SQRT1_2 is approximately the reciprocal of the value of Math.SQRT2.)
The number value for the square root of 2, which is approximately 1.4142135623730951.
Number abs(x)
ECMAScript function of the Math Object This function returns the absolute value of the argument x; in general, the result has the same magnitude as the argument but has positive sign. The input value x can be any number value. Example: Math.abs(-123.23940) = 123.23940
Number acos(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the arc cosine of the argument. The result is expressed in radians and ranges from +0 to +PI(3.14159...)radians. The input value x must be a number between -1.0 and 1.0. Example: PI/4 = 0.785 Math.acos(0.785) = 0.6681001997570769.
Number asin(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the arc sine of the argument. The result is expressed in radians and ranges from -PI/2 to +PI/2. The input value x must be a number between -1.0 and 1.0. Example: PI/4 = 0.785 Math.asin(0.785) = 0.9026961270378197.
Number atan(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the arc tangent of the argument. The result is expressed in radians and ranges from -PI/2 to +PI/2. The input value x can be any number. Example: 3PI/4 = 2.355 Math.atan(2.355) = 1.1692404275454853.
Number atan2(x,y)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the arc tangent of the quotient y/x of the arguments y and x, where the signs of the arguments are used to determine the quadrant of the result. Note that it is intentional and traditional for the two-argument arc tangent function that the argument named y be first and the argument named x be second. The result is expressed in radians and ranges from -PI to +PI. The input value x is the x-coordinate of the point. The input value y is the y-coordinate of the point. Example: PI/2 = 1.57 Math.atan2(1.57,-1.57) = 2.356194490192345.
Number ceil(x)
ECMAScript function of the Math Object This function returns the smallest (closest to -infinity) number value that is not less than the argument and is equal to a mathematical integer. If the argument is already an integer, the result is the argument itself. The input value x can be any numeric value or expression. The Math.ceil(x) function property is the same as -Math.floor(-x). Example:
Math.ceil(123.78457) = 123.
Number cos(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the cosine of the argument. The argument must be expressed in radians.
Number exp(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the exponential function of the argument (e raised to the power of the argument, where e is the base of the natural logarithms). The input value x can be any numeric value or expression greater than 0. Example:
Math.exp(10) = 22026.465794806718.
Number floor(x)
ECMAScript function of the Math Object This function returns the greatest (closest to +infinity)number value that is not greater than the argument and is equal to a mathematical integer. If the argument is already an integer, the result is the argument itself. The input value x can be any numeric value or expression.
Example:
Math.floor(654.895869)=654.
Number log(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to natural logarithm of the argument. The input value x can be any numeric value or expression greater than 0. Example:
Math.log(2) = 0.6931471805599453.
Number max(x,y)
ECMAScript function of the Math Object This function returns the larger of the two arguments. The input values x and y can be any numeric values or expressions. Example:
Math.max(12.345,12.3456)= 12.3456.
Number min(x,y)
ECMAScript function of the Math Object This function returns the smaller of the two arguments. The input values x and y can be any numeric values or expressions. Example:
Math.min(-12.457,-12.567)= -12.567.
Number pow(x,y)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the result of raising x to the power of y. The input value x must be the number raised to a power. The input value y must be the power that x is to be raised to. Example:
Math.pow(2,4) = 16.
Number random()
ECMAScript function of the Math Object This function returns a number value with a positive sign, greater than or equal to 0 but less than 1. The number value is chosen randomly or pseudo randomly with approximately uniform distribution over that range, using an implementation-dependent algorithm or strategy. This function takes no arguments. Example: Math.random()=0.9545176397178535.
Number round(x)
\ECMAScript function of the Math Object This function returns the number value that is closest to the argument and is equal to a mathematical integer. If two integer number values are equally close to the argument, then the result is the number value that is closer to +infinity. If the argument is already an integer, the result is the argument itself. The input value x can be any number. Example: Math.round(13.53) = 14.
Number sin(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the sine of the argument. The argument is expressed in radians. The input value x must be an angle measured in radians. To convert to radians multiply the input value by 0.017453293(2PI/360). Example: PI/2 = 1.57 Math.sin(1.57) = 0.9999996829318346.
Number sqrt(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the square root of the argument. The input value x must be any numeric value or expression greater than or equal to 0. If the input value x is less than zero, the string "NaN" is returned. The string "NaN" stands for "Not a Number".Example: Math.sqrt(25) = 5.
Number tan(x)
ECMAScript function of the Math Object This function returns an implementation-dependent approximation to the tangent of the argument. The argument is expressed in radians. The input value x must be an angle measured in radians. To convert to radians multiply the input value by 0.017453293(2PI/360). Example: PI/4 = 0.785 Math.tan(0.785) = 0.9992039901050427
Constructor for Object.
Object toString()
When the toString method is called on an arbitrary object, the following steps are taken: 1. Get the [[Class]] property of this object. 2. Compute a string value by concatenating the three strings "[object ", Result(1), and "]". 3. Return Result(2).
Object valueOf()
As a rule, the valueOf method for an object simply returns the object; but if the object is a "wrapper" for a host object, as may perhaps be created by the Object constructor, then the contained host object should be returned.
Copyright © 2004 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved. more ...