タツノオトシゴのブログ

主にJavaに関するものです。

JavaFXでスプラッシュの表示

JavaFX

下記を参考にしました。

プレローダを利用する場合、JavaFX用にパッケージングする必要があるため、非常に面倒です。
Java標準の「-splash」オプションを使用すると手軽に実現できます。

スプラッシュを利用したJavaFXのApplicationのサンプル

Splash画像上にJava2Dを利用してメッセージなども表示できます。

AWTの「java.awt.SplashScreen」のメソッドで「#getSplashScreen()」でスプラッシュ画像の情報が取得できます。

  1. Application#init()メソッドの中で、SplashScreenのオブジェクトを取得します。
    • Java2Dなどで起動中のメッセージを書くこともできます。
  2. Application#start()メソッドの中で、Stageを表示する直前に、SplashScreen#close()でスラッシュ画像を非表示にします。
    • close()メソッドを呼ぶと、スプラッシュ画像のオブジェクトが廃棄されます。
package proj.green.srcgen.gui;

import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.SplashScreen;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.AnchorPane;
import javafx.stage.Stage;

/**
 * スプラッシュ画像のサンプル
 */
public class SampleApplication extends Application {
    
    /**
     * スプラッシュ
     * <p>起動時に「-splash:<画像ファイル>」を指定する。
     */
    private SplashScreen splashScreen;
    
    /**
     * Springの初期化
     */
    @Override
    public void init() throws Exception {
        
        // スプラッシュの更新
        splashScreen = SplashScreen.getSplashScreen();
        updateSplashMessage("... 初期化中です。");
        
        //TODO: Springのコンテナなどなどの初期化
    }
    
    /**
     * スプラッシュのメッセージを更新する。
     * <p>Java2Dを使用する。
     * @param message
     */
    private void updateSplashMessage(final String message) {
        if(splashScreen == null) {
            return;
        }
        
        // 文字を表示するボックスの位置
        final int x = 20;
        final int y = splashScreen.getSize().height - 60;
        
        final Graphics2D g = splashScreen.createGraphics();
        
        // 文字を表示する部分を塗りつぶす。
        // 前回の表示文字を消すためにも塗りつぶす。
        g.setColor(Color.WHITE);
        g.fillRect(x, y, splashScreen.getSize().width - x - 20, 30);
        
        // 文字を設定する
        g.setColor(Color.BLACK);
        g.setFont(new Font("SansSerif", Font.PLAIN, 15));
        g.drawString(message, x+10, y+20);
        
        splashScreen.update();
    }
    
    @Override
    public void start(final Stage primaryStage) throws IOException {
        
        updateSplashMessage("... 画面の初期化中です。");
        
        //TODO: ステージの組み立て
        
        // スプラッシュの非表示
        if(splashScreen != null) {
            splashScreen.close();
        }
        
        // ステージの表示をフォーカスを充てる
        primaryStage.show();
        primaryStage.requestFocus();
    }
    
    @Override
    public void stop() throws Exception {
        
        //TODO: Springのコンテナの終了
        
    }
    
    public static void main(String[] args) {
        launch(args);
    }
}

スプラッシュ画像の指定

javaの起動オプションに「-splash:<画像ファイルパス>」を指定します。
画像ファイルは、「JPEG、PNG、GIF」の３種類に対応しています。

ファイルパスは、システムパスで指定する必要があるので、バッチファイルからアプリケーションを起動する際には、
jarファイルのカレントディレクトリに移動して、相対パスで指定するなどしてください。

○ファイル構成

 ├ sample-app.jar  ## jarファイル本体
 ├ config          
      ├ splash.png ## スプラッシュ画像

@echo off

REM 起動用バッチファイルのサンプル

%~d0
cd %~p0

set MY_CLASSPATH=.;dependency/*;

%JAVA_HOME%\bin\java -cp %MY_CLASSPATH% -splash:config/splash.png sample.SampleApplication
MANIFEST.MFでの指定

【参考】
http://www.javainthebox.net/laboratory/JavaSE6/splash/splash.html

スプラッシュ画像は、起動オプション「-splash」の他に「MANIFEST.MF」に指定することもできます。

○mavenで指定する際には、「maven-jar-plugin」で指定します。

<!-- Splash画像のMANIFESTの指定サンプル -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <configuration>
        <archive>
            <manifest>
                <mainClass>sample.SampleApplication</mainClass>
            </manifest>
            <manifestEntries>
                <!-- 任意の項目・値が設定可能 -->
                <Splashscreen-Image>config/splash.png</Splashscreen-Image>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>


○JavaFXのパッケージング時に指定する際には専用のまたは、任意の項目を指定する形式で指定します。

<fx:info title="Sample application">
    <fx:splash href="http://my.site/custom.gif"/> 
</fx:info>