blob: 5c7ac0e61fe02f5bc9d8b44a6f386ecbccdb168d [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:15:49 CDT 2008 -->
<TITLE>
IPackageDeclaration
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IPackageDeclaration interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IPackageDeclaration";
}
</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/IPackageDeclaration.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/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IPackageDeclaration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IPackageDeclaration.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.core</FONT>
<BR>
Interface IPackageDeclaration</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IPackageDeclaration</B><DT>extends <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A></DL>
</PRE>
<P>
Represents a package declaration in JavaScript compilation unit.
<p>
This interface is not intended to be implemented by clients.
</p>
<p><b>Note: This Interface only applies to ECMAScript 4 which is not yet supported</b></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>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.eclipse.wst.jsdt.core.IJavaScriptElement"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#CLASS_FILE">CLASS_FILE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#FIELD">FIELD</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_CONTAINER">IMPORT_CONTAINER</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#IMPORT_DECLARATION">IMPORT_DECLARATION</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#INITIALIZER">INITIALIZER</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_MODEL">JAVASCRIPT_MODEL</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_PROJECT">JAVASCRIPT_PROJECT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#JAVASCRIPT_UNIT">JAVASCRIPT_UNIT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#LOCAL_VARIABLE">LOCAL_VARIABLE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#METHOD">METHOD</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_DECLARATION">PACKAGE_DECLARATION</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT">PACKAGE_FRAGMENT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#PACKAGE_FRAGMENT_ROOT">PACKAGE_FRAGMENT_ROOT</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE">TYPE</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#TYPE_PARAMETER">TYPE_PARAMETER</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageDeclaration.html#getElementName()">getElementName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the package the statement refers to.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IJavaScriptElement"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#exists()">exists</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getAncestor(int)">getAncestor</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getAttachedJavadoc(IProgressMonitor)">getAttachedJavadoc</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCommonSuperType()">getCommonSuperType</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getCorrespondingResource()">getCorrespondingResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getDisplayName()">getDisplayName</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getElementType()">getElementType</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getHandleIdentifier()">getHandleIdentifier</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getHostPath()">getHostPath</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptModel()">getJavaScriptModel</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getJavaScriptProject()">getJavaScriptProject</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getOpenable()">getOpenable</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getParent()">getParent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getPath()">getPath</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getPrimaryElement()">getPrimaryElement</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getResource()">getResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getSchedulingRule()">getSchedulingRule</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getUnderlyingResource()">getUnderlyingResource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isReadOnly()">isReadOnly</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isStructureKnown()">isStructureKnown</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#isVirtual()">isVirtual</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ILookupScope"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core">ILookupScope</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newNameLookup(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])">newNameLookup</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newNameLookup(org.eclipse.wst.jsdt.core.WorkingCopyOwner)">newNameLookup</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newSearchableNameEnvironment(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])">newSearchableNameEnvironment</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ILookupScope.html#newSearchableNameEnvironment(org.eclipse.wst.jsdt.core.WorkingCopyOwner)">newSearchableNameEnvironment</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ISourceReference"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.eclipse.wst.jsdt.core.<A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#exists()">exists</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#getSource()">getSource</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html#getSourceRange()">getSourceRange</A></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="getElementName()"><!-- --></A><H3>
getElementName</H3>
<PRE>
java.lang.String <B>getElementName</B>()</PRE>
<DL>
<DD>Returns the name of the package the statement refers to.
This is a handle-only method.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html#getElementName()">getElementName</A></CODE> in interface <CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the name of the package the statement</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/IPackageDeclaration.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/core/IOpenable.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IPackageFragment.html" title="interface in org.eclipse.wst.jsdt.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/eclipse/wst/jsdt/core/IPackageDeclaration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IPackageDeclaration.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>