Class JaxoUserGuide

java.lang.Object
net.sf.jaxodraw.gui.panel.JaxoUserGuide
public class JaxoUserGuide extends Object
Responsible for creating and locating the User Guide.

  • Constructor Details

    • JaxoUserGuide

      public JaxoUserGuide(Component parentc)
      Constructor that takes a parent component.
      Parameters:
      parentc - The parent component for this UserGuide.

    • JaxoUserGuide

      public JaxoUserGuide(String targetDir, Component parentc)
      Constructor that takes a parent component and an alternative target location.
      Parameters:
      targetDir - the directory where the user guide will be created.
      parentc - The parent component for this UserGuide.

  • Method Details

    • main

      public static void main(String[] args)
      Create the User Guide from the command line.
      Parameters:
      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.

    • show

      public void show(JaxoPreview p)
      Shows the User Guide in the given Preview.
      Parameters:
      p - The preview to use.

    • isLocallyBrowsable

      public boolean isLocallyBrowsable()
      Checks if the User Guide exists locally and if not, tries to re-create it.
      Returns:
      True if the local version of the User Guide was created without errors, and is therefore browsable.

    • localIndexPage

      public URL localIndexPage()
      Returns a URL to the index page of the local copy of the User Guide.
      Returns:
      Null if isLocallyBrowsable() returns false, or if another error occurred; the local URL otherwise.