[NETBEANS-713] HighlightingManager does not track changes to HighlightsLayerExcludes correctly

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 8.2, 9.0
• Fix Version/s: 10.0
• Labels: pull-request-available
• External issue URL: https://netbeans.org/bugzilla/show_bug.cgi?id=248664
• Assignee: Emilian Bold
• Reporter: Eirik Bakke
• Created: 22/Apr/18 19:26
• Updated: 03/Nov/19 20:09
• Resolved: 14/May/18 06:41

Description

The editor API defines the JEditorPane client properties HighlightsLayerExcludes and HighlightsLayerIncludes to allow clients to show/hide specific highlight layers on demand. The bug is that modifications to these properties are not reflected properly in the editor.

The use case here is for a NetBeans Platform application that needs to modify the client properties depending on user action (e.g. keyboard focus state).

The bug seems to be in o.n.modules.editor.lib2.highlighting.HighlightingManager.Highlighting. In the constructor, the paneFilter variable is initialized once from the HighlightsLayerExcludes/HighlightsLayerIncludes client properties, right above where the propertyChangeListener that is supposed to track changes to it is added. The PropertyChangeListener reacts to changes to the client properties by calling rebuildAllLayers(), which calls rebuildAllLayersImpl(), which always just uses the value of paneFilter set in the constructor.

Originally reported as Bugzilla bug 248664. Adding this as a JIRA issue to associate with a pull request that I'm about to open.

Issue Links

• links to: GitHub Pull Request #514