Google Git
Sign in
eclipse / gerrit / jsdt / webtools.jsdt.core / 927db86fe692fa2a12cecc04846b9f13e691ecfe / . / docs / org.eclipse.wst.jsdt.doc / html / api_reference / org / eclipse / wst / jsdt / core / IMember.html
blob: 4371dd37a1a63d10d4dd2d0e65069963b5a8469d [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:48 CDT 2008 -->
<TITLE>
IMember
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.IMember interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IMember";
}
</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/IMember.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/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.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/IMember.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMember.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 IMember</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/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html" title="interface in org.eclipse.wst.jsdt.core">ISourceManipulation</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceReference.html" title="interface in org.eclipse.wst.jsdt.core">ISourceReference</A></DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IField.html" title="interface in org.eclipse.wst.jsdt.core">IField</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IFunction.html" title="interface in org.eclipse.wst.jsdt.core">IFunction</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IInitializer.html" title="interface in org.eclipse.wst.jsdt.core">IInitializer</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMember</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>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html" title="interface in org.eclipse.wst.jsdt.core">ISourceManipulation</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A></DL>
</PRE>
<P>
Common protocol for JavaScript elements that can be members of javaScript files or types.
This set consists of <code>IType</code>, <code>IFunction</code>,
<code>IField</code>, and <code>IInitializer</code>.
<p>
This interface is not intended to be implemented 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>
<!-- =========== 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/IMember.html#getCategories()">getCategories</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the categories defined by this member's JSDoc.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core">IClassFile</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getClassFile()">getClassFile</A></B>()</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>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getCompilationUnit()">getCompilationUnit</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getJavaScriptUnit()"><CODE>getJavaScriptUnit()</CODE></A> instead</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getDeclaringType()">getDeclaringType</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the type in which this member is declared, or <code>null</code>
if this member is not declared in a type (for example, a top-level type).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getFlags()">getFlags</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the modifier flags for this member.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getJavaScriptUnit()">getJavaScriptUnit</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the javaScript unit in which this member is declared, or <code>null</code>
if this member is not declared in a javaScript unit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceRange.html" title="interface in org.eclipse.wst.jsdt.core">ISourceRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getJSdocRange()">getJSdocRange</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the JSDoc range if this element is from source or if this element
is a binary element with an attached source, null otherwise.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceRange.html" title="interface in org.eclipse.wst.jsdt.core">ISourceRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getNameRange()">getNameRange</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the source range of this member's simple name,
or <code>null</code> if this member does not have a name
(for example, an initializer), or if this member does not have
associated source code (for example, a binary type).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getOccurrenceCount()">getOccurrenceCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the position relative to the order this member is defined in the source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getType(java.lang.String, int)">getType</A></B>(java.lang.String&nbsp;name,
int&nbsp;occurrenceCount)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the local or anonymous type declared in this source member with the given simple name and/or
with the specified position relative to the order they are defined in the source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html" title="interface in org.eclipse.wst.jsdt.core">ITypeRoot</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getTypeRoot()">getTypeRoot</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the JavaScript type root in which this member is declared.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#isBinary()">isBinary</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether this member is from a non-editable file.</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#getElementName()">getElementName</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;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.ISourceManipulation"><!-- --></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/ISourceManipulation.html" title="interface in org.eclipse.wst.jsdt.core">ISourceManipulation</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html#copy(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.IJavaScriptElement, java.lang.String, boolean, IProgressMonitor)">copy</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html#delete(boolean, IProgressMonitor)">delete</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html#move(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.IJavaScriptElement, java.lang.String, boolean, IProgressMonitor)">move</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceManipulation.html#rename(java.lang.String, boolean, IProgressMonitor)">rename</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.IParent"><!-- --></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/IParent.html" title="interface in org.eclipse.wst.jsdt.core">IParent</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html#getChildren()">getChildren</A>, <A HREF="../../../../../org/eclipse/wst/jsdt/core/IParent.html#hasChildren()">hasChildren</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="getCategories()"><!-- --></A><H3>
getCategories</H3>
<PRE>
java.lang.String[] <B>getCategories</B>()
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns the categories defined by this member's JSDoc. A category is the identifier
following the tag <code>@category</code> in the member's JSDoc.
Returns an empty array if no category is defined in this member's JSDoc.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the categories defined by this member's doc
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an
exception occurs while accessing its corresponding resource.</DL>
</DD>
</DL>
<HR>
<A NAME="getClassFile()"><!-- --></A><H3>
getClassFile</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IClassFile.html" title="interface in org.eclipse.wst.jsdt.core">IClassFile</A> <B>getClassFile</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCompilationUnit()"><!-- --></A><H3>
getCompilationUnit</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> <B>getCompilationUnit</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Use <A HREF="../../../../../org/eclipse/wst/jsdt/core/IMember.html#getJavaScriptUnit()"><CODE>getJavaScriptUnit()</CODE></A> instead</I>
<P>
<DD>Returns the javaScript unit in which this member is declared, or <code>null</code>
if this member is not declared in a javaScript unit .
This is a handle-only method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the javaScript unit in which this member is declared, or <code>null</code>
if this member is not declared in a javaScript unit</DL>
</DD>
</DL>
<HR>
<A NAME="getJavaScriptUnit()"><!-- --></A><H3>
getJavaScriptUnit</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A> <B>getJavaScriptUnit</B>()</PRE>
<DL>
<DD>Returns the javaScript unit in which this member is declared, or <code>null</code>
if this member is not declared in a javaScript unit.
This is a handle-only method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the javaScript unit in which this member is declared, or <code>null</code>
if this member is not declared in a javaScript unit (for example, a binary type)</DL>
</DD>
</DL>
<HR>
<A NAME="getDeclaringType()"><!-- --></A><H3>
getDeclaringType</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>getDeclaringType</B>()</PRE>
<DL>
<DD>Returns the type in which this member is declared, or <code>null</code>
if this member is not declared in a type (for example, a top-level type).
This is a handle-only method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the type in which this member is declared, or <code>null</code>
if this member is not declared in a type (for example, a top-level type)</DL>
</DD>
</DL>
<HR>
<A NAME="getFlags()"><!-- --></A><H3>
getFlags</H3>
<PRE>
int <B>getFlags</B>()
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns the modifier flags for this member. The flags can be examined using class
<code>Flags</code>.
<p>
Note that only flags as indicated in the source are returned. Thus if an interface
defines a method <code>void myMethod();</code> the flags don't include the
'public' flag.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the modifier flags for this member
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an
exception occurs while accessing its corresponding resource.<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/Flags.html" title="class in org.eclipse.wst.jsdt.core"><CODE>Flags</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getJSdocRange()"><!-- --></A><H3>
getJSdocRange</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceRange.html" title="interface in org.eclipse.wst.jsdt.core">ISourceRange</A> <B>getJSdocRange</B>()
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns the JSDoc range if this element is from source or if this element
is a binary element with an attached source, null otherwise.
<p>If this element is from source, the jsdoc range is
extracted from the corresponding source.</p>
<p>If this element is from a binary, the jsdoc is extracted from the
attached source if present.</p>
<p>If this element's openable is not consistent, then null is returned.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a source range corresponding to the jsdoc source or <code>null</code>
if no source is available, this element has no jsdoc comment or
this element's openable is not consistent
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an
exception occurs while accessing its corresponding resource.<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.html#isConsistent()"><CODE>IOpenable.isConsistent()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNameRange()"><!-- --></A><H3>
getNameRange</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ISourceRange.html" title="interface in org.eclipse.wst.jsdt.core">ISourceRange</A> <B>getNameRange</B>()
throws <A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE>
<DL>
<DD>Returns the source range of this member's simple name,
or <code>null</code> if this member does not have a name
(for example, an initializer), or if this member does not have
associated source code (for example, a binary type).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the source range of this member's simple name,
or <code>null</code> if this member does not have a name
(for example, an initializer), or if this member does not have
associated source code (for example, a binary type)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if this element does not exist or if an
exception occurs while accessing its corresponding resource.</DL>
</DD>
</DL>
<HR>
<A NAME="getOccurrenceCount()"><!-- --></A><H3>
getOccurrenceCount</H3>
<PRE>
int <B>getOccurrenceCount</B>()</PRE>
<DL>
<DD>Returns the position relative to the order this member is defined in the source.
Numbering starts at 1 (thus the first occurrence is occurrence 1, not occurrence 0).
<p>
Two members m1 and m2 that are equal (e.g. 2 fields with the same name in
the same type) can be distinguished using their occurrence counts. If member
m1 appears first in the source, it will have an occurrence count of 1. If member
m2 appears right after member m1, it will have an occurrence count of 2.
</p><p>
The occurrence count can be used to distinguish initializers inside a type
or anonymous types inside a method.
</p><p>
This is a handle-only method. The member may or may not be present.
</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the position relative to the order this member is defined in the source</DL>
</DD>
</DL>
<HR>
<A NAME="getTypeRoot()"><!-- --></A><H3>
getTypeRoot</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/ITypeRoot.html" title="interface in org.eclipse.wst.jsdt.core">ITypeRoot</A> <B>getTypeRoot</B>()</PRE>
<DL>
<DD>Returns the JavaScript type root in which this member is declared.
This is a handle-only method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the JavaScript type root in which this member is declared.</DL>
</DD>
</DL>
<HR>
<A NAME="getType(java.lang.String, int)"><!-- --></A><H3>
getType</H3>
<PRE>
<A HREF="../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> <B>getType</B>(java.lang.String&nbsp;name,
int&nbsp;occurrenceCount)</PRE>
<DL>
<DD>Returns the local or anonymous type declared in this source member with the given simple name and/or
with the specified position relative to the order they are defined in the source.
The name is empty if it is an anonymous type.
Numbering starts at 1 (thus the first occurrence is occurrence 1, not occurrence 0).
This is a handle-only method. The type may or may not exist.
Throws a <code>RuntimeException</code> if this member is not a source member.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the given simple name<DD><CODE>occurrenceCount</CODE> - the specified position
<DT><B>Returns:</B><DD>the type with the given name and/or with the specified position relative to the order they are defined in the source</DL>
</DD>
</DL>
<HR>
<A NAME="isBinary()"><!-- --></A><H3>
isBinary</H3>
<PRE>
boolean <B>isBinary</B>()</PRE>
<DL>
<DD>Returns whether this member is from a non-editable file.
This is a handle-only method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if from a non-editable file, and <code>false</code> if
from a javaScript unit</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/IMember.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/ILookupScope.html" title="interface in org.eclipse.wst.jsdt.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/eclipse/wst/jsdt/core/IOpenable.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/IMember.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IMember.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>