RE: drawSystemFocusRing and drawCustomFocusRing names are confusing.

Just to get other ideas out there, Dominic mentioned notifyFocus() as a potential name? notifyFocusRegion may be a bit more clear. The API is notifying the path that should be focused to the accessibility tools and user agent. Drawing may be a side effect of the UA being informed of the path.


From: Richard Schwerdtfeger [mailto:schwer@us.ibm.com]
Sent: Thursday, January 9, 2014 2:30 PM
To: Rik Cabanier
Cc: Rik Cabanier (cabanier@adobe.com); Dominic Mazzoni; Jay Munro; Jatinder Mann; Philippe Le Hegaret (plh@w3.org); Canvas; Robert O'Callahan; Alexander Surkov
Subject: Re: drawSystemFocusRing and drawCustomFocusRing names are confusing.


I am open to suggestions.


Rich Schwerdtfeger

[Inactive hide details for Rik Cabanier ---01/09/2014 04:10:44 PM---On Thu, Jan 9, 2014 at 1:56 PM, Richard Schwerdtfeger <schwe]Rik Cabanier ---01/09/2014 04:10:44 PM---On Thu, Jan 9, 2014 at 1:56 PM, Richard Schwerdtfeger <schwer@us.ibm.com<mailto:schwer@us.ibm.com>>wrote: > DrawCustomFocusRin

From: Rik Cabanier <cabanier@gmail.com<mailto:cabanier@gmail.com>>
To: Richard Schwerdtfeger/Austin/IBM@IBMUS
Cc: "Rik Cabanier (cabanier@adobe.com<mailto:cabanier@adobe.com>)" <cabanier@adobe.com<mailto:cabanier@adobe.com>>, Dominic Mazzoni <dmazzoni@google.com<mailto:dmazzoni@google.com>>, Jay Munro <jaymunro@microsoft.com<mailto:jaymunro@microsoft.com>>, Jatinder Mann <jmann@microsoft.com<mailto:jmann@microsoft.com>>, "Philippe Le Hegaret (plh@w3.org<mailto:plh@w3.org>)" <plh@w3.org<mailto:plh@w3.org>>, Canvas <public-canvas-api@w3.org<mailto:public-canvas-api@w3.org>>, "Robert O'Callahan" <robert@ocallahan.org<mailto:robert@ocallahan.org>>, Alexander Surkov <surkov.alexander@gmail.com<mailto:surkov.alexander@gmail.com>>
Date: 01/09/2014 04:10 PM
Subject: Re: drawSystemFocusRing and drawCustomFocusRing names are confusing.

________________________________






On Thu, Jan 9, 2014 at 1:56 PM, Richard Schwerdtfeger <schwer@us.ibm.com<mailto:schwer@us.ibm.com>> wrote:
DrawCustomFocusRing was move to L2 and part of that is for this reason. We agree the name needs help.

The probem with if Needed is that one could assume that it is not needed. The function serves two purposes:

- sets the location
- draws focus based on the location if it has focus

That name should reflect that if possible if we are going to change the name.

drawApplicableFocus


I'm unsure if 'Applicable' is any clearer than 'IfNeeded'. They sound the same to me except 'Applicable' would be confusing for non-native speakers.



Rich Schwerdtfeger

[Inactive hide details for Rik Cabanier ---01/09/2014 03:13:19 PM---On Thu, Jan 9, 2014 at 1:02 PM, Robert O'Callahan <robert@oc]Rik Cabanier ---01/09/2014 03:13:19 PM---On Thu, Jan 9, 2014 at 1:02 PM, Robert O'Callahan <robert@ocallahan.org<mailto:robert@ocallahan.org>>wrote: > I agree with jatind

From: Rik Cabanier <cabanier@gmail.com<mailto:cabanier@gmail.com>>
To: "Robert O'Callahan" <robert@ocallahan.org<mailto:robert@ocallahan.org>>
Cc: Jay Munro <jaymunro@microsoft.com<mailto:jaymunro@microsoft.com>>, Richard Schwerdtfeger/Austin/IBM@IBMUS, Alexander Surkov <surkov.alexander@gmail.com<mailto:surkov.alexander@gmail.com>>, "Rik Cabanier (cabanier@adobe.com<mailto:cabanier@adobe.com>)" <cabanier@adobe.com<mailto:cabanier@adobe.com>>, Dominic Mazzoni <dmazzoni@google.com<mailto:dmazzoni@google.com>>, Jatinder Mann <jmann@microsoft.com<mailto:jmann@microsoft.com>>, "Philippe Le Hegaret (plh@w3.org<mailto:plh@w3.org>)" <plh@w3.org<mailto:plh@w3.org>>, Canvas <public-canvas-api@w3.org<mailto:public-canvas-api@w3.org>>
Date: 01/09/2014 03:13 PM

Subject: Re: drawSystemFocusRing and drawCustomFocusRing names are confusing.

________________________________






On Thu, Jan 9, 2014 at 1:02 PM, Robert O'Callahan <robert@ocallahan.org<mailto:robert@ocallahan.org>> wrote:
I agree with jatinder. "drawFocus" suggests that it will always draw something, but that's wrong. The name "drawCustomFocusRing" is even worse since it never draws anything.

I think for the method that actually draws, "drawFocusIfNeeded" would be good.

For the other method, "needToDrawFocus" sounds good for the non-accessibility functionality. However, if the name ignores the accessibility side effects, we can expect authors to not set the correct path, since a path is not obviously needed. So I suggest we remove the version of the method that uses the current path, forcing authors to provide a Path parameter, and explain in prose what the Path parameter is for. Of course that would mean making this functionality depend on Path, but I think that's OK. This functionality seems less important than drawFocusIfNeeded. There is the possibility that authors will just supply a bogus Path anyway because they don't care about accessibility, but that's possible with any form of this API.

That sounds fine.
Let's rename 'drawSystemFocusRing' to 'drawFocusIfNeeded'.
'needToDrawFocus' can move to the l2 version of the spec.