|
org.netbeans.modules.java.sourceui/1 1.23.1 1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.netbeans.api.java.source.ui.ElementJavadoc
public class ElementJavadoc
Utility class for viewing Javadoc comments as HTML.
Method Summary | |
---|---|
static ElementJavadoc |
create(CompilationInfo compilationInfo,
Element element)
Creates an object describing the Javadoc of given element. |
static ElementJavadoc |
create(CompilationInfo compilationInfo,
Element element,
Callable<Boolean> cancel)
Creates an object describing the Javadoc of given element. |
Action |
getGotoSourceAction()
Gets action capable of juming to source of the Element this Javadoc belongs to. |
String |
getText()
Gets the javadoc comment formated as HTML. |
Future<String> |
getTextAsync()
Gets the javadoc comment formated as HTML. |
URL |
getURL()
Gets URL of the external javadoc. |
ElementJavadoc |
resolveLink(String link)
Resolves a link contained in the Javadoc comment to an object describing the linked javadoc |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static final ElementJavadoc create(CompilationInfo compilationInfo, Element element)
compilationInfo
- CompilationInfoelement
- Element the javadoc is required for
public static final ElementJavadoc create(CompilationInfo compilationInfo, Element element, Callable<Boolean> cancel)
compilationInfo
- CompilationInfoelement
- Element the javadoc is required forcancel
- a Callable
to signal the cancel request
public String getText()
public Future<String> getTextAsync()
Future
of HTML text of the javadocpublic URL getURL()
public ElementJavadoc resolveLink(String link)
link
- Link which has to be resolved
public Action getGotoSourceAction()
|
org.netbeans.modules.java.sourceui/1 1.23.1 1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |