SplashScreen (クラス)
public final SplashScreen
パッケージ： CURL.ENGINE.BROWSER

アプレットがロード中に使用するスプラッシュスクリーンを提供します。

注意事項

アプレット毎に、1つのスプラッシュスクリーンだけが存在できます。
スプラッシュスクリーンオブジェクトを初期化する為には、SplashScreen.setupを呼び出します。使い終わったら、SplashScreen.destroyを呼び出さなければなりません。破棄されると、スプラッシュスクリーン オブジェクトは、SplashScreen.setup を呼び出す事によって再初期化することが出来ます。
SplashScreenのUIは、サブアプレットの中にあります。これと連携する為に、SplashScreenは、SplashScreen.send-messageプロシージャを使用します。
スプラッシュスクリーンの見映えをカスタマイズすることが出来ます。SplashScreenSubApplet.create-main-bodyをご覧ください。

例

以下のコードはスプラッシュスクリーンの使用例です。

例
{import * from CURL.ENGINE.BROWSER}

{CommandButton
    label = "カスタム スプラッシュ",
    {on Action do
        {SplashScreen.setup
            title = "Loading Applet ...",
            footer = "Test Example ..."
        }
        || indeterminateなプログレスバーを表示します。
        {SplashScreen.set-progress-bar-indeterminate}
        || 作業が終わるまで2秒必要と仮定しています。
        {sleep 2s}
        {SplashScreen.set-progress-bar  max = 10.0}
        {sleep 1s}
        
        || ループに入り、ループの中でスリープし、
        || なんらかの作業をしているような状態にします。
        let val:double = 0
        {for i = 0 below 50 do
            set val = val + 0.2
            {SplashScreen.set-progress-bar-value val}    
            {sleep 0.1s}
        }
        || 完了したので、スプラッシュスクリーンを破棄します。
        {SplashScreen.destroy}
    }
}

ライセンス

splash-applet-url を指定した場合、このプロシージャは、Curl/Pro サーバー・ライセンス を持っているアプレットだけ使うことが出来ます。
導入: バージョン 7.0

クラス プロシージャ
destroy:スプラッシュスクリーンUIを非表示にし、destroyします。
public {SplashScreen.destroy}:void
send-message:スプラッシュスクリーン サブアプレットに非同期メッセージを送ります。
public {SplashScreen.send-message
message:{HashTable-of String, any}
}:void
set-footer:スプラッシュスクリーンのフッターを設定します。
public {SplashScreen.set-footer
footer:String,
halign:any = "left",
font-family:String = "",
font-size:Distance = 0m,
font-weight:any = null,
color:String = ""
}:void
set-image:スプラッシュスクリーンで使用されるイメージを設定します。
public {SplashScreen.set-image
image-url:#Url = null,
width:Distance = 0m,
height:Distance = 0m
}:void
set-progress-bar:スプラッシュスクリーンにdeterminateなプログレスバーが配置されます。
public {SplashScreen.set-progress-bar
min:double = 0.0,
max:double = 100.0,
value:double = min
}:void
set-progress-bar-indeterminate:スプラッシュスクリーンにindeterminateなプログレスバーが配置されます。
public {SplashScreen.set-progress-bar-indeterminate}:void
set-progress-bar-value:スプラッシュスクリーン UI 内のプログレスバーの設定を行います。
public {SplashScreen.set-progress-bar-value value:double}:void
set-title:スプラッシュスクリーンのタイトルを設定します。
public {SplashScreen.set-title
title:String,
halign:any = "center",
font-family:String = "",
font-size:Distance = 0m,
font-weight:any = null,
color:String = ""
}:void
setup:スプラッシュスクリーンを表示する用意をします。
public {SplashScreen.setup
title:String = "",
footer:String = "",
image-url:#Url = null,
width:Distance = 0m,
height:Distance = 0m,
splash-applet-url:#Url = null,
delay:Time = .5s
}:void
show:すぐにスプラッシュスクリーンを表示します。
public {SplashScreen.show}:void

メソッド
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize






クラス プロシージャ詳細
destroy (クラスプロシージャ)
public {SplashScreen.destroy}:void

スプラッシュスクリーンUIを非表示にし、destroyします。

注意事項

このプロシージャが呼び出される前に、スプラッシュスクリーンが初期化されていなければなりません。
一度このプロシージャが呼び出されると、SplashScreen.setupが再び呼び出されるまで、SplashScreenに対する呼び出しは、不正になります。

send-message (クラスプロシージャ)
public {SplashScreen.send-message
message:{HashTable-of String, any}
}:void

スプラッシュスクリーン サブアプレットに非同期メッセージを送ります。

message: キーがメッセージの名前を表す String である HashTable。キーに関連する値は any 型です。値のタイプはシリアライズ可能でなければなりません。そうでなければ、エラーが発生します。

説明

スプラッシュスクリーン サブアプレットにカスタム メッセージを送るには、このメソッドを呼び出してください。 SplashScreenオブジェクトには、幾つかのメッセージがあらかじめ定義されています。以下のとおりです:
  • title,このメッセージで期待される値は、6つの要素から成るArrayです。 最初の要素は、タイトルのテキストを表すStringに成ります。2つ目の要素は、Stringまたは分数です。3つ目の要素は、フォントファミリーを表すStringです。 4つ目の要素は、フォントサイズを表すDistanceです。5つ目の要素は、nullまたは、FontWeightです。6つ目の要素は、Colorを表すStringです。
  • footer, このメッセージで期待される値は、6つの要素から成るArrayです。 最初の要素は、タイトルのテキストを表すStringに成ります。2つ目の要素は、Stringまたは分数です。3つ目の要素は、フォントファミリーを表すStringです。 4つ目の要素は、フォントサイズを表すDistanceです。5つ目の要素は、nullまたは、FontWeightです。6つ目の要素は、Colorを表すStringです。
  • image, このメッセージで期待される値は、3つの要素から成るArrayです。最初の要素は、イメージのUrlです。2つ目と3つ目の要素は、イメージの幅と高さを表すDistanceです。
  • delay, 期待される値はTimeです。
  • show, 期待される値は、boolです。
  • indeterminate, 期待される値はboolです。
  • progress-bar, 期待される値は、3つの要素から成るdoubleの配列です。3つの要素は、プログレスバーの最小値、最大値、値です。
  • progress-bar-value,プログレスバーの値を表すdoubleです。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-footer (クラスプロシージャ)
public {SplashScreen.set-footer
footer:String,
halign:any = "left",
font-family:String = "",
font-size:Distance = 0m,
font-weight:any = null,
color:String = ""
}:void

スプラッシュスクリーンのフッターを設定します。

footer:
スプラッシュスクリーンのフッター
footerが空の場合、スプラッシュスクリーンUIは、ステータスバーを持ちません。
halign:
タイトルーバー内でのfooterの水平配置。
既定では、left です。
Frame.halignもご覧ください。
font-family:
フッターテキストのフォントファミリー
font-familyが空の場合、無視されます。
既定では空です。
font-size:
フッターのテキストのサイズを指定します。
font-sizeが、0mの場合は無視されます。
font-weight:
nullの場合、無視されます。そうでなければ、フッターのテキストのFontWeightを記述します。
既定では、nullです。
color:
フッターのテキストの色を指定します。
colorが空の場合は、無視されます。既定では空です。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-image (クラスプロシージャ)
public {SplashScreen.set-image
image-url:#Url = null,
width:Distance = 0m,
height:Distance = 0m
}:void

スプラッシュスクリーンで使用されるイメージを設定します。

image-url:
イメージのUrl
nullの場合、規定のイメージが使用されます。
width, height:
イメージの幅と高さ。
widthまたは、heightのいずれかが0mの場合、イメージの既定の幅と高さが使用されます。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-progress-bar (クラスプロシージャ)
public {SplashScreen.set-progress-bar
min:double = 0.0,
max:double = 100.0,
value:double = min
}:void

スプラッシュスクリーンにdeterminateなプログレスバーが配置されます。

min, max: プログレスバーの範囲を決定します。
value: プログレスバーの現在の値。

説明

スプラッシュスクリーンUIがプログレスバーを保持しない場合、プログレスバーが追加されます。ProgressBar.indeterminate?プロパティはfalseに設定されます。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-progress-bar-indeterminate (クラスプロシージャ)
public {SplashScreen.set-progress-bar-indeterminate}:void

スプラッシュスクリーンにindeterminateなプログレスバーが配置されます。

説明

スプラッシュスクリーンUIがプログレスバーを保持しない場合、プログレスバーが追加されます。ProgressBar.indeterminate?プロパティはtrueに設定されます。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-progress-bar-value (クラスプロシージャ)
public {SplashScreen.set-progress-bar-value value:double}:void

スプラッシュスクリーン UI 内のプログレスバーの設定を行います。

説明

SplashScreen.set-progress-barまたは、SplashScreen.set-progress-bar-indeterminateプロシージャのいずれかを呼び出す前にこのメソッドを呼び出しても、何も起きません。これを呼び出してもプログレスバーの状態は、indeterminate からdeterminateに変更されません。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

set-title (クラスプロシージャ)
public {SplashScreen.set-title
title:String,
halign:any = "center",
font-family:String = "",
font-size:Distance = 0m,
font-weight:any = null,
color:String = ""
}:void

スプラッシュスクリーンのタイトルを設定します。

title:
スプラッシュスクリーンのタイトル。
titleが空の場合、スプラッシュスクリーンUIはタイトルバーを持ちません。
halign:
タイトルバー内でのtitleの水平配置
既定では、center です。
Frame.halignもご覧ください。
font-family:
タイトルのテキストのフォントファミリー
font-familyが空の場合、無視されます。
既定では、空です。
font-size:
タイトルのテキストのサイズを指定します。
font-sizeが、0mの場合は無視されます。
font-weight:
nullの場合、無視されます。そうでなければ、タイトルテキストのFontWeightを記述します。
既定では、nullです。
color:
タイトルのテキストの色を指定します。
colorが空の場合は、無視されます。既定では空です。

注意事項

このプロシージャは、SplashScreen.setupの後かつ、SplashScreen.destroyの前に呼び出されなければなりません。そうでなければエラーが発生します。

setup (クラスプロシージャ)
public {SplashScreen.setup
title:String = "",
footer:String = "",
image-url:#Url = null,
width:Distance = 0m,
height:Distance = 0m,
splash-applet-url:#Url = null,
delay:Time = .5s
}:void

スプラッシュスクリーンを表示する用意をします。

title: スプラッシュスクリーンのタイトル
footer:
スプラッシュスクリーンのフッターです。
フッターが指定されない場合には、スプラッシュスクリーンUIは、ステータスバーを持ちません。
image-url:
スプラッシュスクリーンUIの一部として表示されるイメージのUrl。
image-urlが指定されない場合、スプラッシュスクリーンUiは既定のイメージを使用します。
width, height:
イメージの幅と高さ。
widthまたは、heightのいずれかが0mの場合、イメージの既定の幅と高さが使用されます。
splash-applet-url:
スプラッシュスクリーンUIのUrl。
splash-aplet-urlが指定されない場合は、既定のスプラッシュスクリーンUIが使用されます。
SplashScreenSubApplet.create-main-bodyも参照してください。
delay:
スプラッシュスクリーンが表示された後の遅延時間
規定値は 0.5s です。

注意事項

このプロシージャは、スプラッシュスクリーンに対する他のいかなる呼び出しよりも前に呼び出されなければなりません。

show (クラスプロシージャ)
public {SplashScreen.show}:void

すぐにスプラッシュスクリーンを表示します。

説明

通常、このメソッドを直接呼び出す必要はありません。まず最初にSplashScreen.setupを最初に呼び出す必要があります。 setupは少し遅れて、このプロシージャを呼び出します。遅延を発生させずにスプラッシュスクリーンを表示する必要がある時に、このメソッドを使用してください。

注意事項

このプロシージャが呼び出される前に、スプラッシュスクリーンが初期化されていなければなりません。


メソッド詳細