 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
|
 |
|
 |
|
 |
|
 |
|
|
Developer's ReferenceScripting reference through HTML to the workspace will vary between workspaces as there is some standard functionality maintained, but most functionality will be unique to each individual workspace as each has a unique control set along with unique script tied to each control. This document outlines the available calls that can be made for the Simpliciti Locked down browser. Some of these calls might be deprecated as of this point as there have been changes to the workspace over time. All scripting references to the workspace through HTML within the browser control must be done with the following syntax: window.external.(reference) Where (reference) is one of the following objects that each contain it’s own set of methods and properties, or one of the following properties. Objects: AuthorizationManager - Authorization control within the workspace CommandManager - Houses published commands for the workspace EventManager - Houses published events for the workspace Registry - Access object to perform registry access Repository - Store of image files used in the workspaces SchemeManager - Manages window schemes in the workspace StateManager - Handles state management StatusBar - Reference the status bar at the bottom of the container Detailed Object Information:AuthorizationManager: These functions are used to perform an authorization check to see if the current user has the required privileges. Methods: (All of these will return a Boolean to indicate authorization
status) Exit_AttractLoop ExitApplication Kiosk POS Settings StopSession StoreNet CommandManager: The command manager contains all generic commands as well as the commands that are supplied to the workspace through command publishing on the controls or through workspace extensions. Methods: AttractBrowser_GoHome - Force the attract loop’s browser to go home Parameters: None Return: None BrowserForFolder - Displays a dialog to browser for a folder Parameters: (Title As String) Return: String ChangeAdminPassword - Displays prompt for changing admin password Parameters: None Return: None ClearOverrides - Clears the authorization overrides Parameters: None Return: None EnableAccelerators - Enable/Disable workspace accelerator manager Parameters: (Enabled As Boolean) Return: None Exit - Exit the workspace Parameters: None Return: None GetCursorX - Returns cursor X co-ordinate Parameters: None Return: Long GetCursorY - Returns cursor Y co-ordinate Parameters: None Return: Long GetFileName - Display a dialog to browse for a file Parameters: (StartFolder As String, Title As String, Filter As String, FileMustExist as Boolean) Return: String IsDefaultBrowser - NOT IMPLEMENTED IN THIS WORKSPACE IsDocumentAsShell - Informs whether the workspace is the shell Parameters: None Return: Boolean KioskBrowser_GoHome - Call home on the kiosk browser Parameters: None Return: None KioskBrowser_Navigate2 - Call Navigate on the kiosk browser Parameters: (URL As Variant) Return: None KioskFullBrowser_GoBack - Call back on the Full Screen kiosk browser Parameters: None Return: None KioskFullBrowser_GoForward - Call forward on the Full Screen kiosk browser Parameters: None Return: None KioskFullBrowser_GoHome - Call home on the Full Screen kiosk browser Parameters: None Return: None KioskFullBrowser_Navigate2 - Call navigate on the Full Screen kiosk browser Parameters: (URL As Variant) Return: None LoadPicture - Creates an image that can be used in the repository Parameters: (File As String) Return: Object (This object can be used in the repository functions) LocalUserAuthorizations - Display local user authorization dialog Parameters: None Return: None MessageBox - Standard messagebox function Parameters: (Message As String, Title As String, Timeout As Long, Type As Long, MinTime As Long) Return: None OverrideLockDown - Override the lockdown state of the workspace Parameters: (LockDown As Boolean) Return: None RegisterAsDefaultBrowser - NOT IMPLEMENTED IN THIS WORKSPACE ResetLockDown - Reset Lockdown state to workspace default Parameters: None Return None SetDocumentAsShell - Set/Reset this workspace as the shell for the OS Parameters: (IsShell As Boolean) Return: None SetFullScreen - Set/Reset the container to FullScreen Parameters: (FullScreen As Boolean) Return: None ShowHelp - Display the help file Parameters: (HelpFile As String, Context As Long) Return: None EventManager:
Methods: ClearHistory - Clear the history of the browsers EventData: (RedirectUrl As String) ClearHistoryAndCookies - Clear the history and cookies for the browsers EventData: (RedirectUrl As String) Kiosk_BrowserCommand - Allows single call to handle all nav options EventData: “Home”, “Back”, “Forward”, “Refresh”, “Stop”, “ZoomIn”, “ZoomOut”, “Print” ShowBack - Show/Hide the back button EventData: (Visible As Boolean) ShowForward - Show/Hide the forward button EventData: (Visible As Boolean) ShowMenu - Show/Hide the menu button EventData: (Visible As Boolean) ShowPrint - Show/Hide the print button EventData: (Visible As Boolean) ShowRefresh - Show/Hide the refresh button EventData: (Visible As Boolean) ShowStop - Show/Hide the stop button EventData: (Visible As Boolean) ShowZoomIn - Show/Hide the zoomin button EventData: (Visible As Boolean) ShowZoomOut - Show/Hide the zoomout button EventData: (Visible As Boolean) ShowAddressBar(false) - Hide the address bar ShowAddressBar(true) - Show the address bar AttractTimerSet event - Change the value of the attract timer Registry: The Registry object is used to read/write from the registry through script. In order to use it the first call must be to assign the Branch property with the registry root that the methods will be calling on. (See MSDN for more information on registry functions) Methods: Close - Close the active key Parameters: None Return: None Create - Create a key Parameters: (KeyName As String) Return: Boolean DeleteSubKey - Delete the specified key Parameters: (KeyName As String) Return: Boolean DeleteValue - Delete the value from the registry Parameters: (ValueName As String) Return: Boolean Open - Open the specified registry branch Parameters: (KeyName As String) Return: Boolean QueryValue - Query the value stored in the registry Parameters: (ValueName As String) Return: Variant SetKeyValue - Set the value under the specified key Parameters: (KeyName As String, Value As String, ValueName As String) Return: Boolean SetValue - Set the value under the active key Parameters: (Value As Variant, ValueName As String) Properties: Branch - Assign the registry key root the operations will occur on HKEY_LOCAL_MACHINE = 1 HKEY_CURRENT_USER = 2 HKEY_CLASSES_ROOT = 3 Repository: The Repository is the object that contains all the images that are available in the workspace. Individual controls (like buttons, components, etc…) can reference the images in the repository by name, and thus have the capability to change the what the named image refers to without touching the control itself. Methods: ReplaceImage - Replace an image in the repository with a new image Parameters: (ImageName As String, NewImage As Object) Return: Boolean ResetImage - Reset the image in the repository to the default one Parameters: (ImageName As String) Return: None Update - Update the workspace to redraw itself with the new images Parameters: None Return: None Sample Pages: Address Bar (hide/show) http://www.simpliciti.biz/demos/addresstest.htm Show /Hide Nav bar buttons http://www.simpliciti.biz/demos/test2.html Clear
History sample http://www.simpliciti.biz/demos/clearhistory.html SchemeManager: The SchemeManager is responsible for rendering the scheme on the container and popup dialogs that occur within the workspace. The SchemeManager is a warehouse of all the color and border options for a given scheme and allows the user to change individual properties. Mask images refer to the hittesting regions for a border image that determine a sizing region versus a moving region for when the user clicks on that part of the border. The Scheme Parameters refers to one of the four available scheme types located in a given workspace. The Window scheme is the most often used. 0 – Container Scheme (the scheme applied to the container’s border) 1 – Window Scheme (the scheme applied to the workspace content and popup windows) 2 – Desktop Inner (the scheme applied to the deskband inner state) 3 – Desktop Outer (the scheme applied to the deskand outer state) The Region Parameters refer to one of the 20 border regions defined. BR_TOP_LEFT = 1, BR_TOP_TOP_LEFT = 2, BR_MIDDLE_TOP = 3, BR_TOP_TOP_RIGHT = 4, BR_TOP_RIGHT = 5, BR_RIGHT_RIGHT_TOP = 6, BR_MIDDLE_RIGHT = 7, BR_RIGHT_RIGHT_BOTTOM = 8, BR_BOTTOM_RIGHT = 9, BR_BOTTOM_BOTTOM_RIGHT = 10, BR_MIDDLE_BOTTOM = 11, BR_BOTTOM_BOTTOM_LEFT = 12, BR_BOTTOM_LEFT = 13, BR_LEFT_LEFT_BOTTOM = 14, BR_MIDDLE_LEFT = 15, BR_LEFT_LEFT_TOP = 16, BR_TOP_EDGE = 17, BR_RIGHT_EDGE = 18, BR_BOTTOM_EDGE = 19, BR_LEFT_EDGE = 20 The Button Parameter refers to the available buttons that are used in a border definition. BTR_CLOSE = 1, BTR_MAX = 2, BTR_MIN = 3, BTR_RESTORE_MIN = 4, BTR_RESTORE_MAX = 5, The ButtonState refers to the available button states that a button can exist at. BS_NORMAL = 1, BS_DOWN = 2, BS_OVER = 3, BS_DISABLED = 4 The following is a list of available color properties that can access by calling Get/Set with the following syntax. [ TextColor – SetTextColor(Scheme, Color) or GetTextColor(Scheme) which returns a Color ] Each color property can be accessed with the same mutator/accessor combination. ControlColor TextColor HeaderTabColor CaptionTextColor NormalTopColor NormalBottomColor MouseOverTopColor MouseOverBottomColor DownTopColor DownBottomColor DisabledTopColor DisabledBottomColor ButtonTextColor EditBoxBackColor EditBoxTextColor ListBoxBackColor ListBoxTextColor ListViewBackColor ListViewTextColor TreeViewBackColor TreeViewTextColor ComboBoxBackColor ComboBoxTextColor Methods: (other methods than can be referenced) OverlayImage - Creates a composite image from 2 other images Parameters: (Source As Object, Overlay As Object, X As Long, Y as Long, Width As Long, Height As Long, FillColor As Color) Return: Object SetImage - Change an image from the border definition Parameters: (Scheme As Long, Region As Long, Picture As Object) Return: None SetMask - Change a mask image from the border definition Parameters: Scheme As Long, Region As Long, Picture As Object) Return: None SetButtonImage - Change a standard button image (ie.Close) Parameters: (Scheme As Long, Button As Long, ButtonState As Long, Picture As Object) Return: None Update - Refresh windows to use changes to the scheme Parameters: None Return: None ReplaceScheme - Load a scheme file Parameters: (Scheme As Long, SchemeFile As String) Return: None GetBackGround - Returns the background image for popup windows Parameters: (Scheme As Long) Return: Object GetImage - Gets the current image at the border region Parameters: (Scheme As Long, Region As Long) Return: Object GetMaskImage - Get the current mask image at the border region Parameters: (Scheme As Long, Region As Long) Return: Object GetButtonImage - Get current image for the given button and state Parameters: (Scheme As Long, Button as Long, ButtonState As Long) Return: Object IsPaintingOverrideEnabled - Indicates whether painting overriding is enabled Parameters: (Scheme As Long) Return: Boolean GetCustomImage - Get image from schemes custom image repository Parameters: (Scheme As Long, ImageName As String) Return: Object CustomImageCount - Get count of available images Parameters: (Scheme As Long) Return: Long StateManager: The StateManager object is used to manager interaction between the states for a given workspace. It is used in order to jump to and from the available states. Methods: Admin - Jump directly to the Admin state Parameters: None Return: Boolean Attract - Jump directly to the Attract state Parameters: None Return: Boolean GoTO - Go directly to a state by name Parameters: (StateName As String) Return: Boolean Kiosk - Jump directly to the Kiosk state Parameters: None Return: Boolean Kiosk_Full - Jump directly to the Kiosk_Full state Parameters: None Return: Boolean NextState - Go to the next state in the state progression Parameters: None Return: Boolean PopState - Go back to the previously pushed state Parameters: None Return: Boolean PreviousState - Go to the previous state in the state progression Parameters: None Return: Boolean PushState - Go to the state by name and push the current state Parameters: (StateName As String) Return: Boolean StatusBar: RemovePartition - Remove a custom partition from the status bar Parameters: (PartitionName As String) Return: None RequestPartition - Request a custom partition in the status bar Parameters: (PartitionName As String) Return: Boolean SetPartitionText - Set the text for a given partition Parameters: (PartitionName As String, PartitionText As String, State As Boolean) Return: None SetStatusText - Set the text for the main status bar partition Parameters: (Text As String) Return: None |
