Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 328502

Summary:

[Help] Jaws does not give enough context info when in Help pane

Product:

[Eclipse Project] Platform

Reporter:

Jamie Liu <liuj1>

Component:

User Assistance

Assignee:

Chris Goldthorpe <cgold>

Status:

RESOLVED FIXED

QA Contact:

Severity:

normal

Priority:

CC:

cgold, Mike_Wilson

Version:

3.6.2

Keywords:

accessibility

Target Milestone:

3.7 M4

Hardware:

OS:

Windows XP

Whiteboard:

Bug Depends on:

Bug Blocks:

329494

Attachments:

Description	Flags
Patch version 1	none

Description Jamie Liu

2010-10-22 15:03:47 EDT

Build Identifier: M20100211-1343

When focus is in the help pane, Jaws immediately starts reading the text in the "About" section, without providing indication about where the user is within the help pane (ie. "Related Topics" title is not announced).  This is more prominent with the older UI, where there are two sections, but is also an issue with the current UI.

Our accessibility team finds that this makes us Section 508 blocking:
Fails checkpoint 2.2 - Provide semantic information about user interface objects.
Fails checkpoint 4.1 - Provide text through standard system function calls or through an API (application programming interface) which supports interaction with assistive technology.


Reproducible: Always

Steps to Reproduce:
1. Launch Eclipse
2. Launch Jaws
3. Press F1 when focus is in Eclipse (ie. in Java Editor).  If the help pane is already open, you can also use Ctrl+F7 to bring focus to the help pane.  
4. Listen to Jaws start reading text in pane, while skipping over section titles.

Comment 1 Chris Goldthorpe

2010-10-26 13:12:07 EDT

Do you have a suggestion on how to fix this? Is there a way of os making more information available to Jaws so that it can make the correct announcements?

Comment 2 Jamie Liu

2010-10-27 12:59:00 EDT

Hi Chris,
Adding this Accessible listener in the ContextHelpPart constructor will add the section header before the contents:

text.setText(defaultText, false, false);
text.getAccessible().addAccessibleListener(new AccessibleAdapter() {
	public void getName(AccessibleEvent e) {
		e.result = getSection().getText()+defaultText;
	}
});

Was not sure how to best retrieve the page name (ie. "Related Topics").  Could you take a look?

Thanks,
Jamie

Comment 3 Jamie Liu

2010-10-27 13:14:59 EDT

Sorry, spoke too soon.  This overrides existing handling of links in the form.  We'd need to leverage the existing FormText widget's handling of the text set in getName(), rather than the simple "defaultText" that I specified.

Comment 4 Jamie Liu

2010-10-27 13:25:56 EDT

Okay, this seems to get the desired effect:
text.getAccessible().addAccessibleListener(new AccessibleAdapter() {
	public void getName(AccessibleEvent e) {
		if (e.childID == ACC.CHILDID_SELF) {
			String currentName = e.result;
			e.result = getSection().getText()+currentName;	
		}
	}
});

If you could give pointers on how to retrieve the page name, I think we can patch this.  Also, please let me know if you can think of a better way to handle this issue.  Thanks.

Comment 5 Chris Goldthorpe

2010-10-27 14:53:32 EDT

That code sequence did enable the "About ..." line to get read. When I pressed F1 which in the package explorer Jaws read the following text:

About Package Explorer
This view displays the workspace's Java projects and lets you explore their contents.
See also:
Browsing Java elements

Are you looking for Jaws to also announce 

"Related Topics" before reading the other lines?

Comment 6 Jamie Liu

2010-10-27 15:00:26 EDT

Yes, exactly.  By "page name" I meant the "Related Topics" header.

Comment 7 Chris Goldthorpe

2010-10-27 16:26:26 EDT

Created attachment 181880 [details]
Patch version 1

Can you try the attached patch out? This will add "Related Topics" and the "About" section to the the text that Jaws reads.

Comment 8 Jamie Liu

2010-10-28 10:39:49 EDT

Hi Chris, thanks for taking a look.  The patch works well for us.

Comment 9 Chris Goldthorpe

2010-11-01 12:42:43 EDT

Patch committed to HEAD, Fixed. Is this fix needed in 3.6.2 also?

Comment 10 Jamie Liu

2010-11-03 14:34:09 EDT

Hi Chris, no, this won't need to be backported -- turns out we are only upgrading SWT to 3.6.2, so we will need to manually patch this fix for the immediate release.