+
+Now when you run QuPath from IntelliJ, your extension should (hopefully) be found - there's no need to add it by drag & drop.
+
+## Customize the extension
+
+There are a few fixed steps to customizing the extension, and then the main creative part where you add your own code.
+
+### Update `settings.gradle`
+
+Open `settings.gradle` and check the comment lines flagged with `\\TODO`.
+These point you towards parts you may well need to change.
+
+### Update `build.gradle`
+
+Open `build.gradle` and follow a similar process to with `settings.gradle`, to update the bits flagged with `\\TODO`.
+
+### Create the extension Java or Groovy file(s)
+
+For the extension to work, you need to create at least one file that extends `qupath.lib.gui.extensions.QuPathExtension`.
+
+There are two examples in the template, in two languages:
+* **Java:** `qupath.ext.template.DemoExtension.java`.
+* **Groovy:** `qupath.ext.template.DemoGroovyExtension.java`.
+
+You can pick the one that corresponds to the language you want to use, and delete the other.
+
+Then take your chosen file and rename it, edit it, move it to another package... basically, make it your own.
+
+> Please **don't neglect this step!**
+> If you do, there's a chance of multiple extensions being created with the same class names... and causing confusion later.
+
+### Update the `META-INF/services` file
+
+For QuPath to *find* the extension later, the full class name needs to be available in `resources/META-INFO/services/qupath.lib.gui.extensions.QuPathExtensions`.
+
+So remember to edit that file to include the class name that you actually used for your extension.
+
+### Specify your license
+
+Add a license file to your GitHub repo so that others know what they can and can't do with your extension.
+
+This should be compatible with QuPath's license -- see https://github.com/qupath/qupath
+
+### Replace this readme
+
+Don't forget to replace the contents of this readme with your own!
+
+
+## Getting help
+
+For questions about QuPath and/or creating new extensions, please use the forum at https://forum.image.sc/tag/qupath
+
+------
+
+## License
+
+This is just a template, you're free to use it however you like.
+You can treat the contents of *this repository only* as being under [the Unlicense](https://unlicense.org) (except for the Gradle wrapper, which has its own license included).
+
+If you use it to create a new QuPath extension, I'd strongly encourage you to select a suitable open-source license for the extension.
+
+Note that *QuPath itself* is available under the GPL, so you do have to abide by those terms: see https://github.com/qupath/qupath for more.
diff --git a/build.gradle b/build.gradle
new file mode 100644
index 0000000..cf9a9b8
--- /dev/null
+++ b/build.gradle
@@ -0,0 +1,167 @@
+plugins {
+ // Main gradle plugin for building a Java library
+ id 'java-library'
+ // Support writing the extension in Groovy (remove this if you don't want to)
+ id 'groovy'
+ // To create a shadow/fat jar that bundle up all dependencies
+ id 'com.github.johnrengelman.shadow' version '8.1.1'
+ // Include this plugin to avoid downloading JavaCPP dependencies for all platforms
+ id 'org.bytedeco.gradle-javacpp-platform'
+ id 'org.openjfx.javafxplugin' version '0.1.0'
+}
+
+// TODO: Change the module name
+ext.moduleName = 'io.github.qupath.extension.template'
+
+// TODO: Define the extension name & version, and provide a short description
+base {
+ archivesName = rootProject.name
+ version = '0.0.1-SNAPSHOT'
+ description = 'A simple QuPath extension template'
+}
+
+// TODO: Specify the QuPath version, compatible with the extension.
+// The default 'gradle.ext.qupathVersion' reads this from settings.gradle.
+ext.qupathVersion = gradle.ext.qupathVersion
+
+// TODO: Specify the Java version compatible with the extension
+// Should be Java 17 for QuPath v0.5.0
+ext.qupathJavaVersion = 17
+
+/**
+ * Define dependencies.
+ * - Using 'shadow' indicates that they are already part of QuPath, so you don't need
+ * to include them in your extension. If creating a single 'shadow jar' containing your
+ * extension and all dependencies, these won't be added.
+ * - Using 'implementation' indicates that you need the dependency for the extension to work,
+ * and it isn't part of QuPath already. If you are creating a single 'shadow jar', the
+ * dependency should be bundled up in the extension.
+ * - Using 'testImplementation' indicates that the dependency is only needed for testing,
+ * but shouldn't be bundled up for use in the extension.
+ */
+dependencies {
+
+ // Main QuPath user interface jar.
+ // Automatically includes other QuPath jars as subdependencies.
+ shadow "io.github.qupath:qupath-gui-fx:${qupathVersion}"
+
+ // For logging - the version comes from QuPath's version catalog at
+ // https://github.com/qupath/qupath/blob/main/gradle/libs.versions.toml
+ // See https://docs.gradle.org/current/userguide/platforms.html
+ shadow libs.slf4j
+
+ // If you aren't using Groovy, this can be removed
+ shadow libs.bundles.groovy
+
+ testImplementation "io.github.qupath:qupath-gui-fx:${qupathVersion}"
+ testImplementation libs.junit
+}
+
+/*
+ * Manifest info
+ */
+jar {
+ manifest {
+ attributes("Implementation-Title": project.name,
+ "Implementation-Version": archiveVersion,
+ "Automatic-Module-Name": moduleName)
+ }
+}
+
+/**
+ * Copy necessary attributes, see
+ * - https://github.com/qupath/qupath-extension-template/issues/9
+ * - https://github.com/openjfx/javafx-gradle-plugin#variants
+ */
+configurations.shadow {
+ def runtimeAttributes = configurations.runtimeClasspath.attributes
+ runtimeAttributes.keySet().each { key ->
+ if (key in [Usage.USAGE_ATTRIBUTE, OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, MachineArchitecture.ARCHITECTURE_ATTRIBUTE])
+ attributes.attribute(key, runtimeAttributes.getAttribute(key))
+ }
+}
+
+/*
+ * Copy the LICENSE file into the jar... if we have one (we should!)
+ */
+processResources {
+ from ("${projectDir}/LICENSE") {
+ into 'licenses/'
+ }
+}
+
+/*
+ * Define extra 'copyDependencies' task to copy dependencies into the build directory.
+ */
+tasks.register("copyDependencies", Copy) {
+ description "Copy dependencies into the build directory for use elsewhere"
+ group "QuPath"
+
+ from configurations.default
+ into 'build/libs'
+}
+
+/*
+ * Ensure Java 17 compatibility, and include sources and javadocs when building.
+ */
+java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(qupathJavaVersion)
+ }
+ withSourcesJar()
+ withJavadocJar()
+}
+
+/*
+ * Create javadocs for all modules/packages in one place.
+ * Use -PstrictJavadoc=true to fail on error with doclint (which is rather strict).
+ */
+tasks.withType(Javadoc) {
+ options.encoding = 'UTF-8'
+ def strictJavadoc = findProperty('strictJavadoc')
+ if (!strictJavadoc) {
+ options.addStringOption('Xdoclint:none', '-quiet')
+ }
+}
+
+/*
+ * Specify that the encoding should be UTF-8 for source files
+ */
+tasks.named('compileJava') {
+ options.encoding = 'UTF-8'
+}
+
+/*
+ * Avoid 'Entry .gitkeep is a duplicate but no duplicate handling strategy has been set.'
+ * when using withSourcesJar()
+ */
+tasks.withType(org.gradle.jvm.tasks.Jar) {
+ duplicatesStrategy = DuplicatesStrategy.INCLUDE
+}
+
+/*
+ * Support tests with JUnit.
+ */
+tasks.named('test') {
+ useJUnitPlatform()
+}
+
+// Looks redundant to include this here and in settings.gradle,
+// but helps overcome some gradle trouble when including this as a subproject
+// within QuPath itself (which is useful during development).
+repositories {
+ // Add this if you need access to dependencies only installed locally
+ // mavenLocal()
+
+ mavenCentral()
+
+ // Add scijava - which is where QuPath's jars are hosted
+ maven {
+ url "https://maven.scijava.org/content/repositories/releases"
+ }
+
+ maven {
+ url "https://maven.scijava.org/content/repositories/snapshots"
+ }
+
+}
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000..249e583
Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000..a595206
--- /dev/null
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
new file mode 100755
index 0000000..a69d9cb
--- /dev/null
+++ b/gradlew
@@ -0,0 +1,240 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+# Gradle start up script for POSIX generated by Gradle.
+#
+# Important for running:
+#
+# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+# noncompliant, but you have some other compliant shell such as ksh or
+# bash, then to run this script, type that shell name before the whole
+# command line, like:
+#
+# ksh Gradle
+#
+# Busybox and similar reduced shells will NOT work, because this script
+# requires all of these POSIX shell features:
+# * functions;
+# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+# * compound commands having a testable exit status, especially «case»;
+# * various built-in commands including «command», «set», and «ulimit».
+#
+# Important for patching:
+#
+# (2) This script targets any POSIX shell, so it avoids extensions provided
+# by Bash, Ksh, etc; in particular arrays are avoided.
+#
+# The "traditional" practice of packing multiple parameters into a
+# space-separated string is a well documented source of bugs and security
+# problems, so this is (mostly) avoided, by progressively accumulating
+# options in "$@", and eventually passing that to Java.
+#
+# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+# see the in-line comments for details.
+#
+# There are tweaks for specific operating systems such as AIX, CygWin,
+# Darwin, MinGW, and NonStop.
+#
+# (3) This script is generated from the Groovy template
+# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# within the Gradle project.
+#
+# You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+ APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
+ [ -h "$app_path" ]
+do
+ ls=$( ls -ld "$app_path" )
+ link=${ls#*' -> '}
+ case $link in #(
+ /*) app_path=$link ;; #(
+ *) app_path=$APP_HOME$link ;;
+ esac
+done
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+ echo "$*"
+} >&2
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in #(
+ CYGWIN* ) cygwin=true ;; #(
+ Darwin* ) darwin=true ;; #(
+ MSYS* | MINGW* ) msys=true ;; #(
+ NONSTOP* ) nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD=$JAVA_HOME/jre/sh/java
+ else
+ JAVACMD=$JAVA_HOME/bin/java
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD=java
+ which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+ case $MAX_FD in #(
+ max*)
+ MAX_FD=$( ulimit -H -n ) ||
+ warn "Could not query maximum file descriptor limit"
+ esac
+ case $MAX_FD in #(
+ '' | soft) :;; #(
+ *)
+ ulimit -n "$MAX_FD" ||
+ warn "Could not set maximum file descriptor limit to $MAX_FD"
+ esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+# * args from the command line
+# * the main class name
+# * -classpath
+# * -D...appname settings
+# * --module-path (only if needed)
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+ APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+ CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+ JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ for arg do
+ if
+ case $arg in #(
+ -*) false ;; # don't mess with options #(
+ /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
+ [ -e "$t" ] ;; #(
+ *) false ;;
+ esac
+ then
+ arg=$( cygpath --path --ignore --mixed "$arg" )
+ fi
+ # Roll the args list around exactly as many times as the number of
+ # args, so each arg winds up back in the position where it started, but
+ # possibly modified.
+ #
+ # NB: a `for` loop captures its iteration list before it begins, so
+ # changing the positional parameters here affects neither the number of
+ # iterations, nor the values presented in `arg`.
+ shift # remove old arg
+ set -- "$@" "$arg" # push replacement arg
+ done
+fi
+
+# Collect all arguments for the java command;
+# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+# shell script including quotes and variable substitutions, so put them in
+# double quotes to make sure that they get re-expanded; and
+# * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+ "-Dorg.gradle.appname=$APP_BASE_NAME" \
+ -classpath "$CLASSPATH" \
+ org.gradle.wrapper.GradleWrapperMain \
+ "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+ die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+# set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+ printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+ xargs -n1 |
+ sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+ tr '\n' ' '
+ )" '"$@"'
+
+exec "$JAVACMD" "$@"
diff --git a/gradlew.bat b/gradlew.bat
new file mode 100644
index 0000000..53a6b23
--- /dev/null
+++ b/gradlew.bat
@@ -0,0 +1,91 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/qupath-intellij.png b/qupath-intellij.png
new file mode 100644
index 0000000..bcbd526
Binary files /dev/null and b/qupath-intellij.png differ
diff --git a/settings.gradle b/settings.gradle
new file mode 100644
index 0000000..ed3fa38
--- /dev/null
+++ b/settings.gradle
@@ -0,0 +1,42 @@
+pluginManagement {
+ plugins {
+ // Gradle is awkward about declaring versions for plugins
+ // Specifying it here, rather than build.gradle, makes it possible
+ // to include the extension as a subproject of QuPath itself
+ // (which is useful during development)
+ id 'org.bytedeco.gradle-javacpp-platform' version '1.5.9'
+ }
+}
+
+// TODO: Name your QuPath extension here!
+rootProject.name = 'my-qupath-extension'
+
+// TODO: Define the QuPath version compatible with the extension
+// Note that the QuPath API isn't stable; something designed for
+// 0.X.a should work with 0.X.b, but not necessarily with 0.Y.a.
+gradle.ext.qupathVersion = "0.5.0"
+
+dependencyResolutionManagement {
+
+ // Access QuPath's version catalog for dependency versions
+ versionCatalogs {
+ libs {
+ from("io.github.qupath:qupath-catalog:${gradle.ext.qupathVersion}")
+ }
+ }
+
+ repositories {
+
+ mavenCentral()
+
+ // Add scijava - which is where QuPath's jars are hosted
+ maven {
+ url "https://maven.scijava.org/content/repositories/releases"
+ }
+
+ maven {
+ url "https://maven.scijava.org/content/repositories/snapshots"
+ }
+
+ }
+}
diff --git a/src/main/groovy/qupath/ext/template/DemoGroovyExtension.groovy b/src/main/groovy/qupath/ext/template/DemoGroovyExtension.groovy
new file mode 100644
index 0000000..c6abf95
--- /dev/null
+++ b/src/main/groovy/qupath/ext/template/DemoGroovyExtension.groovy
@@ -0,0 +1,41 @@
+package qupath.ext.template;
+
+import javafx.scene.control.MenuItem;
+import qupath.lib.common.Version;
+import qupath.lib.gui.QuPathGUI;
+import qupath.lib.gui.dialogs.Dialogs;
+import qupath.lib.gui.extensions.QuPathExtension;
+
+
+/**
+ * This is a demo to provide a template for creating a new QuPath extension in Groovy.
+ * + * Important! For your extension to work in QuPath, you need to make sure the name & package + * of this class is consistent with the file + *
+ * /resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension + *+ */ +class DemoGroovyExtension implements QuPathExtension { + + // Setting the variables here is enough for them to be available in the extension + String name = "My Groovy extension" + String description = "This is just a demo to show how Groovy extensions work" + Version QuPathVersion = Version.parse("v0.4.0") + + @Override + void installExtension(QuPathGUI qupath) { + addMenuItem(qupath) + } + + private void addMenuItem(QuPathGUI qupath) { + def menu = qupath.getMenu("Extensions>${name}", true) + def menuItem = new MenuItem("My Groovy menu item") + menuItem.setOnAction(e -> { + Dialogs.showMessageDialog(name, + "Hello! This is my Groovy extension.") + }) + menu.getItems() << menuItem + } + +} diff --git a/src/main/java/qupath/ext/template/DemoExtension.java b/src/main/java/qupath/ext/template/DemoExtension.java new file mode 100644 index 0000000..07de097 --- /dev/null +++ b/src/main/java/qupath/ext/template/DemoExtension.java @@ -0,0 +1,130 @@ +package qupath.ext.template; + +import javafx.beans.property.BooleanProperty; +import javafx.scene.control.MenuItem; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import qupath.lib.common.Version; +import qupath.lib.gui.QuPathGUI; +import qupath.lib.gui.dialogs.Dialogs; +import qupath.lib.gui.extensions.GitHubProject; +import qupath.lib.gui.extensions.QuPathExtension; +import qupath.lib.gui.prefs.PathPrefs; + + +/** + * This is a demo to provide a template for creating a new QuPath extension. + *
+ * It doesn't do much - it just shows how to add a menu item and a preference. + * See the code and comments below for more info. + *
+ * Important! For your extension to work in QuPath, you need to make sure the name & package + * of this class is consistent with the file + *
+ * /resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension + *+ */ +public class DemoExtension implements QuPathExtension, GitHubProject { + + private static final Logger logger = LoggerFactory.getLogger(DemoExtension.class); + + /** + * Display name for your extension + * TODO: define this + */ + private static final String EXTENSION_NAME = "My Java extension"; + + /** + * Short description, used under 'Extensions > Installed extensions' + * TODO: define this + */ + private static final String EXTENSION_DESCRIPTION = "This is just a demo to show how extensions work"; + + /** + * QuPath version that the extension is designed to work with. + * This allows QuPath to inform the user if it seems to be incompatible. + * TODO: define this + */ + private static final Version EXTENSION_QUPATH_VERSION = Version.parse("v0.5.0"); + + /** + * GitHub repo that your extension can be found at. + * This makes it easier for users to find updates to your extension. + * If you don't want to support this feature, you can remove + * references to GitHubRepo and GitHubProject from your extension. + * TODO: define this + */ + private static final GitHubRepo EXTENSION_REPOSITORY = GitHubRepo.create( + EXTENSION_NAME, "myGitHubUserName", "myGitHubRepo"); + + /** + * Flag whether the extension is already installed (might not be needed... but we'll do it anyway) + */ + private boolean isInstalled = false; + + /** + * A 'persistent preference' - showing how to create a property that is stored whenever QuPath is closed + */ + private BooleanProperty enableExtensionProperty = PathPrefs.createPersistentPreference( + "enableExtension", true); + + @Override + public void installExtension(QuPathGUI qupath) { + if (isInstalled) { + logger.debug("{} is already installed", getName()); + return; + } + isInstalled = true; + addPreference(qupath); + addMenuItem(qupath); + } + + /** + * Demo showing how to add a persistent preference to the QuPath preferences pane. + * @param qupath + */ + private void addPreference(QuPathGUI qupath) { + qupath.getPreferencePane().addPropertyPreference( + enableExtensionProperty, + Boolean.class, + "Enable my extension", + EXTENSION_NAME, + "Enable my extension"); + } + + /** + * Demo showing how a new command can be added to a QuPath menu. + * @param qupath + */ + private void addMenuItem(QuPathGUI qupath) { + var menu = qupath.getMenu("Extensions>" + EXTENSION_NAME, true); + MenuItem menuItem = new MenuItem("My menu item"); + menuItem.setOnAction(e -> { + Dialogs.showMessageDialog(EXTENSION_NAME, + "Hello! This is my Java extension."); + }); + menuItem.disableProperty().bind(enableExtensionProperty.not()); + menu.getItems().add(menuItem); + } + + + @Override + public String getName() { + return EXTENSION_NAME; + } + + @Override + public String getDescription() { + return EXTENSION_DESCRIPTION; + } + + @Override + public Version getQuPathVersion() { + return EXTENSION_QUPATH_VERSION; + } + + @Override + public GitHubRepo getRepository() { + return EXTENSION_REPOSITORY; + } +} diff --git a/src/main/resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension b/src/main/resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension new file mode 100644 index 0000000..0ec208b --- /dev/null +++ b/src/main/resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension @@ -0,0 +1,2 @@ +qupath.ext.template.DemoExtension +qupath.ext.template.DemoGroovyExtension \ No newline at end of file