|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.ui.wizards.JavadocExportWizardPage
public abstract class JavadocExportWizardPage
A Javadoc export wizard page allows the user to add an additional page to the Javadoc wizard.
Clients should extend this class and include the name of their
class in an extension contributed to the jdt.ui's Javadoc export wizard page
extension point (named org.eclipse.jdt.ui.javadocExportWizardPage
).
Nested Class Summary | |
---|---|
static interface |
JavadocExportWizardPage.IJavadocExportWizardPageContainer
The page container. |
Constructor Summary | |
---|---|
JavadocExportWizardPage()
|
Method Summary | |
---|---|
abstract Control |
createContents(Composite parent)
Creates the content of this page under the given parent composite. |
void |
dispose()
Disposes any resources allocated by this dialog page. |
protected JavadocExportWizardPage.IJavadocExportWizardPageContainer |
getContainer()
Gets the parent wizard container |
IStatus |
getStatus()
Returns the status of the page. |
void |
performHelp()
Notifies that help has been requested for this dialog page. |
void |
setContainer(JavadocExportWizardPage.IJavadocExportWizardPageContainer container)
Sets the parent wizard container. |
protected void |
setStatus(IStatus status)
Sets the page status. |
void |
setVisible(boolean visible)
Called when the page becomes visible or becomes hidden. |
void |
updateAntScript(Element xmlDocument)
Called when the Javadoc ANT script is generated. |
void |
updateArguments(List<String> vmOptions,
List<String> toolOptions)
Called when the command line arguments are collected. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavadocExportWizardPage()
Method Detail |
---|
public abstract Control createContents(Composite parent)
parent
- the parent composite
public final IStatus getStatus()
IStatus.OK
or IStatus.WARNING
.
The page is invalid when the severity is IStatus.ERROR
.
to set the page status
protected final void setStatus(IStatus status)
IStatus.OK
IStatus.WARNING
or IStatus.ERROR
.
status
- the new statuspublic final void setContainer(JavadocExportWizardPage.IJavadocExportWizardPageContainer container)
setVisible(boolean)
or
createContents(Composite)
is called.
container
- the parent containerprotected final JavadocExportWizardPage.IJavadocExportWizardPageContainer getContainer()
public void updateArguments(List<String> vmOptions, List<String> toolOptions)
vmOptions
- A List
of String
with the VM arguments.toolOptions
- A List
of String
with the Javadoc tool arguments. See the
Javadoc command specification for the format of the arguments.public void updateAntScript(Element xmlDocument)
xmlDocument
- The XML element for the 'javadoc' node. Clients can add or modify
arguments. See the Javadoc ANT task
specification for the format of the arguments.public void dispose()
public void performHelp()
public void setVisible(boolean visible)
visible
- true
when the page becomes visible,
and false
when the page is hidden
|
Eclipse JDT Release 3.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2013 IBM Corporation and others. All rights reserved.