Refer to the following tasks for further details on implementing these functions:
Submits a PF key to the host.
- key
The key to submit.
Example:
"[ENTER]", "[PF3]"
Sets the position of the cursor and then submits a PF key to the host.
Prompts the user to specify a host key (for example "[PF3]") and submits it to the host.
Sets the position from which the next PF key will be sent. In a standard 24X80 host screen, the position can be any number between 1 and 1920.
Executes an ApplinX Path Procedure for navigation purposes. When a folder is not specified, ApplinX server looks for the path in the directory of the current host screen. If the path cannot be found in the directory of the current host screen, ApplinX server looks for the path in the root directory. When a folder is specified, it needs to be relative to the root directory.
- pathName
The path to execute (case-sensitive).
For example:
ExecPath("gotoMainMenu") ExecPath("Common/gotoMainMenu")
Prompts the client to type in the system request and then submits it to the host. Equivalent to gx_SubmitKey("[sysreq]").
Places the Field Mark symbol in the currently selected input field, and moves the cursor to the next unprotected position. Handling of the symbol is dependent on the application program. Equivalent to gx_SubmitKey("[fieldmark]").
Simulates pressing the MainFrame duplicate (Dup) key. A duplicate symbol ("*") will appear in the currently selected input. Upon submitting the form, APX server will send the dup command. This only works on host fields that allow duplicating (in the host application). The host should support this functionality as well.
Refer to the following task for further details on implementing these functions:
Moves to the first input element on the page. Equivalent to gx_SubmitKey("[home]").
Moves to last input element on the page. Equivalent to gx_SubmitKey("[end]").
Moves to the first input field you find in the rows below. Equivalent to gx_SubmitKey("[newline]").
Sets the cursor on the next input field on the screen, relative to currTextBox.
For example:
<input type="button"
onclick="gx_jumpToNextInput(this)"...
Sets the cursor on the previous input field on the screen, relative to currTextBox
For example:
<input type="button" onclick="gx_jumpToPrevInput(this)"...
Refer to the following tasks for further details on implementing these functions:
Each table in a generated page keeps track of the selected row in the HTML table by a hidden field, which is added automatically.
This JavaScript function, when called inside a table row, updates this hidden field with the row number (by default) or row key to keep track of the selected row on the server-side.
Can be inserted by an on click event on a table row (tr) or a link/button placed inside a table cell.
- elem
Any element inside a table row (including the TR element itself).
Returns the selected key after gx_selectKey was called.
- tableName
The name/ID of the HTML table whose selected value we want to retrieve.
Query if a row was selected. Used for validation to force a row selection.
Possible values: true/false
- tableName
The name of the HTML table.
Can be called in a table row (tr) event. This function marks the clicked row with the selected row css class name.
Can be used by ApplinX css: gx_markRow(this,"gx_tbl_selected")
Refer to the following tasks for further details on implementing these functions:
Toggles between the display styles specified in the web application configuration (In Emulation node>Color Set).
Sets the display style to the specified style sheet.
- cssName
Style sheet URL.
Increases the font size used in the Web application. This function is called by the plus link in the page footer. The maximum font size is 20px. Refer to Enabling the User to Control the Font Size.
Decreases the font size used in the Web application. This function is called by the minus link in the page footer. The minimum font size is 7px. Refer to Enabling the User Control the Font Size.
Changes the font size used in the Web application to the specified size.
- size
An integer. The new font size in pixels.
Refer to the following tasks for further details on implementing these functions:
This function allows developers to attach JavaScript functions to specific keyboard keystrokes.
- additionalKey
Possible values : 0-none, 1-CTRL, 2-ALT, 3-SHIFT
- keyCode
An integer. The ASCII code of the pressed key. For example: Enter = 13
- functionElement
The JavaScript element to execute.
- overrideExisting
A boolean parameter indicating whether to override the existing XML keyboard mapping definition (gx_keyboardmapping.xml) .
- cancelMapFunction
Optional. A function element that returns either true or false, determining whether to execute the keyboard mapping function or not. True, cancels the mapped function and False executes the function.
When CTRL+ESC are pressed, executes a confirm
function(myConfirmFunc). When confirmed, performs the
myLogoff function.
gx_AddKeyboardMapping(1,27,myLogoff,true,myConfirmFunc)
When CTRL+ESC are pressed, executes the myLogoff function.
gx_AddKeyboardMapping(1,27,doLogoff,true)
Overrides the default PF3 action with a do-nothing action (
void(0) ).
gx_AddKeyboardMapping(0,27,void(0),true)
A distinction is made between the two keys (on numeric keypad and the main keyboard), using the following line in the configuration file keyboardMapping.XML:
<GXKeyboardMapping additionalKey="0" keyCode="numpadENTER" targetFunction="[Function]"/>
Note:
This applies only to the following browsers: Firefox 29 and above;
Chrome; Internet Explorer 11.
GXEvent is a Wrapper for a browser event. This wrapper provides a cross browser event object.
Refer to the following task for further details on implementing these functions:
Sets or retrieves the Unicode key code associated with the key that caused the event.
An integer representing the key that was pressed in addition to the key that triggered the event. Possible values: 0-none, 1-CTRL, 2-ALT, 3-SHIFT
Retrieves the element that fired the event.
Cancels the event and stops it from bubbling further up the hierarchy of event handlers.
The following example will cancel the OnKeyDown whenever
the [ENTER] key is pressed in a specific text area ("myTextArea"), prevent the
page from being submitted and manually add a newline to the text area
value:
Add the following to globalOnKeyDown function in the
userExits.js file:
function globalOnKeyDown(gx_event){
.........
var win = gx_event.window;
if (gx_event.keyCode==13 && gx_event.element.id=="myTextArea"){
gx_event.cancel();
GXBrowserUtil.getElement("myTextArea").value += "\r\n"
}
.........
}
Assume your JSP/ASPX page has the following input: <textarea
row="5" id="myTextArea" ></textarea>
Refer to the following task for further details on implementing these functions:
Boolean. Retrieves whether or not the browser is Microsoft Internet Explorer.
Boolean. Retrieves whether or not the browser is Microsoft Internet Explorer 7 or higher.
Boolean. Retrieves whether or not the browser is Mozilla Firefox.
GXLog is used to handle client side JavaScript logging. While mostly used by the ApplinX web application JavaScript engine, users can also add their own log messages. Refer to JavaScript Logger Engine for further details.
Adds a log message only when in debug mode.
- moduleName
This parameter can be an empty string. However, in order to make log messages more distinctive in the log, it is recommended to add a unique value to the
engineConfig debugModulesproperty in config/gx_clientConfig.xml and then use that value as themoduleNamefor debugging the JavaScript.- message
The log message.
Adds a log message only when in Warning mode.
Adds a log message only when in Error mode.
GXValidator represents an array of validators, used to validate the form's data before submitting it to the host.
Refer to the following task for further details on implementing these functions:
Adds a validator to the array.
Clears the validator array.
The following example is automatically added to every JSP/ASPX page generated by ApplinX:
var pageValidator = new function(){
this.validateField = function(inputField){
if (inputField.name == "FIELD_A"){
if (inputField.value == ""){
return "Field cannot be empty";
}
}
// ...
}
}
function pageOnLoad(){ // register validator function
GXValidator.registerValidator(pageValidator);
}
This validator checks that "Field_A" has a value. Otherwise, it returns an error message.
GXWindow interacts with ApplinX framework's server side gx_window(.NET)/getGXWindow() (JSP). In addition, gx_window can perform actions on the browser side using the following methods:
Refer to the following task for further details on implementing these functions:
Locks the current main window, opens a new pop-up window and loads the document specified by a given URL (page).
Sets the size of the window to the specified width and height values.
Moves the screen position of the upper-left corner of the window to the
specified posX and posY position.
Sets the value or InnerHTML property of field fldName, to
the specified fldVal.
Closes the window. If the main window is closed the host session will be disconnected.
In pop-up windows, retrieves the parent window element.
Loads a URL. The PageName represents the URL of the document that is to be loaded.
Loads a URL. The PageName represents the URL of the document that is to be loaded.
<script>
function getData(){
gx_window.open("myData.jsp",200,300,0,0) ;
// .NET
// gx_window.open("myData.ASPX",200,300,0,0);
}
</script>
<input id="myInput" value=" "/>
<a href="#" onclick=" getData ();">open Win</a>
function setMainWindowInput(){
// Set the value of an Input on the main window
gx_window.getOpener().
gx_getElement("myInput").value="someValue";
// Unlock the main window before closing the pop up
gx_window.getOpener().gx_unlockScreen();
// Close the pop up window
gx_window.close();
}
<a href="#" onclick=" setMainWindowInput ();">close Win</a>
This functionality can only be used once this feature has been selected in the Framework Configuration Editor. This feature is used for updating a specific part of the page (can only be used once within a single page). This is useful when sorting/scrolling within host tables or working with tabs. Call this function just before a submitting a key to the host.
- panelId
The server side control ID, whose content we wish to update.
Boolean. Returns "true" if
inputElement is either a combo box, text area or an input tag of
the following type: radio, check box, password or text. Otherwise returns
"false".
- inputElement
The input field to validate.
Similar to document.getElementById("id"), this function
retrieves the required HTML object from the active frame according to its
identifier (elemtId).
Removes text from an input field, leaving only the text before the cursor.
Displays the calendar window, attaches it to a specific input or inputs (up to three inputs: day, month and year) and sets the format the selected date will be displayed with.
- Title
Calendar window title.
- dateFieldName1/dateFieldName2/dateFieldName3
An Input field used to display the date (or part of it).
- Format1/Format2/Format3
The format in which the date will be displayed.
The fields dateFieldName2/dateFieldName3 and Format2/Format3 are optional and required only when there is more than one date field and date format.
<img onclick="gx_showCalendar('Select a date','BirthDate','MM-dd-yy')"...
<img onclick="gx_showCalendar('Select a date','day','dd' ,month,'MM', 'year','yyyy')...
Possible date format examples:
MMM, d, yyyy - March 22, 2009
dd/MM/yy - 22/03/09
MM-yyyy - 03-2009
Retrieves the value of the cookie <name>.
- name
The name of the cookie.
- GXLAFHandler.COLOR_CSS_COOKIE
Saves the user preferred Style sheet.
- GXLAFHandler.FONT_SIZE_COOKIE
Saves the user preferred font-size for Instant pages
- GXLAFHandler.RESOLUTION_COOKIE
Saves the user's screen width (this is useful when developers set the Instant configuration's font-size node to "Dynamic by screen resolution").
Sets the value in a specific (<name>) cookie.
- name
The name of the cookie.
- GXLAFHandler.COLOR_CSS_COOKIE
Saves the user preferred Style sheet.
- GXLAFHandler.FONT_SIZE_COOKIE
Saves the user preferred font-size for Instant pages
- GXLAFHandler.RESOLUTION_COOKIE
Saves the user's screen width (this is useful when developers set the Instant configuration's font-size node to "Dynamic by screen resolution").
- value
The value to be set to the cookie.
Refer to the following tasks for further details on implementing these functions:
Opens a customized print screen Web page that contains a text representation of the current host screen. This is used in order to print a snapshot of the current host screen.
Opens the file transfer dialog box.
Opens a new browser window with its own process. Useful when you need to open multiple sessions from the same Web application. The ApplinX emulation component ActiveX Object in the current page needs to be uncommented (see index.jsp/aspx page in the HTML emulation demo).
- url
The URL destination of the new window.
Hides/shows the Printlet window/frame. Will only work if the ApplinX application is printer enabled. Refer to Deploying the Printletfor more details about ApplinX printers.
Use this function to execute server side functionality.
- func
A string. The server side function name to be executed.
Example
Create a button in your JSP page that when clicked runs a server side
function called myServersideFunc:
<gx:input type="button" value="GO!" onserverclick=" myServersideFunc" />
The server side code must have a method like this:
public void myServersideFunc(){
.........
}
The ApplinX framework contains a built-in feature of a screen locker. The purpose of a screen locker is to indicate to the user by means of a message, that the application is processing your request, and that you are blocked from interfering with the current process by repressing a button/link or keyboard PF/ENTER.
Refer to the following tasks for further details on implementing these functions:
Locks/unlocks the screen locker. Can be used from client-side code to activate/cancel the screen locker. When the screen locker is locked, no additional host keys/links/buttons can be pressed until the screen locker is unlocked.
Disables/Enables the screen locker ("Please wait" message) before/after redirecting to a new page.
Usage: When the target page downloads a file, screen locking is not needed. Without using the following functionality the current page will get "stuck" with the "Please wait" message, which causes a lock on the page.
// Disable the screen locker
gx_disableScreenLocker();
// redirect to the excel download page, which opens a save/open/cancel window dialog
location.href = "excel.jsp"; // or "excel.aspx"
// Enable the screen locker after 2 seconds for the next page actions
window.setTimeout(gx_enableScreenLocker,2000);
The user exits file is located in the js directory of your web application. It allows you to add functionality to your pages without disrupting the framework's events.
Registering an event to a page means that the function is executed when the event bubbles up to the document level.
gx_engine.registerEvent(GXEventType.FOCUS,globalOnBlur);
Registering an event to an input means that the function is executed when the input fires the event:
gx_engine.attachInputTagsEvent (GXEventType.FOCUS, globalInputOnFocus);
This function sets the LabelFocus function:
labelFocus: This function is executed when the label is clicked.
labelBlur: This function is executed once the label has been clicked once and then another object became in focus.
gx_engine.setLabelFocusFunction(labelFocus,labelBlur);
Code placed in these global functions affects the whole application and therefore must be used carefully.
For example (taken from userExits.js):
function globalOnLoad(gx_event){
// use win.<SOMETHING> to access the page tags
// for example: win.document.GX_form
var win = gx_event.window;
// activate page scope function if exits
activateIfExists(gx_event,gx_event.window.pageOnLoad);
.........
}
Notice that every global function contains the line:
activateIfExists(gx_event,gx_event.window.functionName)which
executes the user functions: <functionName> (pageOnLoad in this case), if
indeed the function exists on the page. This enables running the mentioned
function (in the example above: pageOnLoad) in a specific page.
For Example: Adding the following function to a generated JSP/ASPX in the ApplinX web application will cause this function to automatically execute whenever the page is loaded and pop-up the alert message:
function pageOnLoad(){
alert("Hello World!!");
}
| Global function | Page level function | Description |
|---|---|---|
| globalOnLoad | pageOnLoad | Occurs immediately after a page is loaded. |
| globalOnKeyDown | pageOnKeyDown | Occurs when a keyboard key is pressed. |
| globalOnKeyPress | pageOnKeyPress | Occurs when the user presses an alphanumeric key. |
| globalOnKeyUp | pageOnKeyUp | Occurs when a keyboard key is released. |
| globalOnFocus | pageOnFocus | Occurs when an object gets focus. |
| globalOnBlur | pageOnBlur | Occurs when an object loses focus. |