Quick Tip: Creating type ahead help in your Java Classes

Glen Urban  December 23 2012 11:08:28 AM

Want to create type ahead help like this?...



You need to add comments to your code like this...



Things to remember

• You start the comments with /** and end with */
• Comments should appear immediately before the Class or Method you are documenting.
• You can link to the comments in other classes or methods by using the tag @link e.g. {@link makeUnFriendlyNoise} in the screen print above.
• There are various tags you can use e.g. @author, @param and @return, see here for more.
• Comments are HTML so you can include p li tags etc.

• Comments [2]

Making enableModifiedFlag Work Across Tabs in a Tabbed Panel

Glen Urban  February 16 2012 11:58:53 AM

Problem
Setting the enableModifedFlag on an XPage...



will warn the user if they try to navigate away from the XPage without saving data.

However in a Tabbed Panel this doesn't always work. For example:

1) Update some data on the first tab (your page is now dirty)
2) Move to the second tab but don't update any data on that tab
3) Navigate away from the page
4) The page is dirty but the Confirm Navigation prompt doesn't show

Solution
For version 8.5.3 then simply set partialRefesh for the Tabbed Panel to true



For version 8.5.2 (or earlier?). Partial Refresh on a Tabbed Panel was introduced in 8.5.3 so the work around is...

For each Tab in your Tabbed Panel add the following Server Side JavaScript to the onclick event

You need to change mainTabbedPanel to the ID of your Tabbed Panel and tab1 to the ID of the current tab.


Use a Partial Update and select a div that wraps around theTabbed Panel as the target.

• Comments [1]

Notes Doclinks going to the wrong server?

Glen Urban  May 19 2011 02:02:02 PM

When you generate emails with doclinks are users complaining it takes them to a server on the other side of the world? If so, take a look at the Catalog on the server specified as the "Catalog/domain search server" in your Location Document. Look at the "Applications by Title" view. Are there multiple servers listed for the application (database) where the doclinks came from? This could be a problem...

What Should Happen With DocLinks?
This technote from IBM lists the steps Notes takes to determine which server to use:

1) Use the icon for the replica on the user's workspace if one exists.
Assuming the user hasn't opened the application before then they won't have an icon on their workspace so the search goes to step 2.

2) If using Catalog/Domain Search, this will be used to locate* a replica.
This is further qualified by the statement: The search will open the catalog and find the "best" server choice containing a replica, searching by server name alphabetically. The best choice considers server availability.

A Potential Problem
When the search gets to step 2 you may be using, for example, server "USA1" but if the first server under your application in the "Applications by Title" view is called "AUSTRALIA1" then the doclink will be opened on AUSTRALIA1. I've also seen this cause embedded views to open on the wrong server and @DBlookups, where the database was specified using a replica ID, to lookup to the wrong server.

What about the statement The best choice considers server availability ? The technote doesn't elaborate on how Notes evaluates "availability". I suspect it chooses the first server in the same Notes Network. In the organisations that I've come across this problem all the servers we're in the same Notes Network (which is probably not recommended).

How Can I Fix It?
I resolved this by re-configuring the catalog to show only applications that have replicas on that server. For example, on server USA1 the catalog would only list replicas found on USA1. So when the Notes client looks for the location of an application in the catalog (step 2 above) it will always return a replica on USA1. In a typical Hub and Spoke topology this can be achieved using the ACL of the catalog. On the spoke servers, e.g. USA1, I ensured the Hub server is restricted to reader access and USA1 had manager access. This prevented the Hub server from adding entries to USA1's catalog but allowed it to read them and compile a full list of all applications, and their servers, on the Hub.

This solution resolved the issue for new users, or existing users opening applications they hadn't used before. But it didn't resolve the problem where users already had icons on their workspace that point to the wrong server. In this instance you can write code to re-stack the workspace icons, for example, something like this from Tommy Valand.

A Word of Warning About Testing
If you delete all the workspace icons for an application and then change the catalog server specified in your Location Document then you may think that Notes should start looking in the new catalog. But it doesn't! Even if you delete desktop8.ndk and bookmark.nsf Notes will still remember where it's been before. If you look at the document properties for your Location Document then you'll find several fields that are used for caching e.g. $LastFileNames and $StackFileNames. There's all sorts of caching going on in there. So it's best to delete desktop8.ndk, bookmark.nsf and create a new Location Document. This does make testing a pain!

• Comments [3]

XSP.isViewPanelRowSelected: How to confirm if documents are selected in your XPage view control

Glen Urban  May 16 2011 11:47:45 AM

How do you make your XPage buttons work like the standard "Simple Action" Delete button and prompt you if you haven't selected any documents?

If you look at the HTML source of an XPage with a delete button you will see a call to XSP.isViewPanelRowSelected. This accepts two parameters, the first being the name of your view control. If you don't change the default this will be "viewPanel1". The second parameter, I believe, is referring to the actual tick boxes in the view control. So far I haven't needed to change this from "_colcbox".

So here's an example for an "Approve" button...


Any server side JavaScript won't get executed unless there a documents selected and you have confirmed you wish to continue.

You can find out more about the XSP JavaScript Library here

• Comments [0]

XPage: Unresolved compilation problem: The code for the static initializer is exceeding the 65535 bytes limit

Glen Urban  February 3 2011 02:27:18 PM

When adding an XPage front-end to an existing Notes client application I came across the following error message previewing the XPage:

"Unresolved compilation problem: The code for the static initializer is exceeding the 65535 bytes limit".

The original Notes form had lots of fields on. My new XPage worked at first but I hit the error as I added more fields. It looks as though I hit a Java limitation. Splitting the XPage fields onto separate Custom Controls resolved the problem.

• Comments [2]

Shared Actions Not Replicating?

Glen Urban  February 3 2011 02:02:11 PM

I came across a strange problem where modifications to existing Shared Actions, and new Shared Actions, did not replicate from local replica to server, or from server to server. After a lot of head scratching a view of design elements helped me track down the problem. Kevin Petit first made me aware of how to create such a view on his blog here.

All the Shared Actions in a database are stored in one Note. But if you look at the screen print of the design elements view below you can see two "Notes" (documents) for Shared Actions. Some how a replication or save conflict had occurred. Notes seemed to pick at random which set of Shared Actions to use in separate databases.

Deleting one of the Shared Action documents resolved the problem.

• Comments [1]

IsArrayInitialised()

Glen Urban  August 4 2010 11:56:42 AM

Surprisingly LotusScript doesn't provide this but here's a function to test if a dynamic array is initialised.

Function IsArrayInitialised(a As Variant) As Boolean
 'returns True if an array is initialised
  On Error Resume Next
  IsArrayInitialised = False
  IsArrayInitialised = (Ubound(a) >= Lbound(a)) ' will generate error if not initialised    
End Function

• Comments [1]

NotesDatabase.Server Inconsistency

Glen Urban  April 13 2010 02:42:32 PM

Consider the following LotusScript code

Dim session As New NotesSession
Print session.CurrentDatabase.Server

Would you expect the server name to be in an Abbreviated (e.g. SERVER/GB/ACME) or Canonical format (e.g.CN=SERVER/OU=GB/O¬ME )?

The answer is "it could be either": I experienced a problem in some code that depended upon this property, on one Notes client it evaluated to an Abbreviated name and on another to a Canonical name. Both clients were 8.5.1. Both running on the same server. The only obvious difference was that the designer client was installed on one client machine but not the other.

I resolved the problem by forcing a conversion to a canonical format so that the code worked regardless of how database.server decided to return the name.

Has anyone else experienced this problem?

• Comments [0]

notesUIWorkspace.RepaintScreen()

Glen Urban  March 11 2010 03:21:34 PM

Ever wished you had a method to repaint the screen?

Recently I was working on some automation with Microsoft Word and wanted to display a message to the user warning them that the processing may take a while. I used a hide-when formula to display a message on my form but I found that the screen did not repaint correctly. Some controls on the form that should have been hidden were still displayed.

As far as I know there is no way in LotusScript to repaint the screen. To resolve this we can make a call to Windows to do the refresh for us.

Declare Function GetActiveWindow Lib "user32" Alias "GetActiveWindow" () As Integer
Declare Function UpdateWindow Lib "user32" (Byval hWnd As Integer) As Integer

Sub RepaintScreen

On Error Resume Next
Call UpdateWindow(GetActiveWindow())

End Sub

• Comments [0]

Dynamically Hide/Display Rich Text Fields

Glen Urban  January 9 2010 02:34:09 PM

Many Notes developers are aware of the problems with using Hide When formula on Notes Rich Text fields. It can have unpredictable results on the contents of the field, these are detailed in an IBM Technote here. In that note two solutions are proposed 1) use a computed Subform and 2) use a Controlled Access Section.  But these solutions are not without their problems.

On reading this blog entry it suddenly occurred to me that using a Layer could offer a better solution.

1) Create a Layer and place the Rich Text Field on that layer.
2) When you create a layer you will see that it has a Layer Anchor. You can set a Hide When formula on this anchor.

The advantages of this approach are:

1) The Hide When is not on the Rich Text Field so no unpredictable results
2) You can hide/show the Layer/Field dynamically. In the screen shot below I have used a Radio Button that can show/hide the Rich Text field.

• Comments [6]