public class JaxoUserGuide
extends java.lang.Object
Constructor and Description |
---|
JaxoUserGuide(java.awt.Component parentc)
Constructor that takes a parent component.
|
JaxoUserGuide(java.lang.String targetDir,
java.awt.Component parentc)
Constructor that takes a parent component and an alternative target location.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isLocallyBrowsable()
Checks if the User Guide exists locally and if not, tries to re-create it.
|
java.net.URL |
localIndexPage()
Returns a URL to the index page of the local copy of the User Guide.
|
static void |
main(java.lang.String[] args)
Create the User Guide from the command line.
|
void |
show(JaxoPreview p)
Shows the User Guide in the given Preview.
|
public JaxoUserGuide(java.awt.Component parentc)
parentc
- The parent component for this UserGuide.public JaxoUserGuide(java.lang.String targetDir, java.awt.Component parentc)
targetDir
- the directory where the user guide will be created.parentc
- The parent component for this UserGuide.public static void main(java.lang.String[] args)
args
- optional: args[0] may contain the target directory
where the User Guide will be created. If not given,
the User Guide will be created in JaxoInfo.USER_HOME
.public void show(JaxoPreview p)
p
- The preview to use.public boolean isLocallyBrowsable()
public java.net.URL localIndexPage()
Licensed under GPL. For more information, see http://jaxodraw.sourceforge.net/license.html or the LICENSE file in the jaxodraw distribution.