JavadocViewerRunner (QuPath 0.6.0)

java.lang.Object

qupath.lib.gui.JavadocViewerRunner

All Implemented Interfaces:: Runnable

public class JavadocViewerRunner extends Object implements Runnable

A command to show a JavadocViewer in a standalone window. Only one instance of the viewer will be created.

The following places will be searched for javadocs:

The value of the JAVADOC_PATH_SYSTEM_PROPERTY system property.
The value of the JAVADOC_PATH_PREFERENCE persistent preference.
Around the currently running executable.
In the QuPath user directory (so including QuPath extensions).

Constructor Summary

Constructors

Constructor

Description

JavadocViewerRunner(Stage owner)

Create the command.
Method Summary

Modifier and Type

Method

Description

qupath.ui.javadocviewer.gui.viewer.JavadocViewer

getJavadocViewer()

Get a reference to the viewer launched by the JavadocViewerCommand.

void

run()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- JavadocViewerRunner
  
  public JavadocViewerRunner(Stage owner)
  
  Create the command. This will not create the viewer yet.
  
  Parameters:
  
  owner - the stage that should own the viewer window. Can be null
Method Details
- getJavadocViewer
  
  public qupath.ui.javadocviewer.gui.viewer.JavadocViewer getJavadocViewer()
  
  Get a reference to the viewer launched by the JavadocViewerCommand.
  
  Returns:
  
  A reference to the Javadoc viewer.
- run
  
  public void run()
  
  Specified by:
  
  run in interface Runnable