public final class BuildPathDialogAccess extends Object
This class is not intended to be instantiated or subclassed by clients.
Modifier and Type | Method and Description |
---|---|
static IPath[] |
chooseClassFolderEntries(Shell shell,
IPath initialSelection,
IPath[] usedEntries)
Shows the UI to select new class folders.
|
static IClasspathEntry[] |
chooseContainerEntries(Shell shell,
IJavaProject project,
IClasspathEntry[] currentClasspath)
Shows the UI to choose new classpath container classpath entries.
|
static IPath[] |
chooseExternalClassFolderEntries(Shell shell)
Shows the UI to select new external class folder entries.
|
static IPath[] |
chooseExternalJAREntries(Shell shell)
Shows the UI to select new external JAR or ZIP archive entries.
|
static IPath[] |
chooseJAREntries(Shell shell,
IPath initialSelection,
IPath[] usedEntries)
Shows the UI to select new JAR or ZIP archive entries located in the workspace.
|
static IPath[] |
chooseSourceFolderEntries(Shell shell,
IPath initialSelection,
IPath[] usedEntries)
Shows the UI to select new source folders.
|
static IPath[] |
chooseVariableEntries(Shell shell,
IPath[] existingPaths)
Shows the UI for selecting new variable classpath entries.
|
static IClasspathEntry |
configureContainerEntry(Shell shell,
IClasspathEntry initialEntry,
IJavaProject project,
IClasspathEntry[] currentClasspath)
Shows the UI to configure a classpath container classpath entry.
|
static IPath |
configureExternalAnnotationsAttachment(Shell shell,
IPath initialEntry)
Shows the UI for configuring an external annotations attachment.
|
static IPath |
configureExternalClassFolderEntries(Shell shell,
IPath initialEntry)
Shows the UI to configure an external class folder.
|
static IPath |
configureExternalJAREntry(Shell shell,
IPath initialEntry)
Shows the UI to configure an external JAR or ZIP archive.
|
static IPath |
configureJAREntry(Shell shell,
IPath initialEntry,
IPath[] usedEntries)
Shows the UI to configure a JAR or ZIP archive located in the workspace.
|
static IClasspathEntry |
configureJavadocLocation(Shell shell,
IClasspathEntry initialEntry)
Shows the UI for configuring a javadoc location attribute of the classpath entry.
|
static URL[] |
configureJavadocLocation(Shell shell,
String libraryName,
URL initialURL)
Shows the UI for configuring a javadoc location.
|
static IClasspathEntry |
configureSourceAttachment(Shell shell,
IClasspathEntry initialEntry)
Shows the UI for configuring source attachments, with editing of source attachment encoding
disabled.
|
static IClasspathEntry |
configureSourceAttachment(Shell shell,
IClasspathEntry initialEntry,
boolean canEditEncoding)
Shows the UI for configuring source attachments.
|
static IPath |
configureVariableEntry(Shell shell,
IPath initialEntryPath,
IPath[] existingPaths)
Shows the UI for configuring a variable classpath entry.
|
public static IClasspathEntry configureSourceAttachment(Shell shell, IClasspathEntry initialEntry)
null
is returned if the user cancels the dialog. The dialog does not
apply any changes.shell
- The parent shell for the dialoginitialEntry
- The entry to edit. The kind of the classpath entry must be either
IClasspathEntry.CPE_LIBRARY
or
IClasspathEntry.CPE_VARIABLE
.null
if the dialog has been canceled. The resulting
entry can be used to replace the original entry on the classpath. Note that the
dialog does not make any changes on the passed entry nor on the classpath that
contains it.public static IClasspathEntry configureSourceAttachment(Shell shell, IClasspathEntry initialEntry, boolean canEditEncoding)
canEditEncoding
. null
is returned if the
user cancels the dialog. The dialog does not apply any changes.shell
- The parent shell for the dialoginitialEntry
- The entry to edit. The kind of the classpath entry must be either
IClasspathEntry.CPE_LIBRARY
or
IClasspathEntry.CPE_VARIABLE
.canEditEncoding
- whether the source attachment encoding can be editednull
if the dialog has been canceled. The resulting
entry can be used to replace the original entry on the classpath. Note that the
dialog does not make any changes on the passed entry nor on the classpath that
contains it.public static IPath configureExternalAnnotationsAttachment(Shell shell, IPath initialEntry)
null
is
returned when the user cancels the dialog. The dialog does not apply any changes.shell
- The parent shell for the dialoginitialEntry
- The entry to edit.null
if the dialog has been cancelled.public static URL[] configureJavadocLocation(Shell shell, String libraryName, URL initialURL)
null
is returned
if the user cancels the dialog. If OK is pressed, an array of length 1 containing the configured URL is
returned. Note that the configured URL can be null
when the user
wishes to have no URL location specified. The dialog does not apply any changes.
Use JavaUI
to access and configure
Javadoc locations.shell
- The parent shell for the dialog.libraryName
- Name of of the library to which configured javadoc location belongs.initialURL
- The initial URL or null
.null
if the dialog has been canceled. Note that the configured URL can be null
when the user
wishes to have no URL location specified.public static IClasspathEntry configureJavadocLocation(Shell shell, IClasspathEntry initialEntry)
null
is returned
if the user cancels the dialog. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntry
- The entry to edit. The kind of the classpath entry must be either
IClasspathEntry.CPE_LIBRARY
or IClasspathEntry.CPE_VARIABLE
.null
if the dialog has been canceled.
The resulting entry can be used to replace the original entry on the classpath.
Note that the dialog does not make any changes on the passed entry nor on the classpath that
contains it.public static IPath configureVariableEntry(Shell shell, IPath initialEntryPath, IPath[] existingPaths)
IClasspathEntry.CPE_VARIABLE
for
details about variable classpath entries.
The dialog returns the configured classpath entry path or null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntryPath
- The initial variable classpath variable path or null
to use
an empty path.existingPaths
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled.public static IPath[] chooseVariableEntries(Shell shell, IPath[] existingPaths)
IClasspathEntry.CPE_VARIABLE
for
details about variable classpath entries.
The dialog returns an array of the selected variable entries or null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.existingPaths
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled.public static IClasspathEntry configureContainerEntry(Shell shell, IClasspathEntry initialEntry, IJavaProject project, IClasspathEntry[] currentClasspath)
IClasspathEntry.CPE_CONTAINER
for
details about container classpath entries.
The dialog returns the configured classpath entry or null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntry
- The initial classpath container entry.project
- The project the entry belongs to. The project does not have to exist and can also be null
.currentClasspath
- The class path entries currently selected to be set as the projects classpath. This can also
include the entry to be edited. The dialog uses these entries as information only (e.g. to avoid duplicate entries); The user still can make changes after the
the classpath container dialog has been closed. See IClasspathContainerPageExtension
for
more information.null
if the dialog has
been canceled by the user.public static IClasspathEntry[] chooseContainerEntries(Shell shell, IJavaProject project, IClasspathEntry[] currentClasspath)
IClasspathEntry.CPE_CONTAINER
for
details about container classpath entries.
The dialog returns the selected classpath entries or null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.project
- The project the entry belongs to. The project does not have to exist and
can also be null
.currentClasspath
- The class path entries currently selected to be set as the projects classpath. This can also
include the entry to be edited. The dialog uses these entries as information only; The user still can make changes after the
the classpath container dialog has been closed. See IClasspathContainerPageExtension
for
more information.null
if the dialog has
been canceled by the user.public static IPath configureJAREntry(Shell shell, IPath initialEntry, IPath[] usedEntries)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntry
- The path of the initial archive entryusedEntries
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled by the user.public static IPath[] chooseJAREntries(Shell shell, IPath initialSelection, IPath[] usedEntries)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialSelection
- The path of the element (container or archive) to initially select or null
to not select an entry.usedEntries
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled by the user.public static IPath configureExternalJAREntry(Shell shell, IPath initialEntry)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntry
- The path of the initial archive entry.null
if the dialog has
been canceled by the user.public static IPath[] chooseExternalJAREntries(Shell shell)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.null
if the dialog has
been canceled by the user.public static IPath[] chooseExternalClassFolderEntries(Shell shell)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.null
if the dialog has
been canceled by the user.public static IPath configureExternalClassFolderEntries(Shell shell, IPath initialEntry)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialEntry
- The path of the initial archive entry.null
if the dialog has
been canceled by the user.public static IPath[] chooseClassFolderEntries(Shell shell, IPath initialSelection, IPath[] usedEntries)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialSelection
- The path of the element to initially select or null
.usedEntries
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled by the user.public static IPath[] chooseSourceFolderEntries(Shell shell, IPath initialSelection, IPath[] usedEntries)
null
if the dialog has
been canceled. The dialog does not apply any changes.shell
- The parent shell for the dialog.initialSelection
- The path of the element to initially select or null
usedEntries
- An array of paths that are already on the classpath and therefore should not be
selected again.null
if the dialog has
been canceled by the user.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.