blob: 814d9ec52a26873329531a33c73953679f4d647b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:16:04 CDT 2008 -->
<TITLE>
BuildPathDialogAccess
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.ui.wizards.BuildPathDialogAccess class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="BuildPathDialogAccess";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BuildPathDialogAccess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BaseLibraryWizardPage.html" title="class in org.eclipse.wst.jsdt.ui.wizards"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/ClasspathAttributeConfiguration.html" title="class in org.eclipse.wst.jsdt.ui.wizards"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="BuildPathDialogAccess.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.wst.jsdt.ui.wizards</FONT>
<BR>
Class BuildPathDialogAccess</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.ui.wizards.BuildPathDialogAccess</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>BuildPathDialogAccess</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Class that gives access to dialogs used by the JavaScript build path page to configure classpath entries
and properties of classpath entries.
Static methods are provided to show dialogs for:
<ul>
<li> configuration of source attachments</li>
<li> configuration of Javadoc locations</li>
<li> configuration and selection of classpath variable entries</li>
<li> configuration and selection of classpath container entries</li>
<li> configuration and selection of JAR and external JAR entries</li>
<li> selection of class and source folders</li>
</ul>
<p>
This class is not intended to be instantiated or subclassed by clients.
</p>
Provisional API: This class/interface is part of an interim API that is still under development and expected to
change significantly before reaching stability. It is being made available at this early stage to solicit feedback
from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
(repeatedly) as the API evolves.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseClassFolderEntries(Shell, IPath, IPath[])">chooseClassFolderEntries</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to select new class folders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseContainerEntries(Shell, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IIncludePathEntry[])">chooseContainerEntries</A></B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]&nbsp;currentClasspath)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to choose new classpath container classpath entries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseExternalJAREntries(Shell)">chooseExternalJAREntries</A></B>(Shell&nbsp;shell)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to select new external JAR or ZIP archive entries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseJAREntries(Shell, IPath, IPath[])">chooseJAREntries</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to select new JAR or ZIP archive entries located in the workspace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseSourceFolderEntries(Shell, IPath, IPath[])">chooseSourceFolderEntries</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to select new source folders.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseSuperType(Shell, org.eclipse.wst.jsdt.internal.ui.wizards.buildpaths.CPListElement[], org.eclipse.wst.jsdt.core.LibrarySuperType, org.eclipse.wst.jsdt.core.IJavaScriptProject)">chooseSuperType</A></B>(Shell&nbsp;shell,
org.eclipse.wst.jsdt.internal.ui.wizards.buildpaths.CPListElement[]&nbsp;cpEntries,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A>&nbsp;initialSelection,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#chooseVariableEntries(Shell, IPath[])">chooseVariableEntries</A></B>(Shell&nbsp;shell,
IPath[]&nbsp;existingPaths)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI for selecting new variable classpath entries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureContainerEntry(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IIncludePathEntry[])">configureContainerEntry</A></B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]&nbsp;currentClasspath)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to configure a classpath container classpath entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureExternalJAREntry(Shell, IPath)">configureExternalJAREntry</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialEntry)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to configure an external JAR or ZIP archive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureJAREntry(Shell, IPath, IPath[])">configureJAREntry</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialEntry,
IPath[]&nbsp;usedEntries)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI to configure a JAR or ZIP archive located in the workspace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureJavadocLocation(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry)">configureJavadocLocation</A></B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI for configuring a javadoc location attribute of the classpath entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.net.URL[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureJavadocLocation(Shell, java.lang.String, java.net.URL)">configureJavadocLocation</A></B>(Shell&nbsp;shell,
java.lang.String&nbsp;libraryName,
java.net.URL&nbsp;initialURL)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI for configuring a javadoc location.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureSourceAttachment(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry)">configureSourceAttachment</A></B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI for configuring source attachments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;IPath</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html#configureVariableEntry(Shell, IPath, IPath[])">configureVariableEntry</A></B>(Shell&nbsp;shell,
IPath&nbsp;initialEntryPath,
IPath[]&nbsp;existingPaths)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shows the UI for configuring a variable classpath entry.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="configureSourceAttachment(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry)"><!-- --></A><H3>
configureSourceAttachment</H3>
<PRE>
public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> <B>configureSourceAttachment</B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry)</PRE>
<DL>
<DD>Shows the UI for configuring source attachments. <code>null</code> is returned
if the user cancels the dialog. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog<DD><CODE>initialEntry</CODE> - The entry to edit. The kind of the classpath entry must be either
<code>IIncludePathEntry.CPE_LIBRARY</code> or <code>IIncludePathEntry.CPE_VARIABLE</code>.
<DT><B>Returns:</B><DD>Returns the resulting classpath entry containing a potentially modified source attachment path and
source attachment root. 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.</DL>
</DD>
</DL>
<HR>
<A NAME="configureJavadocLocation(Shell, java.lang.String, java.net.URL)"><!-- --></A><H3>
configureJavadocLocation</H3>
<PRE>
public static java.net.URL[] <B>configureJavadocLocation</B>(Shell&nbsp;shell,
java.lang.String&nbsp;libraryName,
java.net.URL&nbsp;initialURL)</PRE>
<DL>
<DD>Shows the UI for configuring a javadoc location. <code>null</code> 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 <code>null</code> when the user
wishes to have no URL location specified. The dialog does not apply any changes.
Use <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/JavaScriptUI.html" title="class in org.eclipse.wst.jsdt.ui"><CODE>JavaScriptUI</CODE></A> to access and configure
Javadoc locations.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>libraryName</CODE> - Name of of the library to which configured javadoc location belongs.<DD><CODE>initialURL</CODE> - The initial URL or <code>null</code>.
<DT><B>Returns:</B><DD>Returns an array of size 1 that contains the resulting javadoc location or
<code>null</code> if the dialog has been canceled. Note that the configured URL can be <code>null</code> when the user
wishes to have no URL location specified.</DL>
</DD>
</DL>
<HR>
<A NAME="configureJavadocLocation(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry)"><!-- --></A><H3>
configureJavadocLocation</H3>
<PRE>
public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> <B>configureJavadocLocation</B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry)</PRE>
<DL>
<DD>Shows the UI for configuring a javadoc location attribute of the classpath entry. <code>null</code> is returned
if the user cancels the dialog. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialEntry</CODE> - The entry to edit. The kind of the classpath entry must be either
<code>IIncludePathEntry.CPE_LIBRARY</code> or <code>IIncludePathEntry.CPE_VARIABLE</code>.
<DT><B>Returns:</B><DD>Returns the resulting classpath entry containing a potentially modified javadoc location attribute
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.</DL>
</DD>
</DL>
<HR>
<A NAME="configureVariableEntry(Shell, IPath, IPath[])"><!-- --></A><H3>
configureVariableEntry</H3>
<PRE>
public static IPath <B>configureVariableEntry</B>(Shell&nbsp;shell,
IPath&nbsp;initialEntryPath,
IPath[]&nbsp;existingPaths)</PRE>
<DL>
<DD>Shows the UI for configuring a variable classpath entry. See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#CPE_VARIABLE"><CODE>IIncludePathEntry.CPE_VARIABLE</CODE></A> for
details about variable classpath entries.
The dialog returns the configured classpath entry path or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialEntryPath</CODE> - The initial variable classpath variable path or <code>null</code> to use
an empty path.<DD><CODE>existingPaths</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns the configures classpath entry path or <code>null</code> if the dialog has
been canceled.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseVariableEntries(Shell, IPath[])"><!-- --></A><H3>
chooseVariableEntries</H3>
<PRE>
public static IPath[] <B>chooseVariableEntries</B>(Shell&nbsp;shell,
IPath[]&nbsp;existingPaths)</PRE>
<DL>
<DD>Shows the UI for selecting new variable classpath entries. See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#CPE_VARIABLE"><CODE>IIncludePathEntry.CPE_VARIABLE</CODE></A> for
details about variable classpath entries.
The dialog returns an array of the selected variable entries or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>existingPaths</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns an non empty array of the selected variable entries or <code>null</code> if the dialog has
been canceled.</DL>
</DD>
</DL>
<HR>
<A NAME="configureContainerEntry(Shell, org.eclipse.wst.jsdt.core.IIncludePathEntry, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><!-- --></A><H3>
configureContainerEntry</H3>
<PRE>
public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A> <B>configureContainerEntry</B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>&nbsp;initialEntry,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]&nbsp;currentClasspath)</PRE>
<DL>
<DD>Shows the UI to configure a classpath container classpath entry. See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#CPE_CONTAINER"><CODE>IIncludePathEntry.CPE_CONTAINER</CODE></A> for
details about container classpath entries.
The dialog returns the configured classpath entry or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialEntry</CODE> - The initial classpath container entry.<DD><CODE>project</CODE> - The project the entry belongs to. The project does not have to exist and can also be <code>null</code>.<DD><CODE>currentClasspath</CODE> - 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 <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/IJsGlobalScopeContainerPageExtension.html" title="interface in org.eclipse.wst.jsdt.ui.wizards"><CODE>IJsGlobalScopeContainerPageExtension</CODE></A> for
more information.
<DT><B>Returns:</B><DD>Returns the configured classpath container entry or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseContainerEntries(Shell, org.eclipse.wst.jsdt.core.IJavaScriptProject, org.eclipse.wst.jsdt.core.IIncludePathEntry[])"><!-- --></A><H3>
chooseContainerEntries</H3>
<PRE>
public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[] <B>chooseContainerEntries</B>(Shell&nbsp;shell,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html" title="interface in org.eclipse.wst.jsdt.core">IIncludePathEntry</A>[]&nbsp;currentClasspath)</PRE>
<DL>
<DD>Shows the UI to choose new classpath container classpath entries. See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/IIncludePathEntry.html#CPE_CONTAINER"><CODE>IIncludePathEntry.CPE_CONTAINER</CODE></A> for
details about container classpath entries.
The dialog returns the selected classpath entries or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>project</CODE> - The project the entry belongs to. The project does not have to exist and
can also be <code>null</code>.<DD><CODE>currentClasspath</CODE> - 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 <A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/IJsGlobalScopeContainerPageExtension.html" title="interface in org.eclipse.wst.jsdt.ui.wizards"><CODE>IJsGlobalScopeContainerPageExtension</CODE></A> for
more information.
<DT><B>Returns:</B><DD>Returns the selected classpath container entries or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="configureJAREntry(Shell, IPath, IPath[])"><!-- --></A><H3>
configureJAREntry</H3>
<PRE>
public static IPath <B>configureJAREntry</B>(Shell&nbsp;shell,
IPath&nbsp;initialEntry,
IPath[]&nbsp;usedEntries)</PRE>
<DL>
<DD>Shows the UI to configure a JAR or ZIP archive located in the workspace.
The dialog returns the configured classpath entry path or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialEntry</CODE> - The path of the initial archive entry<DD><CODE>usedEntries</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns the configured classpath container entry path or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseJAREntries(Shell, IPath, IPath[])"><!-- --></A><H3>
chooseJAREntries</H3>
<PRE>
public static IPath[] <B>chooseJAREntries</B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</PRE>
<DL>
<DD>Shows the UI to select new JAR or ZIP archive entries located in the workspace.
The dialog returns the selected entries or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialSelection</CODE> - The path of the element (container or archive) to initially select or <code>null</code> to not select an entry.<DD><CODE>usedEntries</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns the new classpath container entry paths or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseSuperType(Shell, org.eclipse.wst.jsdt.internal.ui.wizards.buildpaths.CPListElement[], org.eclipse.wst.jsdt.core.LibrarySuperType, org.eclipse.wst.jsdt.core.IJavaScriptProject)"><!-- --></A><H3>
chooseSuperType</H3>
<PRE>
public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A> <B>chooseSuperType</B>(Shell&nbsp;shell,
org.eclipse.wst.jsdt.internal.ui.wizards.buildpaths.CPListElement[]&nbsp;cpEntries,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/LibrarySuperType.html" title="class in org.eclipse.wst.jsdt.core">LibrarySuperType</A>&nbsp;initialSelection,
<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptProject.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptProject</A>&nbsp;project)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="configureExternalJAREntry(Shell, IPath)"><!-- --></A><H3>
configureExternalJAREntry</H3>
<PRE>
public static IPath <B>configureExternalJAREntry</B>(Shell&nbsp;shell,
IPath&nbsp;initialEntry)</PRE>
<DL>
<DD>Shows the UI to configure an external JAR or ZIP archive.
The dialog returns the configured or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialEntry</CODE> - The path of the initial archive entry.
<DT><B>Returns:</B><DD>Returns the configured classpath container entry path or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseExternalJAREntries(Shell)"><!-- --></A><H3>
chooseExternalJAREntries</H3>
<PRE>
public static IPath[] <B>chooseExternalJAREntries</B>(Shell&nbsp;shell)</PRE>
<DL>
<DD>Shows the UI to select new external JAR or ZIP archive entries.
The dialog returns the selected entry paths or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.
<DT><B>Returns:</B><DD>Returns the new classpath container entry paths or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseClassFolderEntries(Shell, IPath, IPath[])"><!-- --></A><H3>
chooseClassFolderEntries</H3>
<PRE>
public static IPath[] <B>chooseClassFolderEntries</B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</PRE>
<DL>
<DD>Shows the UI to select new class folders.
The dialog returns the selected classpath entry paths or <code>null</code> if the dialog has
been canceled. The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialSelection</CODE> - The path of the element to initially select or <code>null</code>.<DD><CODE>usedEntries</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns the configured classpath container entry path or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<HR>
<A NAME="chooseSourceFolderEntries(Shell, IPath, IPath[])"><!-- --></A><H3>
chooseSourceFolderEntries</H3>
<PRE>
public static IPath[] <B>chooseSourceFolderEntries</B>(Shell&nbsp;shell,
IPath&nbsp;initialSelection,
IPath[]&nbsp;usedEntries)</PRE>
<DL>
<DD>Shows the UI to select new source folders.
The dialog returns the selected classpath entry paths or <code>null</code> if the dialog has
been canceled The dialog does not apply any changes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>shell</CODE> - The parent shell for the dialog.<DD><CODE>initialSelection</CODE> - The path of the element to initially select or <code>null</code><DD><CODE>usedEntries</CODE> - An array of paths that are already on the classpath and therefore should not be
selected again.
<DT><B>Returns:</B><DD>Returns the configured classpath container entry path or <code>null</code> if the dialog has
been canceled by the user.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BuildPathDialogAccess.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/BaseLibraryWizardPage.html" title="class in org.eclipse.wst.jsdt.ui.wizards"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/wst/jsdt/ui/wizards/ClasspathAttributeConfiguration.html" title="class in org.eclipse.wst.jsdt.ui.wizards"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/ui/wizards/BuildPathDialogAccess.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="BuildPathDialogAccess.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>