はじめに

JDK 10までは、JavaFXアプリケーションを配布する際に、ネイティブ・インストーラー形式にするjavapackager機能を使ってOS固有のインストーラーを作成することができました。Windowsネイティブなインストーラーを作成する際には、外部ツールとしてWiX Toolsetを使ってMSI形式のインストーラーを作成するか、同じく外部ツールとしてInnoSetupを使ってEXE形式のインストーラーを作成することができました。

しかし、JDK 11ではJavaFXとともにjavapackager機能が分離したため、JDK11上でのJavaFXアプリケーションは独自にインストーラーを作成することになります。

今回は、次のJavaFXアプリケーションをWindows OS上へインストールするMSI形式のインストーラーを作成していきます。

GitHub - torutk/AnalogClockGadget: JavaFX analog clock program to alternate for a desktop analog clock gadget

環境

WiX Toolsetの概要とインストール方法は、次のWikiページに記載しています。

http://www.torutk.com/projects/swe/wiki/WiX

JavaFXアプリケーションの実行イメージ作成

インストーラーを作成する前に、JavaFXアプリケーションの実行イメージをjlinkコマンドを使って作成しておきます。

D:\work\AnalogClockGadget> jlink ^
 --module-path"C:\Program Files\Java\JavaFX\javafx-jmods-11.0.1";build\modules ^
 --add-modules com.torutk.gadget.analogclock ^
 --launcher analogclock=com.torutk.gadget.analogclock/com.torutk.gadget.analogclock.AnalogClockApp ^
 --compress=2 --no-header-files --output runtime

D:\work\AnalogClockGadget> dir/w runtime
[.]       [..]      [bin]     [conf]    [legal]   [lib]     release

D:\work\AnalogClockGadget> 

• JavaFXライブラリ（JMODモジュールファイル）と、ビルドしたアプリケーション（モジュール）を--module-pathオプションで指定します。
• モジュール依存の基点となるJavaFXアプリケーション（モジュール）を--add-modulesオプションで指定します。
• JavaFXアプリケーション実行用スクリプト／バッチファイルを生成するため、--launcherオプションでモジュールとエントリポイントクラス名を指定します。ここではスクリプト／バッチファイルの名称をanalogclockとし、モジュール名／エントリポイントクラス名を指定します。
• 生成する実行イメージの大きさを小さくするため、--compressオプションでZIP圧縮（=2）を指定します。
• 実行イメージにはJNI用のC/C++ヘッダーファイルを含まないよう--no-header-filesオプションを指定します。

生成されたruntimeディレクトリのbin\analogclock.bat を実行し、アプリケーションが起動することを確認します。

インストーラーの作成（第一歩）

WiX Toolsetを使って、JavaFXアプリケーションのインストーラーを作成します。まずは、最低限の機能だけを持つインストーラーを作成します。

インストーラー作成では、WiXのXML文書を記述します。今回は、インストールする内容、インストール先ディレクトリを定義するAnalogClock.wxsファイルと、インストールするファイル群をheatコマンドで生成したruntime.wxsファイルを用意します。

WiX用XMLドキュメント（AnalogClock.wxs）

<?xml version="1.0" encoding="utf-8"?><Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"xmlns:util="http://schemas.microsoft.com/wix/UtilExtension"><Product Id="*"Name="Analog Clock"Language="1041"Codepage="932"Version="0.4.1"Manufacturer="High Bridge"UpgradeCode="fe287b25-e03d-4744-90f4-96b05dc36bf0"><Package Description="Analog Clock Gadget"Comments="(c) 2019 High Bridge"InstallerVersion="200"Compressed="yes"InstallScope="perMachine" /><MajorUpgrade DowngradeErrorMessage="既に新しい [ProductName]がインストールされています。"/><MediaTemplate EmbedCab="yes" /><Directory Id="TARGETDIR"Name="SourceDir"><Directory Id="ProgramFiles64Folder"><Directory Id="CompanyFolder"Name="High Bridge"><Directory Id="ApplicationFolder"Name="AnalogClock" /></Directory></Directory></Directory><Feature Id="Product"Title="Analog Clock"Level="1"><ComponentGroupRef Id="RuntimeGroup" /></Feature></Product></Wix>

Wix要素

WiXのXML文書構造は、最上位の要素がWixで、Wix要素の属性で名前空間を指定しています。

<?xml version="1.0" encoding="utf-8"?><Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
    :
</Wix>

Product要素

Wixの子要素にProduct要素を記述し、アプリケーション名などを定義します。

<Product Id="*"Name="Analog Clock"Language="1041"Codepage="932"Version="0.4.1"Manufacturer="High Bridge"UpgradeCode="fe287b25-e03d-4744-90f4-96b05dc36bf0">
    :
    </Product>

• Id属性にはGUIDを指定しますが、"*"を指定するとコンパイル時にGUIDが自動生成されます。インストーラーはこのGUIDが等しいと同じプログラムと認識します。新しいバージョンなどインストーラーを作り直した際はこのGUIDを変更する必要があります。
• Name属性にはアプリケーション名を定義します。
• Version属性にはアプリケーションのバージョン番号を定義します。通常ピリオドで区切った4つの数値を指定します。ただしMSIインストーラーはバージョンアップ判定時に4つ目の数字を無視することに留意が必要です。
• Language属性とCodepage属性には、インストーラーが使用するロケールと文字コードを定義します。日本語の場合は、Language属性に1041、Copdepage属性に932を指定します。
• Manufacturer属性には開発元の組織名または開発者名を定義します。
• UpgradeCode属性には同じアプリケーションで新しいバージョンを更新インストールする際の識別に使うGUIDを定義します。このGUIDは後々新しいバージョンのインストーラーを作成するときに継続して使用します。GUIDを生成する方法については、Windowsデスクトップ環境でUUID(GUID)を生成する方法 - torutkのブログや、 GUIDの生成に記載しています。

Package要素

Productの子要素にPackage要素を記述します。

<Package Description="Analog Clock Gadget"Comments="(c) 2019 High Bridge"InstallerVersion="200"Compressed="yes"InstallScope="perMachine"/>

• Description属性とComments属性は、プログラムの説明、コメントを記載します。インストーラーファイルのプロパティ（詳細）で説明に表示されます。
• InstallerVersion属性はMSIインストーラー（msiexec.exe）のバージョンを指定します。MSIのバージョンに2.0を指定する場合、"200"とします。現時点では4.5を指定（"405"）してもいいかと思います。MSI 4.5は、Windows Vista SP2、Windows Server 2008 SP2に標準搭載されています。
• InstallScope属性は、全てのユーザーが使用できるperMachineか、インストールしたユーザーだけが使用できるperUserかを指定します。
• Platform属性は、インストールするパッケージが64bit用であればx64を指定します。この属性でx64を指定すると、Component要素全てにWin64属性の指定が必要になります。そこで、64bitプログラムをインストールする場合は、この属性ではなく、candleコマンドの-archオプションでx64を指定します。

MajorUpgrade要素

新しいバージョンへ更新する仕組みを入れます。

<MajorUpgrade DowngradeErrorMessage="既に新しい [ProductName]がインストールされています。"/>

DowngradeErrorMessage属性には、既にインストールされたバージョンより古いバージョンをインストールしようとしたときにエラーメッセージとして表示する内容を定義します。

MediaTemplate要素

MSIファイルの中にCABファイルを含める場合に指定します（ふつう含めるので）。

<MediaTemplate EmbedCab="yes" />

Directory要素

インストーラーでインストールする先のディレクトリ構造を定義します。 今回は、次のディレクトリにインストールするものとします。

C:\
  +-- Program Filse
        +-- High Bridge
              +-- AnalogClock

このディレクトリ構造に対応するDirectory要素の定義は次となります。

<Directory Id="TARGETDIR"Name="SourceDir"><Directory Id="ProgramFiles64Folder"><Directory Id="CompanyFolder"Name="High Bridge"><Directory Id="ApplicationFolder"Name="AnalogClock" /></Directory></Directory></Directory>

• ルートディレクトリ（ドライブ）は、Id属性にTARGETDIRを指定します。
• 64bitアプリがインストールされるシステム共通のディレクトリは C:\Program Files ですが、これは事前定義名ProgramFiles64FolderをId属性に指定します。
• C:\Program Filesの下に作成するディレクトリを指定します。

Feature要素

<Feature Id="Product"Title="Analog Clock"Level="1"><ComponentGroupRef Id="RuntimeGroup" /></Feature>

Feature要素ではインストールする内容を定義します。今回は、インストールするファイル群をWiX Toolsetのheatコマンドで自動生成させるので、heatコマンドで作成するComponentGroupのIdを、ComponentGroupRefで参照する記述とします。なお、ComponentGroupのIdはheatコマンドのオプションで指定します。

WiX Toolsetコマンドの実行

heatコマンドでruntimeディレクトリ以下のファイル群から定義作成

D:\work\AnalogClockGadget> heat dir runtime ^
 -sdr -dr ApplicationFolder ^
 -cg RuntimeGroup ^
 -gg -g1 ^
 -sfrag -sreg ^
 -var "var.runtimeFolder" -o runtime.wxs

• 第1引数で収集対象をディレクトリ（dir）と指定します。
• -srdオプションでルートディレクトリ（ここではdirオプションに続けて指定したruntimeディレクトリ）に対応するディレクトリの生成を抑制します。このオプションを指定しないと、インストール先ディレクトリ（C:\Program Files\High Bridge\AnalogClock）の下にruntimeディレクトリが作成され、その下にbinディレクトリ等が配置されます。 -drオプションで、インストール先ディレクトリのIdを指定します。今回はAnalogClock.wxs でAnalogClockプログラムをインストールするディレクトリとして定義したDirectory要素のIdに指定したApplicationFolderを指定しています。
• -cgオプションで、生成するComonentGroupのIdを指定します。このIdは、AnalogClock.wxsのFeature要素の子要素ComponentGroupRefで参照されるので一致させる必要があります。
• -ggオプションで各ComponentのGUIDを生成するよう指定します。
• -ggオプションでGUIDを生成する際、波括弧を省略するよう指定します。
• -sfragオプションでFragment要素をComponent要素毎ではなく、ComponentGroup要素に１つ生成するよう指定します。
• -sregオプションで、DLLファイルに対するレジストリ情報収集（COMのDLLで必要）を抑制するよう指定します。64bit DLLのときにHEAT5150警告が出るのを抑制します。
• -varオプションで、File要素のSource属性で指定するパスの基点となるフォルダを、変数として生成するよう指定します。このオプションを指定しないと、SourceDirという固定文字列がパスの基点となり、存在しないので後のlightコマンド実行時にエラーとなります。
• -oオプションでディレクトリ以下のファイル群を収集した情報を吐き出すWiXファイル名を指定します。

candleコマンド

WiX文書ファイルをcandleコマンドでコンパイルし、wixobjファイル（中間ファイル）を生成します。

D:\work\AnalogClockGadget> candle -arch x64 package\windows\AnalogClock.wxs

D:\work\AnalogClockGadget> candle -arch x64 -druntimeFolder=runtime runtime.wxs

• 64bitバイナリをインストールする場合は、-archオプションでx64を指定します。
• -dオプションで、heatコマンドで、File要素のSource属性でファイルパスの基点を変数として生成した箇所に実際のパスを設定します。

実行結果、AnalogClock.wixobj と runtime.wixobjファイルが生成されます。

lightコマンド

Wix中間ファイルであるwixobjファイルから、lightコマンドでインストーラーファイルに生成します。

D:\work\AnalogClockGadget> light AnalogClock.wixobj runtime.wixobj -o analogclock.msi

• 引数に、candleコマンドで生成したwixobjファイル（中間ファイル）をすべて指定します。
• -oオプションで作成するMSI形式インストーラーのファイル名を指定します。

実行結果、analogclock.msiファイルが生成されます。ちなみに、ファイルサイズは38MBでした。

インストール

この第一歩のインストーラーは、必要最小限の機能しか設定していないので、インストーラーを実行すると対話（ダイアログ）画面もなく、所定のディレクトリにインストールするだけとなります。スタートメニューやデスクトップへのショートカット登録もありません。

analogclock.msiを実行すると、次のように経過を表示する画面が出てすぐに終了します。

プログラムを実行するには、インストール先のC:\Program Files\High Bridge\AnalogClock\bin\analogclock.batを実行します。

Windows 10 October 2018 Update（1809）を適用する

自宅PCの1台（デスクトップPC）はWindows 10 OSですが、なかなか バージョン1809のアップデートが来ません。設定から更新とセキュリティでWindows Updateを手動で実行しても1809は出てきませんでした。

このPCにブロックとなるハードウェアやソフトウェアはないはずなのですが・・・。

そこで、手動でアップデートを実行すべく、Windows 10 のダウンロードページから[今すぐアップデート]でアップデートツールをダウンロードし実行してみました。

すると、1809のダウンロードが終わり、再起動された後も1803のままで、1809になりませんでした。再起動は通常何回か繰り返されるのですが、今回は1回だけで、OSの更新が走っていませんでした。

類似現象がないか調べていくと、次のブログに類似現象が書かれていました。

win.just4fun.bizこのPCもVisual Studioをインストールしているので、このブログの処置に倣ってWindows開発者モードを外して再度アップデートツールを実行したところ、今度は無事に更新が開始されました。

次は、再起動後の更新が82%でちっとも進まなくなりました。1時間経過しても、2時間経過しても82%のままです。ディスクアクセスランプは時折ちかっと光ります。しかし、過去にWindows 8.1から10にアップデートしたときも確か数時間かかっていたことを思い出し、ここは我慢で待つことにします。買い物に出かけて戻ってきたら、更新が終わっていました。4時間ほどかかったことになります。

ということで、

• Visual Studioをインストールし、Windows開発者モードが有効になっていると、October 2018 Update（1809）に更新ができない。
• 1809への更新時、途中でずっと止まったような状況になっても、2時間程度であきらめずに待つ。

が肝要でした。

しかし、うちにあるノートPC（Visual Studioは入っていない）も、October 2018 Updateが未だに来ていません。

こっちは、Intel CPUでCPU内蔵のグラフィックスの構成です。この場合、IntelのHD Graphicsドライバーが適用されるのですが、これがブロックに該当している可能性が高いようです。

ただ、最新のHD Graphicsドライバーに更新しようとしても、ノートPCメーカーからドライバーを入手せよとエラーメッセージが表示されて更新できません。ノートPCメーカーのサイトには現在使用中のドライバより新しいものは用意されていません。

こちらは引き続き調査していきます。

ネットワークドライブ上のファイルをUAC昇格ありの場所へコピーしようとしたらエラー

ファイルエクスプローラーで、ネットワークドライブ上のファイルを、UAC昇格が発生するC:\Program Files下のディレクトリへコピーしようとしたら、

「H:\ は利用できません。・・・（中略）。ネットワーク上の場所を指している場合は、ネットワークやインターネットに接続されているかどうかを確認してから・・・（後略）」

とエラーメッセージが表示されます。ネットワークドライブ上のコピー対象ファイルは見える状態です。

これは、UAC昇格前のユーザーではネットワークドライブがマップされていますが、UACで昇格後の管理者ではネットワークドライブがマップされていないために発生しているようです。

具体的に理解するため、コマンドプロンプトをふつうに（管理者権限ではなく）立ち上げ、net useコマンドでネットワークドライブの接続状況を表示させます。

C:\Users\torutk> net use
新しい接続は記憶されます。
ステータス    ローカル名    リモート名                  ネットワーク名
-------------------------------------------------------------------------------
OK            H:            \\fileserver\sharefolder    MicrosoftWindows Network

コマンドは正常に終了しました。

次に、コマンドプロンプトを管理者権限で立ち上げ、net useコマンドでネットワークドライブの接続状況を表示させます。

C:\WINDOWS\system32>net use
新しい接続は記憶されます。

一覧にエントリが存在しません。

このため、ファイルエクスプローラーでネットワークドライブにあるファイルをローカルの管理者権限が必要なフォルダにコピーしようとし、UAC昇格が行われると、ネットワークドライブが見えなくなってしまい、そのファイルが参照できなくなってしまいます。

対処の1つは、ファイルコピー時はネットワークドライブをドライブレター付きのパスでアクセスするのではなく、UNC形式でアクセスします。

別な方法の1つは、昇格した管理者アカウントでも同じドライブ名で同じネットワークドライブに接続するよう設定しておきます。

お題

Windows 7は、新機能の追加およびセキュリティ以外の修正を行うメインストリームサポートが2015年1月に終了しています。そして、セキュリティ修正を行う延長サポートは2020年1月に終了の予定です。

何らかの理由によりWindows 7でないと動作しない機能を使うために、これから新たにWindows 7を載せたPCを調達しなくてはならないとします。その理由とは、例えば、独自のPCI（PCI Express）カードを開発してPCに組み込んで使用している場合で、そのカードのドライバーソフトウェアがWindows 10に対応しておらず、直ちに対応することができない等です。

Windows 7の販売終了日

Microsoftのサイトによると、Windows 7（Professional版）の販売終了は、製品版ソフトウェアが2013年10月、Windowsプレインストール済みPCの販売終了が2016年10月とあります。

https://support.microsoft.com/ja-jp/help/13853/windows-lifecycle-fact-sheet

各PCメーカーのWindowsプレインストールマシン販売状況

日本HP

日本HPの「Windows 7 Professionalプリインストールモデル販売継続予定のご案内（2017年12月版）」によると

マイクロソフトは、「Windows 10 Proからのダウングレード権を行使したWindows 7 ProfessionalもしくはWindows 8.1 Proプリインストールモデル」のPCメーカーからの出荷期限を2018年10月31日までとしています。

とあり、受注期限が、HP ProDesk/HP EliteDeskは2018年9月末まで、ZシリーズはZ240が2018年7月末までと既に終了しています。

http://jp.ext.hp.com/partners/reseller/partnernews/pdfs/ws7preinstall201712.pdf

その他

Dell、富士通、Panasonic、NEC、エプソンとざっとWebで見た限りでは、Windows 7をプレインストールしたマシンを販売してはいませんでした。

ダウングレード権の行使によるWindows 7の利用

Windows 10 Pro搭載マシンを購入し、ダウングレード権の行使によってWindows 7 Professionalを入れる場合は、次を入手し、自身でWindows 7を新規にインストールする必要があります。

• Windows 7 Professionalのインストールメディアの入手
• Windows 7用ドライバの入手

ただし、現時点でWindows 7 Professionalのインストールメディアを入手することには制約があります。Windows 7が既に販売終了しているので、Microsoftボリュームライセンス（少量ならOpen License？）でWindows 10 Proのライセンスを購入し、Windows 7のメディアをダウンロードするといった手段が必要になりそうです。この場合、購入したPCのOEMライセンスのWindows 10 Proとダブってしまい無駄な費用が発生してしまいます。

また、最新のパーツはWindows 7が対応できないものがあるので、購入する機種はWindows 7に対応可能なパーツで構成されている必要があります。

• Intel CPUは、第7世代（Kaby Lake）以降はWindows 10にのみ対応（動作はするが、Windows Updateがブロックされる模様）
• AMD CPUは、Ryzen以降は対応せず

ダウングレード権によるWindows 7の利用期限

Microsoftのサイトによると、

7.ダウングレード権。お客様は、製造業者またはインストール業者から Windowsの Professional バージョンがプレインストールされているデバイスを取得した場合、Windows 8.1 Pro または Windows 7 Professional バージョンを使用できますが、マイクロソフトが、(aka.ms/windowslifecycle) に規定されているとおり、かかる旧バージョンのサポートを提供している期間に限ります。

とあります。Windows 7のサポート期間は2020年1月に終了するので、この規定によるとWindows 7 ProfessionalがプレインストールされたPCを購入した場合、Windows 7 Professionalに使用は2020年1月までとなるように解釈できます。

https://www.microsoft.com/en-us/Useterms/OEM/Windows/10/UseTerms_OEM_Windows_10_Japanese.htm

NECのサイトでは、

Windows 10 Pro のダウングレード権により、Windows 7 Professional または Windows 8.1 Pro がプレインストールされたデバイスを利用の場合、Windows 7 Professional, Windows 8.1 Pro のサポートを提供している期間に限り利用が認められます。サポート期間が終了後は、デバイスにライセンスされている Windows 10 Pro に置き換えてご利用いただくことが必要となります。サポート期間終了後に引き続き Windows 7 Professional, Windows 8.1 Pro をご利用希望される際には、Microsoftボリュームライセンスを通じて、ライセンスを別途取得いただく必要がございます。

との記載があり、ライセンスを別途取得（どのライセンスなのかは明記なし）する必要があるようです。

Windows 10 Proダウングレード権のご案内 ：サポート情報: ビジネスPC | NEC

Windows Embedded Standard 7の寿命

Windows Embedded Standard 7は、メインストリームサポートが2015年10月に終了しており、延長サポートは2020年10月に終了の予定です。

Java読書会BOFは、6月から新しい書籍「Java 11 and 12 - New Features」（洋書）を読み始めます。

Java SE 9が2017年9月にリリース後、この2019年5月末時点までに、Java SE 10（2018年3月）、Java SE 11（2018年9月）、Java SE 12（2019年3月）とリリースされ、Java SE 11については、長期間サポート版（LTS: Long Term Support）となっています。

ところが、この2年内のJavaのアップデートについてしっかり書かれた日本語書籍はほとんどなく、洋書で勉強するとなった次第です。

Java読書会BOFでは、過去洋書を扱ったときは事前に分担を決め日本語訳をして、それを当日配布して日本語訳を朗読するという方法を取ってきました。
これは、精読できるのですが事前の準備負担が大きいので対応し難くなっています。今回は、事前訳はせずにその場で粗い日本語で朗読を進めようかと思っています。

さて、今回の書籍の章題を列挙すると次になります。

• 型推論（Type Inference）
• アプリケーション・クラス・データ共有（Application Class-Data Sharing: AppCDC）
• ガーベージコレクター最適化（Garbage Collector Optimizations）
• JDK 10の細々な改善（Miscellaneous Improvements in JDK 10）
• ラムダ式の引数のローカル変数文法（Local Variable Syntax for Lambda Parameters）
• イプシロンGC（Epsilon GC）
• HTTPクライアントAPI（The HTTP Client API）
• ZGC
• フライトレコーダーとミッションコントロール（Flight Recorder and Mission Control）
• JDK 11の細々な改善（Miscellaneous Improvements in JDK 11）
• switch式（Switch Expressions）
• JDK 12の細々な改善（Miscellaneous Improvements in JDK 12）
• プロジェクトAmberにおける列挙型の改善（Enhanced Enums in Project Amber）
• データクラスとその使用（Data Classes and Their Usage）
• 生文字列リテラル（Raw String Literals）
• ラムダの食べ残し（Lambda Leftovers）
• パターンマッチング（Pattern Matching）

JDKの新しい機能としてちらっと見聞きしたことのある、でも良くわからない機能が並んでいます。
今回の読書会を通じて、これらの新機能について一定の理解をしておくことができるのはなかなかに期待度が高いです。

今月のJava読書会は、6月15日（土）に川崎駅近くで開催します。

Javaプログラムに初期設定を外部から渡す方法として、プログラム起動時のコマンドラインオプション、設定ファイル、システムプロパティ、リソースバンドル、プリファレンスAPI（java.util.pref）辺りが候補に挙がります。
今回、PCからシリアル通信でセンサー機器と通信し、センサー機器の状態をGUIで表示するスタンドアロンプログラムを作成しています。プログラムの構造は、GUIに纏わる部分、シリアル通信に纏わる部分とを疎結合しています。ここで、疎結合ゆえにプログラムの初期設定をどのように渡すかを悩むこととなりました。

GUIでユーザーが入力した値が範囲外などのエラー時に、エラーとなった箇所が分かるよう色を変える方法を模索しました。今回はTextFieldを題材とします。

.text-field:error {
    -fx-text-box-border: red;
    -fx-focus-color: red;
}

@FXMLprivate TextField myTextField;
    private PseudoClass errorClass = PseudoClass.getPseudoClass("error");
    :
    void handleSubmit(ActionEvent event) {
        if (! validateInput()) {
            myTextField.pseudoClassStateChanged(errorClass, true);
        } else {
            myTextField.pseudoClassStateChanged(errorClass, false);
        }
        :
    }

はじめに（お題）

電気信号を時間領域から周波数領域に変換し、周波数に対するエネルギー量を解析できる測定器にスペクトラム・アナライザがあります。今回、このスペクトラム・アナライザで解析した結果をファイルに保存し、別な場所にあるPC上でその結果を表示、分析したいとします。

計測器にCSVファイルで結果を保存する機能があればこれをExcelで読み込ませてグラフ化することは容易ですが、今回の計測器はバイナリデータのファイルに保存するものでした。そこで、JavaFXで保存したバイナリデータのファイルを読み込み折れ線グラフ（LineChart）で表示するプログラムを作成してみます。

LineChart

JavaFXのプロジェクトを作成し、折れ線グラフ（LineChart）を表示する画面をScene Builderで作成しました。 ファイル構成は次です。

デフォルトのLineChart

Scene BuilderでLineChartを画面にポトペタすると次の表示となります。

縦軸は数値メモリとなっていますが、横軸は表示されていません。Scene Builderの左下ペインを見ると、LineChartの子ノードとしてNumberAxisとCategoryAxisが1つずつ置かれています。縦軸がNumberAxisで、横軸がCategoryAxisです。NumberAxisは名前の通り数値の軸を表し、CategoryAxisは何らかの分類（県名、年別、チーム別、など）の軸を表します。

Scene Builder上では、LineChartの子ノードの軸を変更する方法が見つからなかったので、FXMLファイルを直接エディタで開き修正しました。

<LineChart BorderPane.alignment="CENTER">
        <xAxis>
-         <CategoryAxis side="BOTTOM" />+         <NumberAxis side="BOTTOM" /></xAxis>
        <yAxis>
          <NumberAxis side="LEFT" />
        </yAxis>
      </LineChart>

横軸がNumberAxisに変更されました。

最初のコード

SimpleSpectrumApp.java

package sample;

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.stage.Stage;

publicclass SimpleSpectrumApp extends Application {
    @Overridepublicvoid start(Stage primaryStage) throws Exception {
        Parent root = FXMLLoader.load(getClass().getResource("SimpleSpectrumView.fxml"));
        primaryStage.setTitle("Simple Spectrum");
        primaryStage.setScene(new Scene(root));
        primaryStage.show();
    }

    publicstaticvoid main(String[] args) {
        launch(args);
    }
}

JavaFXの典型的なApplication派生クラスの実装です。mainメソッドでプロセスのエントリを用意し、startメソッドでFXMLファイルを読み込みシーングラフを作成、Stageを表示させています。

SimpleSpectrumView.fxml

<?xml version="1.0" encoding="UTF-8"?><?import javafx.scene.chart.LineChart?><?import javafx.scene.chart.NumberAxis?><?import javafx.scene.layout.BorderPane?><BorderPane maxHeight="-Infinity"maxWidth="-Infinity"minHeight="-Infinity"minWidth="-Infinity"prefHeight="400.0"prefWidth="600.0"xmlns="http://javafx.com/javafx/11.0.1"xmlns:fx="http://javafx.com/fxml/1"fx:controller="sample.SimpleSpectrumViewController"><center><LineChart fx:id="chart"BorderPane.alignment="CENTER"><xAxis><NumberAxis side="BOTTOM"fx:id="xAxis" /></xAxis><yAxis><NumberAxis fx:id="yAxis"side="LEFT" /></yAxis></LineChart></center></BorderPane>

Scene Builderでポトペタ作成したFXMLファイルで、ビュー（画面）を定義しています。 コントローラークラスを指定しているので、このFXMLがロードされると自動でコントローラークラスのインスタンスが生成されます。

SimpleSpectrumViewController.java

package sample;

import javafx.fxml.FXML;
import javafx.fxml.Initializable;
import javafx.scene.chart.LineChart;
import javafx.scene.chart.NumberAxis;

import java.net.URL;
import java.util.ResourceBundle;

publicclass SimpleSpectrumViewController implements Initializable {
    @FXML
    LineChart chart;
    @FXML
    NumberAxis xAxis;
    @FXML
    NumberAxis yAxis;

    SimpleSpectrumViewModel model = SimpleSpectrumViewModel.ofRandom();

    @Overridepublicvoid initialize(URL location, ResourceBundle resources) {
        chart.getData().setAll(model.getSeriesList());
    }
}

FXMLに対応するコントローラークラスです。 コントローラーから操作するビュー部品（コントロール）は、@FXMLアノテーションを指定し、FXML側で指定したfx:idの識別子と同じ名前の変数名とすることで、FXMLロード時にインスタンスがインジェクションされます。

データについては、今回はデータファイルの読み込み部分が未実装なので、ランダムな値を表示するモデルを使います。

SimpleSpectrumViewModel.java

package sample;

import javafx.scene.chart.XYChart;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ThreadLocalRandom;

publicclass SimpleSpectrumViewModel {

    private List<XYChart.Series<Double, Double>> seriesList = new ArrayList<>();

    public List<XYChart.Series<Double, Double>> getSeriesList() {
        return Collections.unmodifiableList(seriesList);
    }

    publicstatic SimpleSpectrumViewModel ofRandom() {
        var model = new SimpleSpectrumViewModel();
        model.seriesList.add(createRandomSeries("Random"));
        return model;
    }

    privatestatic XYChart.Series<Double, Double> createRandomSeries(String name) {
        XYChart.Series<Double, Double> series = new XYChart.Series<>();
        series.setName(name);
        for (double x = 950d; x <= 1450d; x++) {
            series.getData().add(new XYChart.Data<Double, Double>(
                    x, ThreadLocalRandom.current().nextGaussian() * 5.0 - 60.0));
        }
        return series;
    }
    
}

JavaFXではモデルクラスについては特にフレームワークが用意されていませんが、コントローラーを軽くするために、ちょっとしたロジックであってもモデルクラスを設けるようにしています。

表示確認のために、データファイルを読み込む前にランダムなスペクトルを表示するモデルを作りました。

JavaFXの折れ線グラフ（LineChart）に表示する1本の連続する線は、データ系列(XYChart.Series）で定義し、複数のデータ系列を表示することができます。 データ系列は、複数の点データ（XYChart.Data）のリストとして作られています。 今回は、1つのデータ系列を用意しています。 用意するデータは、周波数軸（X軸）の950～1450までの間を1刻みで作成し、縦軸の電力は正規分布乱数で平均-60.0、分散5.0としています。

表示

プログラムを実行すると、次の画面が表示されました。

いろいろ改善したい点があります。

• 縦軸、横軸に名称・単位を表示したい
• 〇の表示（シンボル）は不要としたい
• 折れ線を細くしたい
• 縦軸、横軸の表示範囲を指定したい

LineChartの設定

縦軸、横軸に名称を表示

これは、Scene Builderで、軸のLabelプロパティに文字列を設定すれば表示できます。

縦軸、横軸の表示範囲を指定

縦軸は、-30.0～-80.0の範囲を表示し、横軸は950～1450の範囲を表示します。 表示すべきデータを読み込んだ際にデータに応じた値を設定するので、コードで制御します。

前回からのコード変更部分を次に記載します。

    @Override
    public void initialize(URL location, ResourceBundle resources) {
+       xAxis.setLowerBound(950d);+       xAxis.setUpperBound(1450d);+       yAxis.setLowerBound(-80d);+       yAxis.setUpperBound(-30d);
        chart.getData().setAll(model.getSeriesList());
    }

NumberAxisには、表示する軸の値の上限値・下限値を指定するlowerBound、upperBoundがあります。 ここに表示する軸の数値範囲を指定します。この上下限値設定は、LineChartにデータ（XYChart.Series）を登録する前に実行する必要があります。あとから実行したら表示には反映されません。

ただし、これだけでは意図したとおりの動作をしません。NumberAxisのAutoRangingプロパティが有効だと、登録したデータの値に応じた軸の数値範囲に自動調整が働いてしまいます。今回はScene Builder上でAutoRangingプロパティを無効にします（次の図参照）。

プログラムを実行すると、次の様に意図した数値範囲でグラフが表示されました。

• グラフの罫線間隔については、NumberAxisのTickUnitプロパティで制御可能です。

〇の表示（シンボル）をなくす

デフォルトでは、折れ線グラフの点データに丸いシンボルが表示されます。 データ数が少ないときは、データとデータを補完する線とを明確に表現するこの表示が適していますが、データ数が多いときは上図のようにシンボルだらけで肝心の折れ線が見えなくなってしまいます。

シンボルをなくすのであれば、LineChartのCreateSymbolプロパティを無効にします（次の図参照）。

プログラムを実行すると、次のとおり丸いシンボルが表示されなくなりました。

• シンボルを消すのではなく、シンボルの形状を変更したいときは、CSSでセレクターに.chart-line-symbolを指定し見栄えを記述します。

折れ線を細く

デフォルトでは、折れ線の幅がちょっと太いので、これを細くします。形状の変更はCSSで記述します。 セレクターに.chart-series-lineを指定し見栄えを記述します。

.chart-series-line{
    -fx-stroke-width: 0.75px;
}

CSSファイルは、アプリケーション派生クラスでSceneに設定するか、FXMLで最上位要素に指定するかの方法があります。今回は、FXML（Scene Builder）上で最上位要素のBorderPaneにCSSファイルを設定します。CSSファイルはFXMLファイルと同じ場所に置き、BorderPaneのStylesheetsプロパティに指定します（次の図参照）。

プログラムを実行すると、次のとおり折れ線が細くなりました。

はじめに

先週書いた次のブログの続編です。 torutk.hatenablog.jp

一つのグラフ表示領域に、複数のグラフ（Series）を重畳表示した際に、簡単な操作でそれぞれのグラフを非表示にしたり表示したりとできると使い勝手が向上します。

グラフに凡例を表示した場合、それぞれの凡例をクリックするとその凡例に対応するグラフを表示する、非表示すると切り替えられるようにします。

課題

凡例全体のNodeは、Legendクラス（com.sun.javafx.chart.Legend）で実装されています。しかし、このcom.sun.javafx.chartパッケージは、アプリケーション側のモジュールには公開されていません。

ぐぐって検索した情報は、子ノードを辿ってLegendクラスかどうか判別してLegendを見つけ、Legendにキャストしてそのitemを取得して利用するもので、Java SE 9以降では使えません（--add-exportsオプション指定でコンパイルすれば可能）。

各凡例を表示するNodeを取得する方法

それぞれの凡例は、CSSでセレクタ .chart-legend-item が指定されています。JavaFXのAPIには、セレクタを指定してNodeを取得する機能（lookupおよびlookupAll）が提供されているので、これを使って凡例のNodeを取得します。

@FXML
LineChart<Float, Float> spectrumChart;
:
Set<Node> legendItems = spectrumChart.lookupAll(".chart-legend-item");

それぞれの凡例にマウスハンドラーを設定するには例えば次のようにします。

legendItems.forEach(item -> item.setOnMouseClicked(event -> System.out.println(event + " clicked")));

各凡例をクリックしたら対応するグラフを表示／非表示する

クリックされた凡例のNodeにマウスハンドラーを設定することはできましたが、次はそこから対応するグラフを取得して、その表示を切り替える方法を考えなくてはなりません。

それぞれの凡例はLabelクラスのインスタンスで、ラベルに表示されるテキストはグラフ（Series）のnameプロパティとなっています。

そこで、取得したそれぞれの凡例をLabel型にキャストしてラベルに表示されるテキストを取得し（getTextメソッド）、次にそのテキストを名前として持つSeriesをLineChartから探して取得します。

Labelにキャストしてテキストを取り出す

legendItems.forEach(item -> item.setOnMouseClicked(event -> {
    if (item instanceof Label) {
        String name = ((Label) item).getText();
    }
}));

Label型へのキャストが可能な場合に、Labelへキャストし、getTextメソッドでラベルに表示されるテキストを取得します。

チャート（LineChart）に登録されているSeriesからテキストと同じ名前のものを取り出す

legendItems.forEach(item -> item.setOnMouseClicked(event -> {
    if (item instanceof Label) {
        String name = ((Label) item).getText();
        Optional<XYChart.Series<Float, Float>> any = spectrumChart.getData().stream()
                .filter(series -> series.getName().equals(name))
                .findAny();
    }
}));

chartのdataプロパティには表示するグラフ（Series）がリストで登録されています。これを順次アクセスしSeriesのnameプロパティが凡例ラベルのテキストと一致するものを取り出します。

クリックした凡例に一致するグラフ（Series）の表示／非表示を切り替える

legendItems.forEach(item -> item.setOnMouseClicked(event -> {
    if (item instanceof Label) {
        String name = ((Label) item).getText();
        Optional<XYChart.Series<Float, Float>> any = spectrumChart.getData().stream()
                .filter(series -> series.getName().equals(name))
                .findAny();
        any.ifPresent(series -> {
            boolean currentVisible = series.getNode().isVisible();
            series.getNode().setVisible(!currentVisible);
        });
    }
}));

取り出したグラフ（Series）のgetNodeメソッドで画面に表示されるグラフのNodeを取得し、その表示状態をisVisibleで取得します。そして、その真偽を反転させてsetVisibleに指定し、表示／非表示を反転させます。

グラフが非表示のときは凡例の表示を薄くしたい

実現方法を悩みましたが、CSSの疑似クラスを使って非表示の際に薄く（透過度を変えて）表示させることにしました。

まず、CSSで、.labelに疑似クラス haze を記述します。

.label:haze {
    -fx-opacity: 0.2;
}

次に、凡例ラベルのマウスハンドラー内でグラフ（Series）の表示／非表示切り替えに合わせて疑似クラスの有効・無効を凡例ラベルに設定します。

privatestaticfinal PseudoClass HAZE_PSEUDO_CLASS = PseudoClass.getPseudoClass("haze");
    :
legendItems.forEach(item -> item.setOnMouseClicked(event -> {
    if (item instanceof Label) {
        String name = ((Label) item).getText();
        Optional<XYChart.Series<Float, Float>> any = spectrumChart.getData().stream()
                .filter(series -> series.getName().equals(name))
                .findAny();
        any.ifPresent(series -> {
            boolean toBeInvisible = series.getNode().isVisible();
            series.getNode().setVisible(!toBeInvisible);
            item.pseudoClassStateChanged(HAZE_PSEUDO_CLASS, toBeInvisible);
        });
    }
}));

はじめに

前回のブログの続きです。 torutk.hatenablog.jp

画面の国際化対応で日本語プロパティを追加してみました。その際使用される日本語のフォントはJavaのコードやCSSでコントロール毎に指定可能ですが、全体を変更することも可能です。

CSSのrootセレクタに-fx-font-familyでフォントを指定します。 ここで、どのようなフォントファミリ名を指定できるか、OpenJDK 11で試してみました。

CSSの記述例

JavaFXのCSSファイルを作成、.rootセレクタに-fx-font-familyでフォント名を指定します。

.root{
    -fx-font-family: "Meiryo";
}

当初いろいろググってみたところ、「外部フォント」の指定には、@font-faceでフォントファイルのURLを記述、なおTTFファイルは有効でTTCファイルは指定できないといった記述をみかけました。 しかし、Windows OS上でOpenJDK 11をにおいては、@font-faceを指定しなくてもWindows OSのフォントとしてインストールされているフォントの指定が可能でした。

動作確認（画面キャプチャ）環境

Scene Builderで画面を作成している場合、Scene Builderの[プレビュー]メニュー > [Sceneスタイルシート] > [スタイルシートの追加] でCSSファイルを指定します。 すると、Scene Builder上のデザイン画面、およびプレビュー画面は指定したCSSファイルの設定が反映されます。 また、CSSファイルを変更すると自動で変更を反映してくれます。ですので、CSSでの見栄え設定であれば、アプリケーションを再ビルド・実行することなくScene Builder上で確認できるのでとっても楽に確認ができました。

CSSファイルでのフォント指定とその画面

では、実際にCSSファイルのrootセレクタにフォントファミリを指定して表示を確認していきます。

まずはデフォルト（指定なし）の日本語フォント

まずは、何もフォントファミリを指定しなかった場合の日本語フォントです。最初は、OpenJDKのfontconfig.propertiesで定義されるMSゴシックが使われると思っていました。しかし実行してみるとアンチエイリアスが効いたフォントが表示されました。

デバッグプリントでコントロール（Label）のフォントを調べてみると、次のようになっていました。

Font[name=System Regular, family=System, style=Regular, size=12.0]

これは、javafx.scene.text.FontクラスのgetDefaultメソッドが返すフォントで、JavaFXのAPIドキュメント（JavaFX 8 日本語APIドキュメント）には次の記述があります。

デフォルト・フォントのファミリはSystem、スタイルは通常はRegularとなり、サイズについては、判断可能な範囲においてユーザーのデスクトップ環境と一致するものが取得されます。

Windows 10 日本語版では、デスクトップのシステムフォントが「游ゴシック」となっているので、デフォルトで表示されるフォントが游ゴシックとなっています。 Windows 7日本語版であれば、おそらくMSゴシックではないかと思われます。

フォントファミリにMS Gothicを指定

CSSファイルに以下を記述します。

.root{
    -fx-font-family: "MS Gothic";
}

表示は次の様になります。お馴染みのギザギザフォントですね。

フォントファミリ名は、英語で記述しました。日本語で「MS　ゴシック」等と記述した場合は設定が反映されず、デフォルトフォントで表示されました。

フォントファミリにMeiryoを指定

.root{
    -fx-font-family: "Meiryo";
}

フォントファミリにMeiryo UIを指定

.root{
    -fx-font-family: "Meiryo UI";
}

フォントファミリにYu Minchoを指定

.root{
    -fx-font-family: "Yu Mincho";
}

フォントファミリにYu Mincho Demiboldを指定

.root{
    -fx-font-family: "Yu Mincho Demibold";
}

フォントファミリにHGMinchoEを指定（HG明朝E）

.root{
    -fx-font-family: "HGMinchoE";
}