Open Client New Features |
Open Client Administration |
 |
|
Open Client New Features |
Open Client Administration |
|
Open Client supports the Expander object that renders to the coordinates specified and when the expanded state is changed will animate the appearance/disappearance of the rows defined by the object. If the contracting/expanding of the rows alters the screen size relative to the browser window size significantly, Open Client will update the state of the browsers scroll bars such that all screen content is accessible. If resizable objects are present in a screen with an expanding area, then Open Client will, if required, resize those objects as the objects in the expanding area are contracted/expanded. See Expander Object at run-time.
PROIV Function Keys can inadvertently control browser features, for example F1 displays a help page, and F11 displays a full screen web page. Not all browsers allow this functionality to be turned off by a page script, and therefore, some Function Keys may not work as expected in a PROIV Function. To help resolve this issue, Open Client has introduced a built-in toolbar for the Function Keys that can be enabled by setting the Softkeys.enabled property in the Messages.properties file to TRUE. Click here to learn more about the Open Client Function Key Toolbar.
Open Client's display is controlled by its style sheets. There are two default style sheets supplied, PROIVDefaultStyle.css and PROIVFixedStyle.css. The PROIVDefaultStyle.css file contains style elements that may be changed for your applications, and PROIVFixedStyle.css contains elements that should not be changed unless the implementation of a widget is being replaced.
 |
Note: Warning: Changing style elements in the PROIVFixedStyle.css style sheet may stop a widget from working. Do not change the contents of the PROIVDefaultStyle.css as any updates released by PROIV will overwrite your changes. Instead you should create your own style sheet in the application resources area and use this to override style elements. |
Images used by Open Client are not held on your computer, they are held on the Open Client server. This means that there is only image location to maintain, and any changes are made available to all users with immediate effect.
The application images are stored in the appImages folder in the Application Resources folder, …/appResources/myApplication/appImages.
Click here to learn more about accessing images on the server.
Open Client uses several standard images (e.g. the Date Picker ) and these can be overridden by putting an image of the same name in the appImages folder. When the Open Client needs an image, it uses the resource paths defined for the service to check each appImages folder in turn looking for the image. If the image is not found then it looks in the …/appResources/appImages folder for the default Open Client images, and if it is still not found then a default image (proiv.gif) is used.
Open Client includes a web-based help system that maps PROIV Help Keywords to web pages. The default help page in Open Client explains how to configure a help system for an application.
To disable the Open Client help, set the status.helpButton property in the Messages.properties file to FALSE.
Status.helpButton = false
To configure help for an Open Client application, create a new folder called appHelp in the Application Resources folder, .../appResources/myApplication/appHelp.
The Open Client help can be configured in the following ways:
Put your own default help page in the appHelp folder and rename the page to be 'default_help.html'.
In your application, set the Help Keyword in the function to name of the help page, for example 'functionHelp.html'. In addition, it is important to create a default help page called 'default_help.html' for functions that do not have the Help Keyword set up.
Add the help pages to the appHelp folder.
Copy your default help page ('default_help.html') to the appHelp folder.
Edit the 'default_help.html', enter the keywords and the name of help file in the 'keywordsArray'.
See the following example:
<html>
<head>
<script language="JavaScript" type="text/javascript" src="help_topic.js"></script>
<script language="JavaScript" type="text/javascript">
function keywordRedirect() {
// add your entries after the example and before the empty array ([]). Each entry
// must end with a comma. Note that the empty array must be the last entry and
// must not end with a comma. You can remove the example.
var keywordsArray = [
['myKeywordExample', 'myHelpPageExample.html'],
[]
];
redirect(keywordsArray);
}
</script>
You may want to replace the text in the example as this appears if there are no keywords, or the keyword does not match any entries in the keywords array.
If the help pages are located on a different server, enter a full URL to the help page in the keywords array.
The help page in the keywords array can contain an anchor link so that it redirects to the correct place in a help page (e.g. myHelpPage.html#section2). The help page must have anchors embedded in it.
Copy the files help_object.json and PROIV_Help.js to the application resources appOjects folder (e.g. …/appResources/myApplication/appObjects/).
The PROIV_Help.js file contains a function called 'setProperty' that is called with the new keyword every time the PROIV Help Keyword changes. This function can be changed to perform the required action.
If an Open Client list box has a header and a vertical scrollbar, it has a at the top of the vertical scrollbar that resizes all columns in the list. Clicking this resizes all columns in the list in 3 different ways:
The columns are set to their initial widths as defined by the PROIV Developer.
The columns are set to the width of the longest text in the column.
The columns are set to the minimum width in an attempt to display all columns without horizontal scroll. There is an absolute minimum width for all columns and so it may not be possible to display all columns without horizontal scroll.
The Listbox.multiColumnResize property can be set in the Messages.properties file to specify the starting state of the column widths:
If set to default or not present, then state 1 is used. (See above)
If set to dataWidth, then state 2 is used. (See above)
If set to allColumns, then state 3 is used. (See above)
This property does not affect how the states are cycled, it only affects the starting state. The property applies to all list boxes in the application.
The Open Client Date Picker includes drop-down lists to select the month and the year. There are also two s for moving the year list backward and forwards. The current date is shown as is the currently selected date.
The Date Picker display is controlled by a style sheet and a set of properties in the Messages.properties file.
To change the style, copy the datePicker.css, date_picker_object.json and the PROIV_DatePicker.js files from the …/appResources/appObjects folder to the appObjects folder in the Application Resources folder.
The css file contains the style information for the Date Picker.
The js file contains the Date Picker implementation and this may be changed once the files have been copied. It has the following properties in the Messages.properties file and these can be set in the application resources version of this file (See the Open Client Message Properties section on how this file is used).
|
Property |
Description |
|
DatePicker.format |
The format of the date when presented as a string. The letters mm are the month, dd is the day of the month, yy is a two digit year and yyyy is a 4 digit year. The default is mm/dd/yyyy. |
|
DatePicker.charsForDay |
The number of characters from the day of the week (DatePicker.firstDayOfWeek) that should be used to represent the day in the calendar. The default is 1 (i.e. the first letter). |
|
DatePicker.inputAssist |
If set to TRUE, any input the user types into a date text field is automatically formatted and validated. |
|
DatePicker.firstDayOfWeek |
First day of the week displayed in the calendar. The default is 7 (Sunday). |
|
DatePicker.ascDescYears |
asc displays the Years drop-down list with ascending years. desc displays descending years. The default is asc. |
|
DatePicker.numberOfYears |
Number of years displayed the Years drop-down list. The default is 16. |
|
DatePicker.selectedYearPosition |
The position in the Years drop-down list of the currently selected year. The default is 8. |
|
DatePicker.yearsToMove |
The number of years that the Years list is moved forwards or backwards by the Year s. The default is 16. |
|
DatePicker.addFormatToTooltip |
If this is set to TRUE, the tool tip for a date edit box includes the date format (see above). |
|
DatePicker.monday - DatePicker.friday |
The defaults are ‘Monday’, 'Tuesday', 'Wednesday', 'Thursday', and 'Friday'. |
|
DatePicker.january - DatePicker.december |
The defaults are ‘January’, 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November' and 'December'. |
The Date Picker image is called datepicker.gif and can be changed by putting a file with the same name in the Application Resources appImages folder.
An edit box set up as date field can have edit assistance. This is turned on and off by the DatePicker.inputAssist property (see above). If enabled, date format characters (such a slashes) are automatically added in the correct places and the date is checked for validity as you type.
Open Client contains strings which are used for error messages, dialogues and other objects (e.g. the Date Picker) that are not generated by the PROIV Virtual Machine. If the client is being used in a multilingual environment, these strings may need to be available in different languages. See the Open Client Message Properties section for details.
Open Client positions widgets using the character properties defined by PROIV Developer. These properties are based on a grid of cells. In the PROIV Client, this was assumed to be one character per cell, but in the Open Client the cell size can be defined by the session properties' width factor and height factor. The width factor is the width in pixels of a cell and the height factor is the height in pixels of a cell. The defaults used by the Open Client are 9 and 20 to mirror the PROIV Client.
Topic ID: 800046