diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..6b25582 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,46 @@ +# This is a basic workflow to help you get started with Actions + +name: CI + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the "main" branch + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + env: + version: 1.0.${{ github.run_number }} + patchVersion: ${{ github.run_number }} + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v3 + + - uses: actions/setup-java@v3 + with: + distribution: 'corretto' # See 'Supported distributions' for available options + java-version: '11' + + # could also use gradle wrapper task https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle + - name: Build extension + run: | + chmod +x gradlew + ./gradlew clean build -PBUILD_NUMBER=${{ env.patchVersion }} -PBUILD_SOURCEBRANCH=$GITHUB_REF_NAME -PBUILD_SOURCEVERSION=$GITHUB_SHA -PPACKAGE_VERSION=${{ env.version }} + + - name: Archive production artifacts + uses: actions/upload-artifact@v3 + with: + name: HTMLHeaderWidget-v${{ env.version }} + path: build/distributions/*.zip + retention-days: 1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7d1d726 --- /dev/null +++ b/.gitignore @@ -0,0 +1,235 @@ +# Created by https://www.toptal.com/developers/gitignore/api/gradle,visualstudiocode,eclipse,intellij +# Edit at https://www.toptal.com/developers/gitignore?templates=gradle,visualstudiocode,eclipse,intellij + +### Eclipse ### +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.settings/ +.loadpath +.recommenders + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# PyDev specific (Python IDE for Eclipse) +*.pydevproject + +# CDT-specific (C/C++ Development Tooling) +.cproject + +# CDT- autotools +.autotools + +# Java annotation processor (APT) +.factorypath + +# PDT-specific (PHP Development Tools) +.buildpath + +# sbteclipse plugin +.target + +# Tern plugin +.tern-project + +# TeXlipse plugin +.texlipse + +# STS (Spring Tool Suite) +.springBeans + +# Code Recommenders +.recommenders/ + +# Annotation Processing +.apt_generated/ +.apt_generated_test/ + +# Scala IDE specific (Scala & Java development for Eclipse) +.cache-main +.scala_dependencies +.worksheet + +# Uncomment this line if you wish to ignore the project description file. +# Typically, this file would be tracked if it contains build/dependency configurations: +#.project + +### Eclipse Patch ### +# Spring Boot Tooling +.sts4-cache/ + +### Intellij ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Intellij Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +# https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +# SonarQube Plugin +# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator-enh.xml +.idea/**/markdown-navigator/ + +# Cache file creation bug +# See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/$CACHE_FILE$ + +# CodeStream plugin +# https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +# Azure Toolkit for IntelliJ plugin +# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij +.idea/**/azureSettings.xml + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/*.code-snippets + +# Local History for Visual Studio Code +.history/ + +# Built Visual Studio Code Extensions +*.vsix + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history +.ionide + +# Support for Project snippet scope +.vscode/*.code-snippets + +# Ignore code-workspaces +*.code-workspace + +### Gradle ### +.gradle +**/build/ +!src/**/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Avoid ignore Gradle wrappper properties +!gradle-wrapper.properties + +# Cache of project +.gradletasknamecache + +# Eclipse Gradle plugin generated files +# Eclipse Core +.project +# JDT-specific (Eclipse Java Development Tools) +.classpath + +### Gradle Patch ### +# Java heap dump +*.hprof + +# End of https://www.toptal.com/developers/gitignore/api/gradle,visualstudiocode,eclipse,intellij \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..308b8a2 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# HTMLHeaderWidgetTWX + +ThingWorx widget can set document title and favicon during runtime. + +Features: +* Change of document title +* Change of document favicon + +## Configuration +### Designtime +- Mashup Builder +![Mashup builder](/readme/builder.png?raw=true) +* Set/Bind value title and or favicon +* Call the Set-services to execute +Tipp: In the master mashup just set the favicon. In each 'child' mashup set the title. So you can achieve a consistent favicon and adapt the title when e.g. navigating through menu items to the current menu items title. + +### Runtime +- Only changes documents title / favicon +![Runtime](/readme/runtime.png?raw=true) + +### Restrictions +* Changing these attributes via widget is not ideal as the changes will only be applied after the mashup has already loaded. Until then it will show the default favicon or title. + * If possible you may change the favicon in the Tomcat installation and not use the widget. This is only possible for own servers where you have access. + * Setting document title is only possible in a Master mashup. But this only takes a static value. No better way as of now to change title dynamically. +* Changing the title only works when the mashup has a Master mashup + * otherwise there is a timing issue with setting the title which will show the name of the mashup (default behavior) instead. If you need it to work you may want to wrap the `document.title=` into a `setTimeout` call + +## Build + +Execute `gradlew clean build`. + +Optional build parameters: +* BUILD_NUMBER +* BUILD_SOURCEBRANCH +* BUILD_SOURCEVERSION +* PACKAGE_VERSION + +e.g. `gradlew clean build -PBUILD_NUMBER=123 -PBUILD_SOURCEBRANCH=123 -PBUILD_SOURCEVERSION=123 -PPACKAGE_VERSION=1.0.123` \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..cddbcca --- /dev/null +++ b/build.gradle @@ -0,0 +1,110 @@ +apply plugin: 'java' + +defaultTasks 'clean', 'build' + +ext { + package_version = "GENERATE" + build_number = "SNAPSHOT" + source_version = "SNAPSHOT" + source_branch = "-" + + packageVersion = System.getenv("PACKAGE_VERSION") ?: package_version + buildNumber = System.getenv("BUILD_NUMBER") ?: build_number + sourceVersion = System.getenv("BUILD_SOURCEVERSION") ?: source_version + sourceBranch = System.getenv("BUILD_SOURCEBRANCH") ?: source_branch + + if (project.hasProperty('BUILD_NUMBER')) { + logger.info("BUILD_NUMBER passed") + buildNumber = project.getProperty('BUILD_NUMBER') + } + + if (project.hasProperty('PACKAGE_VERSION')) { + logger.info("PACKAGE_VERSION passed") + packageVersion = project.getProperty('PACKAGE_VERSION') + } + + if (project.hasProperty('BUILD_SOURCEVERSION')) { + logger.info("BUILD_SOURCEVERSION passed") + sourceVersion = project.getProperty('BUILD_SOURCEVERSION') + } + + if (project.hasProperty('BUILD_SOURCEBRANCH')) { + logger.info("BUILD_SOURCEBRANCH passed") + sourceBranch = project.getProperty('BUILD_SOURCEBRANCH') + } + + if (buildNumber == "SNAPSHOT") { + def date = new Date() + def prefix = "SNAPSHOT-" + buildNumber = prefix + date.format('yyyyMMddHHmmss') + } + + if (packageVersion == "GENERATE") { + def date = new Date() + def dateString = date.format('yyyyMMdd').toString() + def timeString = date.format('HHmmss').toString() + packageVersion = "0." + dateString + "." + timeString + } + + logger.lifecycle("Using packageVersion: '{}'.", packageVersion) + logger.lifecycle("Using buildNumber: '{}'.", buildNumber) + logger.lifecycle("Using sourceVersion: '{}'.", sourceVersion) + logger.lifecycle("Using sourceBranch: '{}'.", sourceBranch) + + zipName = project.name + "-v" + packageVersion + ".zip" +} + +artifacts { + archives file: file('build/distributions/' + zipName), name: zipName, type: 'zip' +} + +clean { + delete 'build/Entities' +} + +task copyMetadata(type: Copy) { + from 'configfiles' + into 'build/configfiles' +} + +task setPackageVersion(dependsOn: 'copyMetadata') { + doLast { + File metadata = file('build/configfiles/metadata.xml') + String contentMetaData = metadata.getText("UTF-8") + String regexPackageVersion = "(packageVersion=\")([^\"]*)" + + contentMetaData = contentMetaData.replaceAll(regexPackageVersion, "\$1" + packageVersion) + metadata.write(contentMetaData, "UTF-8") + } +} + +task setBuildNumber(dependsOn: 'setPackageVersion') { + doLast { + File metadata = file('build/configfiles/metadata.xml') + String contentMetaData = metadata.getText("UTF-8") + String regexPackageVersion = "(buildNumber=\")([^\"]*)" + + def packageVersionString = "\$1" + buildNumber + " - (Branch: " + sourceBranch + ", Revision: " + sourceVersion + ")" + contentMetaData = contentMetaData.replaceAll(regexPackageVersion, packageVersionString) + + metadata.write(contentMetaData, "UTF-8") + } +} +build.dependsOn('setBuildNumber') + +task createZip(type:Zip) { + archiveName = zipName + + // include the metadata.xml + from 'build/configfiles' + include 'metadata.xml' + + // for if there are widgets in the extension + from ('ui') { + include '**/*.*' + into 'ui' + } + + logger.lifecycle("Created archive: '{}'.", archiveName) +} +build.finalizedBy(createZip) diff --git a/configfiles/metadata.xml b/configfiles/metadata.xml new file mode 100644 index 0000000..ea63cd7 --- /dev/null +++ b/configfiles/metadata.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + 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..ae04661 --- /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-7.5.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 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..f127cfd --- /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/readme/builder.png b/readme/builder.png new file mode 100644 index 0000000..e7e8b52 Binary files /dev/null and b/readme/builder.png differ diff --git a/readme/runtime.png b/readme/runtime.png new file mode 100644 index 0000000..74099c5 Binary files /dev/null and b/readme/runtime.png differ diff --git a/ui/htmlheaderwidget_ds/default_widget_icon.ide.png b/ui/htmlheaderwidget_ds/default_widget_icon.ide.png new file mode 100644 index 0000000..1704279 Binary files /dev/null and b/ui/htmlheaderwidget_ds/default_widget_icon.ide.png differ diff --git a/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.css b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.css new file mode 100644 index 0000000..c417800 --- /dev/null +++ b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.css @@ -0,0 +1,3 @@ +/* Place custom CSS styling for HTMLHeader widget in Composer in this file */ + +.widget-htmlheaderwidget_ds {} \ No newline at end of file diff --git a/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.js b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.js new file mode 100644 index 0000000..0617a6f --- /dev/null +++ b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.ide.js @@ -0,0 +1,70 @@ +TW.IDE.Widgets.htmlheaderwidget_ds = function () { + + this.widgetIconUrl = function () { + return '../Common/extensions/HTMLHeaderWidget/ui/htmlheaderwidget_ds/default_widget_icon.ide.png'; + }; + + this.widgetProperties = function () { + return { + 'name': 'HTMLHeaderWidget', + 'description': '', + 'category': ['Common'], + 'properties': { + 'Title': { + 'description': 'Document title to be used', + 'isBindingTarget': true, + 'isEditable': true, + 'baseType': 'STRING' + }, + 'Favicon': { + 'description': 'Favicon to be used. Should be square and not too big (to be a normal favicon).', + 'isBindingTarget': true, + 'isEditable': true, + 'baseType': 'IMAGELINK', + } + } + } + }; + + this.widgetServices = function () { + return { + 'SetFavicon': { 'warnIfNotBound': false }, + 'SetDocumentTitle': { 'warnIfNotBound': false } + }; + }; + + this.afterSetProperty = function (name, value) { + var refreshHtml = false; + switch (name) { + case "DisplayName": + refreshHtml = true; + break; + default: + break; + } + return refreshHtml; + }; + + this.validate = function () { + var result = []; + + return result; + }; + + this.renderHtml = function () { + // return any HTML you want rendered for your widget + // If you want it to change depending on properties that the user + // has set, you can use this.getProperty(propertyName). + return '
' + + '' + this.properties.DisplayName + " - invisible @ runtime" + '' + + '
'; + }; + + this.afterRender = function () { + // NOTE: this.jqElement is the jquery reference to your html dom element + // that was returned in renderHtml() + // get a reference to the value element + valueElem = this.jqElement.find('.htmlheaderwidget_ds-property'); + }; + +}; \ No newline at end of file diff --git a/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.css b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.css new file mode 100644 index 0000000..b25355a --- /dev/null +++ b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.css @@ -0,0 +1,3 @@ +/* Place custom CSS styling for HTMLHeader widget at runtime in this file */ + +.widget-htmlheaderwidget_ds {} \ No newline at end of file diff --git a/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.js b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.js new file mode 100644 index 0000000..59ba25c --- /dev/null +++ b/ui/htmlheaderwidget_ds/htmlheaderwidget_ds.runtime.js @@ -0,0 +1,60 @@ +TW.Runtime.Widgets.htmlheaderwidget_ds = function () { + + this.renderHtml = function () { + return ''; + }; + + this.afterRender = function () { + // if we never show at runtime, we should hide ourselves completely - Safari and Firefox will show scrollbars if the container is too narrow / short + this.jqElement.hide(); + this.jqElement.closest('.widget-bounding-box').hide(); + }; + + this.updateFavicon = function () { + var image = this.getProperty("Favicon"); + var isValid = image && !TW.IDE.isImageLinkUrl(image); + if (isValid) { + var imageUrl = "/Thingworx/MediaEntities/" + TW.encodeEntityName(image); + + // taken from https://stackoverflow.com/a/58947269 + var link = document.querySelector("link[rel*='icon']") || document.createElement('link'); + link.type = 'image/png'; + link.rel = 'shortcut icon'; + link.href = imageUrl; + document.getElementsByTagName('head')[0].appendChild(link); + } + } + + this.setDocumentTitle = function () { + var title = this.getProperty("Title"); + if (title) { + document.title = title; + } + } + + this.updateProperty = function (updatePropertyInfo) { + switch (updatePropertyInfo.TargetProperty) { + case 'Favicon': + this.setProperty('Favicon', updatePropertyInfo.SinglePropertyValue); + break; + case 'Title': + this.setProperty('Title', updatePropertyInfo.SinglePropertyValue); + break; + default: + TW.log.error('htmlheaderwidget_ds widget, unexpected property update received "' + updatePropertyInfo.TargetProperty + '"'); + } + }; + + this.serviceInvoked = function (serviceName) { + switch (serviceName) { + case 'SetFavicon': + this.updateFavicon(); + break; + case 'SetDocumentTitle': + this.setDocumentTitle(); + break; + default: + TW.log.error('htmlheaderwidget_ds widget, unexpected serviceName invoked "' + serviceName + '"'); + } + }; +}; \ No newline at end of file