Bug ID: JDK-4232597 stddoclet: Put current class (or package) name in window title, esp. with frames

Type: Enhancement
Component: tools
Sub-Component: javadoc(tool)
Affected Version: 1.2.0

Priority: P4
Status: Closed
Resolution: Fixed
OS: generic,solaris_2.6
CPU: generic,sparc

Submitted: 1999-04-23
Updated: 2014-05-05
Resolved: 2001-07-13

Other
1.4.0 beta2Fixed

Name: vi73552			Date: 04/23/99


Here's a very simple RFE that would make the JavaDocs output 
much more useful.

When I'm viewing a class, I've selected the package in the 
packages frame, and clicked on the actual class in the frame for
that package. I usually create many windows, one for each class.
I use the Task Bar (Windows) to navigate from one window to the
other.

It would be VERY useful if the class that I'm viewing appeared
in the title bar of the window. That would make it so much easier
to navigate through the different windows on my screen. I could
just roll the mouse over the task bar, looking at each class name
in the tool tip, then click on the class I'm looking for.

I don't know if HTML lets you do this, but it would make the 
javadoc output much easier to use.

(Review ID: 57366) 
======================================================================

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: merlin-beta2 FIXED IN: merlin-beta2 INTEGRATED IN: merlin-beta2 VERIFIED IN: merlin-rc1
14-06-2004
WORK AROUND Name: vi73552 Date: 04/23/99 View the class frame in a separate window. I don't like this workaround, because the two frames on the side are very useful. ======================================================================
11-06-2004
PUBLIC COMMENTS This RFE has been implemented. The given javascript now appears in front of the body tag and the name of the class/interface being viewed appears in the title bar. jamie.ho@Eng 2001-05-30
30-05-2001
SUGGESTED FIX This requires two changes to the standard doclet: 1) FRAMES OFF Shorten the name "Java 1.3 Platform Specification: Class Boolean" to "Boolean Class (Java 2 Platform SE v1.2)", with the class name first so it can be seen in the Windows toolbar. 2) FRAMES ON This works only in Internet Explorer, not Netscape. Incorporate Javascript to display the overview, package or class name in the window title, even if frames are displayed. Put the following after </HEAD> and down to <BODY>, where "xxxxx" is the word "Overview" or the package, class or interface name. <SCRIPT> function asd() { parent.document.title="xxxxx (Java 2 Platform SE v1.4)"; } </SCRIPT> <BODY onload="asd();"> <body onload=... onunload="theExit()"> To test it, look at this test file at: file:/java/pubs/tmp/jdk1.3/docs/api/index.html Open it in Internet Explorer, NOT Netscape, and click on "Test Window Name" at the top of the list in the lower left frame. In case that directory is gone, I've also attached test.html that would need to be put in a docs directory like jdk1.3/docs/api/java/applet and then a link would be made in allclasses-frame.html to open test.html. doug.kramer@Eng 2000-11-06
06-11-2000
EVALUATION The class name is in the title bar only if you have frames turned off. However, the class name is after "Java 2 Platform" and so is not visible in the Windows task bar. One consolation is that if you choose "No Frames" for a window and then hover the mouse pointer over the item in the task bar, you can see the class name. I suggest we shorten the name "Java 1.3 Platform Specification: Class Boolean" to "Boolean (Java 2 Platform SE v1.2)", with the class name first so it's easier to see. I wrote Greg Cameron and he sais there is indeed a way in Javascript to change the window title, but it works only in Internet Explorer, not in Netscape. Let's use this so the class (or package) name will show up even if frames are turned on. See "Suggested Fix". doug.kramer@Eng 1999-04-27 This RFE has been implemented. Location of implementation: HtmlWriter.java ClassWriter.java HtmlStandardWriter.java jamie.ho@Eng 2001-05-30
27-04-1999