LookoutAdvisorPlugin/Documentation

LookoutAdvisorPlugin User Guide

This class is the Filemaker Plugin Class designed to be used with Lookout Medical Advisor's Filemaker application. It provides all the function definitions which are visible to FileMaker's scripting engine and it makes use of the DiagramSelector class which presents a Java GUI to the user.

360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

• chartSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
• LookoutAdvisor_CreateDiagramSelectorGUI ( cellPixelWidth ; cellPixelHeight ; surfaceImageContainer ; skeletalImageContainer ) — This is the function that the user calls in the Filemaker script to actually display the Java GUI to the user.
• LookoutAdvisor_GetGridValueAtIndex ( index ) — This function allows the user to get a sensation String at the given index in the grid.
• LookoutAdvisor_IsGridShowing ( ) — This function returns Yes if the grid is on.
• LookoutAdvisor_IsSurfaceDiagramShowing ( ) — This function returns Yes if the surface diagram is on.
• LookoutAdvisor_LastError ( ) — Returns the last error generated by the LookoutAdvisor plugin.
• LookoutAdvisor_SetGridDimensions ( gridWidth ; gridHeight ) — This function allows the dimensions of the grid in DiagramSelector to be set in Filemaker.
• LookoutAdvisor_SetGridValueAtIndex ( value ; index ) — This function allows the user to set a sensation String at the appropriate index in the grid.
• LookoutAdvisor_SetShowGrid ( YesOrNo ) — This function allows the user to show the grid in the Java app by passing in "Yes" or sets the grid to off by passing in "No".
• LookoutAdvisor_SetShowSurfaceDiagram ( YesOrNo ) — This function allows the user to set the surface diagram in the Java app by passing in "Yes" or

sets the Java app to show the skeletal diagram by passing in a "No"

Function Detail

chartSetErrorCapture ( errorCapture )

Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call chartSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.

Parameters:

errorCapture

set to true to suppress the default popups.

LookoutAdvisor_CreateDiagramSelectorGUI ( cellPixelWidth ; cellPixelHeight ; surfaceImageContainer ; skeletalImageContainer )

This is the function that the user calls in the Filemaker script to actually display the Java GUI to the user. This function may be called repeatedly with different images or pixel dimensions, but the underlying grid selection is preserved.

Parameters:

cellPixelWidth

The pixel width of each cell to be displayed in the Java GUI.

cellPixelHeight

The pixel height of each cell to be displayed in the Java GUI.

surfaceImageContainer

an FMData object that holds the surface image.

skeletalImageContainer

an FMData object that holds the skelatal image.

Returns: an FMText that indicates whether the user has chosen to continue, cancel or whether an error has occurred.

LookoutAdvisor_GetGridValueAtIndex ( index )

This function allows the user to get a sensation String at the given index in the grid. The grid numbering begins with index 0 at the top left counting left to right and then down. Typically this is the fourth function to be called in the Filemaker script.

Parameters:

index

The index in the grid were the String should be set.

Returns: an FMText which contains the String representing the chosen sensation. i.e. and X, O or S.

LookoutAdvisor_IsGridShowing ( )

This function returns Yes if the grid is on.

Returns: a "Yes" if the grid is showing, or "No" if the grid is not showing.

LookoutAdvisor_IsSurfaceDiagramShowing ( )

This function returns Yes if the surface diagram is on.

Returns: a "Yes" if the surface diagram is showing, or "No" if the skelatal is showing.

LookoutAdvisor_LastError ( )

Returns the last error generated by the LookoutAdvisor plugin.

Returns: a textual error message, or "" if the last operation completed successfully.

LookoutAdvisor_SetGridDimensions ( gridWidth ; gridHeight )

This function allows the dimensions of the grid in DiagramSelector to be set in Filemaker. Typically this is the first function to be called in the Filemaker script.

Parameters:

gridWidth

The width of the grid used by Filemaker.

gridHeight

The height of the grid used in Filemaker.

Returns: an FMType that indicates the success of the method call if it completes.

LookoutAdvisor_SetGridValueAtIndex ( value ; index )

This function allows the user to set a sensation String at the appropriate index in the grid. The grid numbering begins with index 0 at the top left counting left to right and then down. Typically this is the second function to be called in the FileMaker script.

Parameters:

value

The String representing the sensation. i.e an X, an O or an S.

index

The index in the grid were the String should be set.

Returns: an FMType that indicates the success of the method call if it completes.

LookoutAdvisor_SetShowGrid ( YesOrNo )

This function allows the user to show the grid in the Java app by passing in "Yes" or sets the grid to off by passing in "No".

Parameters:

yesOrNo

A "Yes" or "No", where "Yes" means that the grid should be displayed and "No" means the grid should not be displayed.

Returns: an FMType that indicates the success of the method call if it completes.

LookoutAdvisor_SetShowSurfaceDiagram ( YesOrNo )

This function allows the user to set the surface diagram in the Java app by passing in "Yes" or sets the Java app to show the skeletal diagram by passing in a "No"

Parameters:

yesOrNo

A "Yes" or a "No", where "Yes" means that the surface diagram should be displayed and "No" means the skeletal diagram should be displayed.

Returns: an FMType that indicates the success of the method call if it completes.