All Classes

Introduction

This document lists changes made to the Java Source UI API .

Index of APIs

Java Source UI API

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

(Dec 26 '22) ElementOpen with suggested names
(Apr 11 '22) A variant conversion that works for both source and binary elements.
(Mar 9 '22) Added conversion from javac Elements to LSP structures.
(Mar 25 '21) Adding ElementOpen.getLocation(ClasspathInfo, ElementHandle, String)
(Oct 4 '16) Adding ElementOpen.open(FileObject toSearch, TreePathHandle toOpen)
(Oct 4 '16) Added a method to return an icon for module info directive
(Sep 20 '11) Added overload method for TypeElementFinder.find which allows to specify the prefilled initial text
(Feb 21 '11) Added asynchronous version of getText method into ElementJavadoc
(Jun 29 '10) Adding cancelable version of ElementJavadoc.create
(Jan 25 '08) Adding ElementOpen.open(ClasspathInfo info, ElementHandle h)
(Jul 18 '07) Added support for notifying user about running background scan.

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.modules.java.sourceui > 1.20

(1.67) ElementOpen with suggested names
(1.64) A variant conversion that works for both source and binary elements.
(1.63) Added conversion from javac Elements to LSP structures.
(1.45) Adding ElementOpen.getLocation(ClasspathInfo, ElementHandle, String)
(1.45) Adding ElementOpen.open(FileObject toSearch, TreePathHandle toOpen)
(1.45) Added a method to return an icon for module info directive
(1.24) Added overload method for TypeElementFinder.find which allows to specify the prefilled initial text
(1.20) Added asynchronous version of getText method into ElementJavadoc
(1.15) Adding cancelable version of ElementJavadoc.create
(1.15) Adding ElementOpen.open(ClasspathInfo info, ElementHandle h)
(1.2) Added support for notifying user about running background scan.

Changes by affected class

`org.netbeans.api.java.source.ui.ElementHeaders`

(Apr 11 '22) A variant conversion that works for both source and binary elements.
(Mar 9 '22) Added conversion from javac Elements to LSP structures.

`org.netbeans.api.java.source.ui.ElementIcons`

(Oct 4 '16) Added a method to return an icon for module info directive

`org.netbeans.api.java.source.ui.ElementJavadoc`

(Feb 21 '11) Added asynchronous version of getText method into ElementJavadoc

`org.netbeans.api.java.source.ui.ElementOpen`

(Dec 26 '22) ElementOpen with suggested names

`org.netbeans.api.java.source.ui.ScanDialog`

(Jul 18 '07) Added support for notifying user about running background scan.

`org.netbeans.api.java.source.ui.TypeElementFinder`

(Sep 20 '11) Added overload method for TypeElementFinder.find which allows to specify the prefilled initial text

Details of all changes by API and date

Java Source UI API

ElementOpen with suggested names

Dec 26 '22; API spec. version: 1.67; affected top-level classes: ElementOpen; made by: jtulach
Provide ElementOpen.open with suggested list of file names to open. Allows extracting name from .class file and opening that one.

A variant conversion that works for both source and binary elements.

Apr 11 '22; API spec. version: 1.64; affected top-level classes: ElementHeaders; made by: sdedic
Binary-only javac Elements can be converted to StructureElement, avoids fetching the source.

Added conversion from javac Elements to LSP structures.

Mar 9 '22; API spec. version: 1.63; affected top-level classes: ElementHeaders; made by: sdedic
Utility methods for conversion of javac-specific Elements to abstracted StructureElements defined by the LSP protocol.

Adding ElementOpen.getLocation(ClasspathInfo, ElementHandle, String)

Mar 25 '21; API spec. version: 1.45; made by: dbalek
Adding ElementOpen.getLocation(ClasspathInfo, ElementHandle, String) method.
Compatibility:

Adding ElementOpen.open(FileObject toSearch, TreePathHandle toOpen)

Oct 4 '16; API spec. version: 1.45; made by: tzezula
Adding ElementOpen.open(FileObject toSearch, TreePathHandle toOpen) method.
Compatibility:

Added a method to return an icon for module info directive

Oct 4 '16; API spec. version: 1.45; affected top-level classes: ElementIcons; made by: tzezula
Added thegetModuleDirectiveIcon method into the ElementIcons to return an icon for a module info directive.

Added overload method for TypeElementFinder.find which allows to specify the prefilled initial text

Sep 20 '11; API spec. version: 1.24; affected top-level classes: TypeElementFinder; made by: jlahoda; issues: #125811
Added overload method for TypeElementFinder.find which allows to specify the prefilled initial text.

Added asynchronous version of getText method into ElementJavadoc

Feb 21 '11; API spec. version: 1.20; affected top-level classes: ElementJavadoc; made by: tzezula; issues: #194969
Added asynchronous version of getText into ElementJavadoc. The getTextAsync returns a Future which blocks until the javadoc is downloaded.

Adding cancelable version of ElementJavadoc.create

Jun 29 '10; API spec. version: 1.15; made by: tzezula; issues: #171183
Added a cancelable version of ElementJavadoc.create to allow code completion to cancel slow call to JavadocForBinaryQuery.
Compatibility:

Adding ElementOpen.open(ClasspathInfo info, ElementHandle h)

Jan 25 '08; API spec. version: 1.15; made by: jlahoda; issues: #125320
Adding ElementOpen.open(ClasspathInfo info, ElementHandle h) method.
Compatibility:

Added support for notifying user about running background scan.

Jul 18 '07; API spec. version: 1.2; affected top-level classes: ScanDialog; made by: tzezula; issues: #110136
Added support for notifying user about running background scan. When the background scan is running the support displays a dialog notifying user about it. When the background scan finishes the dialog is closed and the action is executed.
Compatibility: