When writing code to work inside the User Interface Generator that comes with MDM Server and MIH it is necessary to use interfaces declared by the UIG framework. For instance all command beans need to implement the Command interface and work with data types in the com.ibm.usermodeling.attribute.types package. Unlike the interfaces and classes from core Java classes the Javadoc does not appear for these internal UIG classes when you hover over them in the Java editor although they are supplied as part of the Help Contents within RSA. The steps below outline how to make the Javadoc appear in the Java editor.
- Switch to the Java perspective and in the package explorer view expand the command bean project and then the EAR Libraries folder, right click on the com.ibm.uig.runtime.core.jar file and select properties:
- In the properties that pop up select "Javadoc Location" from the left hand side.
- Select the "Javadoc in archive" option
Assuming that you have used the default install location for RSA set the "Archive path" to:
The SDPShared directory is the one supplied to the RSA installation. Note that you may need to alter the date stamp or use browse to find the appropriate value.
- Set the "Path within archive" to "javadoc".
- Hit OK
The Javadoc for the interfaces and types declared in this Jar should now appear in your Java editor. You can repeat the process for other Jars supplied by UIG, for instance if you are writting new Widget Generators you may want to include the Javadoc for the com.ibm.uig.runtime.jsf.jar which is a Web App Library in the web project. The Javadoc for all of the Jar files is supplied within the same zip file.