- java.lang.Object
-
- javafx.scene.control.Dialog<R>
-
- 型パラメータ:
R
-result
プロパティを介するダイアログの戻り値の型。
- すべての実装されたインタフェース:
EventTarget
- 直系の既知のサブクラス:
Alert
,ChoiceDialog
,TextInputDialog
public class Dialog<R> extends Object implements EventTarget
JavaFXにおけるDialogはDialogPane
をラップし、それをエンド・ユーザーに表示するために必要なAPIを提供します。 JavaFX 8u40では、これはDialogPane
がStage
内部のユーザーに表示されることを意味しますが、将来のリリースでは('lightweight'ダイアログや'internal'ダイアログなどの)別のオプションが提供される可能性があります。 したがって、このAPIは基礎となる実装を認識しないように設計されており、考えられるすべての実装で共通のAPIを表示しようとします。Dialogクラスには、
result
プロパティの型(また、result converter
Callback
を使用してButtonType
からRへ変換する方法)を表すために使用される単一の汎用型Rがあります。重要な注意事項: Dialogクラスを拡張して独自のダイアログを作成するすべての開発者は、
result converter
プロパティの重要性を理解しておくことが重要です。 R型がVoid
でもButtonType
でもない場合は、必ずresult converterを設定する必要があります。 これを怠った開発者には、result converter
を介してButtonType
から変換できなかったことを示すClassCastExceptionsがコードで返されます。ほとんどの開発者にとっては、
Alert
クラス(事前定義された通知形式のアラート用)か、2つの事前作成済ダイアログ(TextInputDialog
およびChoiceDialog
)のいずれかをニーズに応じて使用するほうが便利です。Dialogがインスタンス化されたら、次の手順はDialogを構成することです。 DialogのほとんどすべてのプロパティはDialogのコンテンツに関連していませんが、
contentTextProperty()
、headerTextProperty()
およびgraphicProperty()
プロパティは例外で、dialog pane
プロパティに格納されたDialogPane
の個々のプロパティにAPIを転送するのみです。 この3つのプロパティは、開発者の便宜上、DialogPaneから転送されます。 ダイアログを構成しようとする開発者は、多くの場合、コードをdialog.getDialogPane().setExpandableContent(node)
の行とともに使用する必要があります。これらのプロパティを構成した後は、(
ButtonType
およびDialogPane.createButton(ButtonType)
メソッドを使用して作成した)ボタンを完全に構成するかどうかを考慮するだけです。ButtonType
クラスを使用した場合、開発者が構成できる範囲は多くありません。 これは意図されたことですが、ButtonType
で作成した指定のボタンを開発者が変更できないということではありません。 変更するには、開発者はDialogPane.lookupButton(ButtonType)
メソッドをButtonTypeとともに呼び出すだけです(DialogPane.getButtonTypes()
リストですでに設定されている場合)。 返されるNodeは通常はButton
型ですが、DialogPane.createButton(ButtonType)
メソッドがオーバーライドされているかどうかによって異なります。 したがって、通常のアプローチは次の行のようになります。ButtonType loginButtonType = new ButtonType("Login", ButtonData.OK_DONE); Dialog<String> dialog = new Dialog<>(); dialog.getDialogPane().getButtonTypes().add(loginButtonType); boolean disabled = false; // computed based on content of text fields, for example dialog.getDialogPane().lookupButton(loginButtonType).setDisable(disabled);
Dialogがインスタンス化されて完全に構成されたら、次の手順はDialogを表示することです。 通常、アラートはモーダルなブロッキング形式で表示されます。 'モーダル'とは、ダイアログの表示中はユーザーが所有アプリケーションを操作できないことを意味し、'ブロッキング'とは、ダイアログが表示された時点でコード実行が停止されることを意味します。 つまり、ダイアログを表示し、ユーザー・レスポンスを待機してから、showコールの直後のコードから実行を続行できるため、開発者はダイアログからのユーザー入力にすぐに対応することができます(関連する場合)。
JavaFXダイアログは、デフォルトでモーダルです(これは、
initModality(javafx.stage.Modality)
APIを使用して変更できます)。 ブロッキング・ダイアログまたは非ブロッキング・ダイアログを指定するには、開発者が(それぞれ)showAndWait()
またはshow()
を呼び出すことを選択します。 このような状況でのコーディングを容易にするために、ほとんどの開発者がデフォルトでshowAndWait()
を選択する必要があります。 次の3つのコード・スニペットは、ダイアログを表示するための方法を示したもので、3つとも等しく有効です。オプション1: '従来型'のアプローチ
Optional<ButtonType> result = dialog.showAndWait(); if (result.isPresent() && result.get() == ButtonType.OK) { formatSystem(); }
オプション2: 従来型+オプションのアプローチ
dialog.showAndWait().ifPresent(response -> { if (response == ButtonType.OK) { formatSystem(); } });
オプション3: 完全なラムダ式アプローチ
dialog.showAndWait() .filter(response -> response == ButtonType.OK) .ifPresent(response -> formatSystem());
上の3つのオプションに優劣はないので、開発者は自分の好きなスタイルで作業できます。 上のオプションを示した目的は、開発者に
Optional
APIを紹介することにあります。これはJava 8で新しく導入されたものであり、多くの開発者には馴染みがないと思われます。ダイアログ検証/ボタン・アクションのインターセプト
状況によっては、ダイアログの局面が内部的に整合する(たとえば、ダイアログ内のフォームのすべてのフィールドが有効な状態になる)までダイアログを閉じないようにする方が望ましいことがあります。 このためには、ダイアログAPIのユーザーが
DialogPane.lookupButton(ButtonType)
メソッドについてよく理解する必要があります。 (すでにbutton types
リスト内に設定されている)ButtonType
を渡すことにより、通常はButton
型であるNodeがユーザーに返されます(ただし、これはDialogPane.createButton(ButtonType)
メソッドがオーバーライドされているかどうかによって異なります)。 このボタンを使用すると、ユーザーは、ボタンが通常のイベント処理を行う前に呼び出されるイベント・フィルタを追加して、イベントをconsuming
することによりイベント処理を回避できます。 簡単な例を次に示します。final Button btOk = (Button) dlg.getDialogPane().lookupButton(ButtonType.OK); btOk.addEventFilter(ActionEvent.ACTION, event -> { if (!validateAndStore()) { event.consume(); } });
ダイアログを閉じるルール
Dialogを閉じたときに行われる処理と、特に異常クローズの状況(ダイアログのタイトル・バーで'X'ボタンがクリックされた場合や、オペレーティング・システムに固有のキーボード・ショートカット(Windowsでの[Alt]+[F4]など)が入力された場合など)でDialogを閉じる方法を理解しておくことが重要です。 次の箇条書きでまとめるように、これらの状況における結果は明確に定義されています。
- JavaFXダイアログを(前述の定義のとおり)'正常でない状況で'閉じることができるのは、次の2つの場合のみです。
- ダイアログにボタンが1つのみ含まれる場合、または
- ダイアログに複数のボタンが含まれる場合(そのうち1つが次の要件の1つを満たしていることが前提):
- ボタンに
ButtonType
があり、そのButtonBar.ButtonData
の型がButtonBar.ButtonData.CANCEL_CLOSE
である。 - ボタンに
ButtonType
があり、ButtonBar.ButtonData.isCancelButton()
が呼び出されるとそのButtonBar.ButtonData
がtrueを返す。
- ボタンに
- それ以外の場合、ダイアログはすべての閉じるリクエストへの応答を拒否し、ユーザーがダイアログの
DialogPane
領域内の使用可能なボタンのいずれかをクリックするまでは開いたままになります。 - ダイアログが異常クローズし、かつダイアログに前述の2つのいずれかの条件を満たすボタンが含まれる場合、そのダイアログは
result
プロパティを、最初に一致するButtonType
を使用してresult converter
を呼び出すことにより返された値に設定しようとします。 - なんらかの理由によって結果コンバータがnullを返した場合、または取消以外のボタン1つのみが存在するときにダイアログが閉じられた場合、
result
プロパティはnullになり、showAndWait()
メソッドはOptional.empty()
を返します。 この後者の意味は、(このクラス説明で前述したように)オプション2かオプション3のいずれかを使用する場合、Optional.ifPresent(java.util.function.Consumer)
ラムダが呼び出されることはなく、ダイアログが何も値を返していない場合と同様にコードの実行が続行されるということです。
- 導入されたバージョン:
- JavaFX 8u40
- 関連項目:
Alert
、TextInputDialog
、ChoiceDialog
-
-
プロパティのサマリー
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 Dialog()
所有者を指定せずにダイアログを作成します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 EventDispatchChain
buildEventDispatchChain(EventDispatchChain tail)
このターゲットのイベント・ディスパッチ・チェーンを構築します。void
close()
このDialog
を閉じます。StringProperty
contentTextProperty()
ダイアログ・ペインのコンテンツ・テキストを表すプロパティ。ObjectProperty<DialogPane>
dialogPaneProperty()
ダイアログのルート・ノード。DialogPane
には、このダイアログに表示されるすべての視覚的要素が含まれます。String
getContentText()
このDialogPaneに現在設定されているコンテンツ・テキストを返します。DialogPane
getDialogPane()
プロパティdialogPaneの値を取得します。Node
getGraphic()
プロパティgraphicの値を取得します。String
getHeaderText()
このDialogPaneに現在設定されているヘッダー・テキストを返します。double
getHeight()
ダイアログの高さを返します。Modality
getModality()
このダイアログのモダリティ属性を取得します。EventHandler<DialogEvent>
getOnCloseRequest()
プロパティonCloseRequestの値を取得します。EventHandler<DialogEvent>
getOnHidden()
プロパティonHiddenの値を取得します。EventHandler<DialogEvent>
getOnHiding()
プロパティonHidingの値を取得します。EventHandler<DialogEvent>
getOnShowing()
プロパティonShowingの値を取得します。EventHandler<DialogEvent>
getOnShown()
プロパティonShownの値を取得します。Window
getOwner()
このダイアログの所有者Windowを取得するか、または所有者がいないダイアログの場合はnullとなります。R
getResult()
プロパティresultの値を取得します。Callback<ButtonType,R>
getResultConverter()
プロパティresultConverterの値を取得します。String
getTitle()
ダイアログのタイトルを返します。double
getWidth()
ダイアログの幅を返します。double
getX()
プロパティxの値を取得します。double
getY()
プロパティyの値を取得します。ObjectProperty<Node>
graphicProperty()
ヘッダー(ヘッダーが表示されている場合)またはcontent
の左側に表示されるダイアログ・グラフィック。StringProperty
headerTextProperty()
ダイアログ・ペインのヘッダー・テキストを表すプロパティ。ReadOnlyDoubleProperty
heightProperty()
ダイアログの高さを表すプロパティ。void
hide()
このDialog
を非表示にします。void
initModality(Modality modality)
このダイアログのモダリティを指定します。void
initOwner(Window window)
このダイアログの所有者Window
を指定するか、または最上位で所有者のいないダイアログの場合はnullとなります。void
initStyle(StageStyle style)
このダイアログのスタイルを指定します。boolean
isResizable()
ダイアログのサイズを変更できるかどうかを返します。boolean
isShowing()
ダイアログが表示されているかどうかを返します。ObjectProperty<EventHandler<DialogEvent>>
onCloseRequestProperty()
このDialog
を閉じる外部リクエストがあると呼び出されます。ObjectProperty<EventHandler<DialogEvent>>
onHiddenProperty()
Dialogが非表示になった直後に呼び出されます。ObjectProperty<EventHandler<DialogEvent>>
onHidingProperty()
Dialogが非表示になる直前に呼び出されます。ObjectProperty<EventHandler<DialogEvent>>
onShowingProperty()
Dialogが表示される直前に呼び出されます。ObjectProperty<EventHandler<DialogEvent>>
onShownProperty()
Dialogが表示された直後に呼び出されます。BooleanProperty
resizableProperty()
ダイアログのサイズを変更できるかどうかを表します。ObjectProperty<Callback<ButtonType,R>>
resultConverterProperty()
ユーザーがクリックしたButtonType
を、result
プロパティを介して返すことができる結果に変換するためのAPI。ObjectProperty<R>
resultProperty()
ダイアログから返された内容を表すプロパティ。void
setContentText(String contentText)
ダイアログのコンテンツ領域に表示する文字列を設定します。void
setDialogPane(DialogPane value)
プロパティdialogPaneの値を設定します。void
setGraphic(Node graphic)
ヘッダー(ヘッダーが表示されている場合)またはcontent
の左側に表示されるダイアログ・グラフィックを設定します。void
setHeaderText(String headerText)
ダイアログのヘッダー領域に表示する文字列を設定します。void
setHeight(double height)
ダイアログの高さを設定します。void
setOnCloseRequest(EventHandler<DialogEvent> value)
プロパティonCloseRequestの値を設定します。void
setOnHidden(EventHandler<DialogEvent> value)
プロパティonHiddenの値を設定します。void
setOnHiding(EventHandler<DialogEvent> value)
プロパティonHidingの値を設定します。void
setOnShowing(EventHandler<DialogEvent> value)
プロパティonShowingの値を設定します。void
setOnShown(EventHandler<DialogEvent> value)
プロパティonShownの値を設定します。void
setResizable(boolean resizable)
ユーザーがダイアログのサイズを変更できるかどうかを設定します。void
setResult(R value)
プロパティresultの値を設定します。void
setResultConverter(Callback<ButtonType,R> value)
プロパティresultConverterの値を設定します。void
setTitle(String title)
ダイアログのタイトルを変更します。void
setWidth(double width)
ダイアログの幅を設定します。void
setX(double x)
プロパティxの値を設定します。void
setY(double y)
プロパティyの値を設定します。void
show()
ダイアログを表示しますが、ユーザー・レスポンスを待機しません(つまり、非ブロッキング・ダイアログを開きます)。Optional<R>
showAndWait()
ダイアログを表示し、ユーザー・レスポンスを待機します(つまり、ユーザーが入力した戻り値とともにブロッキング・ダイアログを開きます)。ReadOnlyBooleanProperty
showingProperty()
ダイアログが現在表示されているかどうかを表します。StringProperty
titleProperty()
ダイアログのtitlePropertyを返します。ReadOnlyDoubleProperty
widthProperty()
ダイアログの幅を表すプロパティ。ReadOnlyDoubleProperty
xProperty()
このDialog
の水平位置。ReadOnlyDoubleProperty
yProperty()
このDialog
の垂直位置。
-
-
-
プロパティの詳細
-
dialogPane
public final ObjectProperty<DialogPane> dialogPaneProperty
ダイアログのルート・ノード。DialogPane
には、このダイアログに表示されるすべての視覚的要素が含まれます。 そのため、既存のダイアログ・ペインを変更するか、新規作成するかして、ダイアログの表示を完全に調整することが可能です。
-
contentText
public final StringProperty contentTextProperty
ダイアログ・ペインのコンテンツ・テキストを表すプロパティ。 コンテンツ・テキストの優先順位はcontent node
よりも低いため、コンテンツ・ノードとcontentTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではコンテンツ・テキストは表示されません。
-
headerText
public final StringProperty headerTextProperty
ダイアログ・ペインのヘッダー・テキストを表すプロパティ。 ヘッダー・テキストの優先順位はheader node
よりも低いため、ヘッダー・ノードとheaderTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではヘッダー・テキストは表示されません。
-
graphic
public final ObjectProperty<Node> graphicProperty
ヘッダー(ヘッダーが表示されている場合)またはcontent
の左側に表示されるダイアログ・グラフィック。- 関連項目:
getGraphic()
、setGraphic(Node)
-
result
public final ObjectProperty<R> resultProperty
ダイアログから返された内容を表すプロパティ。 結果は、ユーザーがクリックしたButtonType
をR型の値に変換するresult converter
を介して生成されます。 詳細は、Dialog
クラスのJavaDocを参照してください。- 関連項目:
getResult()
、setResult(R)
-
resultConverter
public final ObjectProperty<Callback<ButtonType,R>> resultConverterProperty
ユーザーがクリックしたButtonType
を、result
プロパティを介して返すことができる結果に変換するためのAPI。 これが必要なのは、ButtonType
はダイアログ内のビジュアル・ボタンを表し、結果コンバータを使用して(ダイアログ実装の要件である)自身を有効な結果にマップする方法を認識しないためです。 Dialogサブクラスの結果型がButtonTypeであり、結果コンバータがnullになる可能性がある場合もあれば、結果型RがButtonTypeでもVoidでもなく、このコールバックを指定する必要がある場合もあります。
-
showing
public final ReadOnlyBooleanProperty showingProperty
ダイアログが現在表示されているかどうかを表します。- 関連項目:
isShowing()
-
resizable
public final BooleanProperty resizableProperty
ダイアログのサイズを変更できるかどうかを表します。
-
width
public final ReadOnlyDoubleProperty widthProperty
ダイアログの幅を表すプロパティ。- 関連項目:
getWidth()
、setWidth(double)
-
height
public final ReadOnlyDoubleProperty heightProperty
ダイアログの高さを表すプロパティ。- 関連項目:
getHeight()
、setHeight(double)
-
title
public final StringProperty titleProperty
ダイアログのtitlePropertyを返します。- 関連項目:
getTitle()
,setTitle(String)
-
x
public final ReadOnlyDoubleProperty xProperty
このDialog
の水平位置。 この属性を変更すると、Dialog
が水平方向に移動します。- 関連項目:
getX()
、setX(double)
-
y
public final ReadOnlyDoubleProperty yProperty
このDialog
の垂直位置。 この属性を変更すると、Dialog
が垂直方向に移動します。- 関連項目:
getY()
、setY(double)
-
onShowing
public final ObjectProperty<EventHandler<DialogEvent>> onShowingProperty
Dialogが表示される直前に呼び出されます。
-
onShown
public final ObjectProperty<EventHandler<DialogEvent>> onShownProperty
Dialogが表示された直後に呼び出されます。
-
onHiding
public final ObjectProperty<EventHandler<DialogEvent>> onHidingProperty
Dialogが非表示になる直前に呼び出されます。
-
onHidden
public final ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty
Dialogが非表示になった直後に呼び出されます。Dialog
が非表示の場合、このイベント・ハンドラが呼び出され、開発者はAlert
が閉じられたときにリソースをクリーンアップしたり、その他のタスクを実行できます。
-
onCloseRequest
public final ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty
このDialog
を閉じる外部リクエストがあると呼び出されます。 インストールされたイベント・ハンドラは、受け取ったイベントを使用することで、ダイアログが閉じられることを回避できます。
-
-
メソッドの詳細
-
show
public final void show()
ダイアログを表示しますが、ユーザー・レスポンスを待機しません(つまり、非ブロッキング・ダイアログを開きます)。 このAPIのユーザーはresult property
をポーリングするか、設定されたタイミングで通知を受けるリスナーをresult propertyに追加する必要があります。- 例外:
IllegalStateException
- このメソッドがJavaFXアプリケーション・スレッド以外のスレッドで呼び出された場合。
-
showAndWait
public final Optional<R> showAndWait()
ダイアログを表示し、ユーザー・レスポンスを待機します(つまり、ユーザーが入力した戻り値とともにブロッキング・ダイアログを開きます)。このメソッドは、JavaFXアプリケーション・スレッドで呼び出される必要があります。 さらに、入力イベント・ハンドラから呼び出すか、
Platform.runLater
に渡されたRunnableのrunメソッドから呼び出す必要があります。 アニメーションやレイアウトの処理中に呼び出されてはなりません。- 戻り値:
result
を含むOptional
。 詳細は、Dialog
クラスの説明を参照してください。- 例外:
IllegalStateException
- このメソッドがJavaFXアプリケーション・スレッド以外のスレッドで呼び出された場合。IllegalStateException
- このメソッドがアニメーションまたはレイアウト処理中に呼び出された場合。
-
close
public final void close()
このDialog
を閉じます。 この呼び出しはhide()
と同じです。
-
hide
public final void hide()
このDialog
を非表示にします。
-
initModality
public final void initModality(Modality modality)
このダイアログのモダリティを指定します。 これは、ダイアログを表示可能にする前に実行する必要があります。 モダリティは、Modality.NONE、Modality.WINDOW_MODALまたはModality.APPLICATION_MODALのいずれかになります。- デフォルト値:
- Modality.APPLICATION_MODAL
- パラメータ:
modality
- このダイアログのモダリティ。- 例外:
IllegalStateException
- ダイアログが表示可能になった後にこのプロパティが設定された場合。
-
getModality
public final Modality getModality()
このダイアログのモダリティ属性を取得します。- 戻り値:
- モダリティ。
-
initStyle
public final void initStyle(StageStyle style)
このダイアログのスタイルを指定します。 これは、ダイアログを表示可能にする前に実行する必要があります。 スタイルは、StageStyle.DECORATED、StageStyle.UNDECORATED、StageStyle.TRANSPARENT、StageStyle.UTILITYまたはStageStyle.UNIFIEDのいずれかになります。- デフォルト値:
- StageStyle.DECORATED
- パラメータ:
style
- このダイアログのスタイル。- 例外:
IllegalStateException
- ダイアログが表示可能になった後にこのプロパティが設定された場合。
-
initOwner
public final void initOwner(Window window)
このダイアログの所有者Window
を指定するか、または最上位で所有者のいないダイアログの場合はnullとなります。 これは、ダイアログを表示可能にする前に実行する必要があります。- デフォルト値:
- null
- パラメータ:
window
- このダイアログの所有者Window
。- 例外:
IllegalStateException
- ダイアログが表示可能になった後にこのプロパティが設定された場合。
-
getOwner
public final Window getOwner()
このダイアログの所有者Windowを取得するか、または所有者がいないダイアログの場合はnullとなります。- 戻り値:
- 所有者ウィンドウ。
-
dialogPaneProperty
public final ObjectProperty<DialogPane> dialogPaneProperty()
ダイアログのルート・ノード。DialogPane
には、このダイアログに表示されるすべての視覚的要素が含まれます。 そのため、既存のダイアログ・ペインを変更するか、新規作成するかして、ダイアログの表示を完全に調整することが可能です。
-
getDialogPane
public final DialogPane getDialogPane()
プロパティdialogPaneの値を取得します。- プロパティの説明:
- ダイアログのルート・ノード。
DialogPane
には、このダイアログに表示されるすべての視覚的要素が含まれます。 そのため、既存のダイアログ・ペインを変更するか、新規作成するかして、ダイアログの表示を完全に調整することが可能です。
-
setDialogPane
public final void setDialogPane(DialogPane value)
プロパティdialogPaneの値を設定します。- プロパティの説明:
- ダイアログのルート・ノード。
DialogPane
には、このダイアログに表示されるすべての視覚的要素が含まれます。 そのため、既存のダイアログ・ペインを変更するか、新規作成するかして、ダイアログの表示を完全に調整することが可能です。
-
contentTextProperty
public final StringProperty contentTextProperty()
ダイアログ・ペインのコンテンツ・テキストを表すプロパティ。 コンテンツ・テキストの優先順位はcontent node
よりも低いため、コンテンツ・ノードとcontentTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではコンテンツ・テキストは表示されません。
-
getContentText
public final String getContentText()
このDialogPaneに現在設定されているコンテンツ・テキストを返します。- 戻り値:
- このDialogPaneの現在設定されているコンテンツ・テキスト
-
setContentText
public final void setContentText(String contentText)
ダイアログのコンテンツ領域に表示する文字列を設定します。 コンテンツ・テキストの優先順位はcontent node
よりも低いため、コンテンツ・ノードとcontentTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではコンテンツ・テキストは表示されないことに注意してください。- パラメータ:
contentText
- ダイアログ・コンテンツ領域に表示する文字列
-
headerTextProperty
public final StringProperty headerTextProperty()
ダイアログ・ペインのヘッダー・テキストを表すプロパティ。 ヘッダー・テキストの優先順位はheader node
よりも低いため、ヘッダー・ノードとheaderTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではヘッダー・テキストは表示されません。
-
getHeaderText
public final String getHeaderText()
このDialogPaneに現在設定されているヘッダー・テキストを返します。- 戻り値:
- このDialogPaneの現在設定されているヘッダー・テキスト
-
setHeaderText
public final void setHeaderText(String headerText)
ダイアログのヘッダー領域に表示する文字列を設定します。 ヘッダー・テキストの優先順位はheader node
よりも低いため、ヘッダー・ノードとheaderTextプロパティの両方が設定されている場合、デフォルトのDialogPaneインスタンスではヘッダー・テキストは表示されないことに注意してください。- パラメータ:
headerText
- ダイアログ・ヘッダー領域に表示する文字列
-
graphicProperty
public final ObjectProperty<Node> graphicProperty()
ヘッダー(ヘッダーが表示されている場合)またはcontent
の左側に表示されるダイアログ・グラフィック。- 関連項目:
getGraphic()
、setGraphic(Node)
-
getGraphic
public final Node getGraphic()
プロパティgraphicの値を取得します。- プロパティの説明:
- ヘッダー(ヘッダーが表示されている場合)または
content
の左側に表示されるダイアログ・グラフィック。
-
setGraphic
public final void setGraphic(Node graphic)
ヘッダー(ヘッダーが表示されている場合)またはcontent
の左側に表示されるダイアログ・グラフィックを設定します。- パラメータ:
graphic
- 新しいダイアログ・グラフィックか、グラフィックを表示しない場合はnull。
-
resultProperty
public final ObjectProperty<R> resultProperty()
ダイアログから返された内容を表すプロパティ。 結果は、ユーザーがクリックしたButtonType
をR型の値に変換するresult converter
を介して生成されます。 詳細は、Dialog
クラスのJavaDocを参照してください。- 関連項目:
getResult()
、setResult(R)
-
getResult
public final R getResult()
プロパティresultの値を取得します。- プロパティの説明:
- ダイアログから返された内容を表すプロパティ。 結果は、ユーザーがクリックした
ButtonType
をR型の値に変換するresult converter
を介して生成されます。 詳細は、Dialog
クラスのJavaDocを参照してください。
-
setResult
public final void setResult(R value)
プロパティresultの値を設定します。- プロパティの説明:
- ダイアログから返された内容を表すプロパティ。 結果は、ユーザーがクリックした
ButtonType
をR型の値に変換するresult converter
を介して生成されます。 詳細は、Dialog
クラスのJavaDocを参照してください。
-
resultConverterProperty
public final ObjectProperty<Callback<ButtonType,R>> resultConverterProperty()
ユーザーがクリックしたButtonType
を、result
プロパティを介して返すことができる結果に変換するためのAPI。 これが必要なのは、ButtonType
はダイアログ内のビジュアル・ボタンを表し、結果コンバータを使用して(ダイアログ実装の要件である)自身を有効な結果にマップする方法を認識しないためです。 Dialogサブクラスの結果型がButtonTypeであり、結果コンバータがnullになる可能性がある場合もあれば、結果型RがButtonTypeでもVoidでもなく、このコールバックを指定する必要がある場合もあります。
-
getResultConverter
public final Callback<ButtonType,R> getResultConverter()
プロパティresultConverterの値を取得します。- プロパティの説明:
- ユーザーがクリックした
ButtonType
を、result
プロパティを介して返すことができる結果に変換するためのAPI。 これが必要なのは、ButtonType
はダイアログ内のビジュアル・ボタンを表し、結果コンバータを使用して(ダイアログ実装の要件である)自身を有効な結果にマップする方法を認識しないためです。 Dialogサブクラスの結果型がButtonTypeであり、結果コンバータがnullになる可能性がある場合もあれば、結果型RがButtonTypeでもVoidでもなく、このコールバックを指定する必要がある場合もあります。
-
setResultConverter
public final void setResultConverter(Callback<ButtonType,R> value)
プロパティresultConverterの値を設定します。- プロパティの説明:
- ユーザーがクリックした
ButtonType
を、result
プロパティを介して返すことができる結果に変換するためのAPI。 これが必要なのは、ButtonType
はダイアログ内のビジュアル・ボタンを表し、結果コンバータを使用して(ダイアログ実装の要件である)自身を有効な結果にマップする方法を認識しないためです。 Dialogサブクラスの結果型がButtonTypeであり、結果コンバータがnullになる可能性がある場合もあれば、結果型RがButtonTypeでもVoidでもなく、このコールバックを指定する必要がある場合もあります。
-
showingProperty
public final ReadOnlyBooleanProperty showingProperty()
ダイアログが現在表示されているかどうかを表します。- 関連項目:
isShowing()
-
isShowing
public final boolean isShowing()
ダイアログが表示されているかどうかを返します。- 戻り値:
- ダイアログが表示されている場合はtrue。
-
resizableProperty
public final BooleanProperty resizableProperty()
ダイアログのサイズを変更できるかどうかを表します。
-
isResizable
public final boolean isResizable()
ダイアログのサイズを変更できるかどうかを返します。- 戻り値:
- ダイアログのサイズ変更が可能な場合はtrue。
-
setResizable
public final void setResizable(boolean resizable)
ユーザーがダイアログのサイズを変更できるかどうかを設定します。 サイズ変更が可能なダイアログは最大化することもできます(最大化ボタンが表示可能になります)- パラメータ:
resizable
- ダイアログのサイズ変更を可能にする場合はtrue。
-
widthProperty
public final ReadOnlyDoubleProperty widthProperty()
ダイアログの幅を表すプロパティ。- 関連項目:
getWidth()
、setWidth(double)
-
getWidth
public final double getWidth()
ダイアログの幅を返します。- 戻り値:
- ダイアログの幅
-
setWidth
public final void setWidth(double width)
ダイアログの幅を設定します。- パラメータ:
width
- ダイアログの幅
-
heightProperty
public final ReadOnlyDoubleProperty heightProperty()
ダイアログの高さを表すプロパティ。- 関連項目:
getHeight()
、setHeight(double)
-
getHeight
public final double getHeight()
ダイアログの高さを返します。- 戻り値:
- ダイアログの高さ
-
setHeight
public final void setHeight(double height)
ダイアログの高さを設定します。- パラメータ:
height
- ダイアログの高さ
-
titleProperty
public final StringProperty titleProperty()
ダイアログのtitlePropertyを返します。- 関連項目:
getTitle()
,setTitle(String)
-
getTitle
public final String getTitle()
ダイアログのタイトルを返します。- 戻り値:
- ダイアログのタイトル
-
setTitle
public final void setTitle(String title)
ダイアログのタイトルを変更します。- パラメータ:
title
- ダイアログのタイトル
-
getX
public final double getX()
プロパティxの値を取得します。- プロパティの説明:
- この
Dialog
の水平位置。 この属性を変更すると、Dialog
が水平方向に移動します。
-
setX
public final void setX(double x)
プロパティxの値を設定します。- プロパティの説明:
- この
Dialog
の水平位置。 この属性を変更すると、Dialog
が水平方向に移動します。
-
xProperty
public final ReadOnlyDoubleProperty xProperty()
このDialog
の水平位置。 この属性を変更すると、Dialog
が水平方向に移動します。- 関連項目:
getX()
、setX(double)
-
getY
public final double getY()
プロパティyの値を取得します。- プロパティの説明:
- この
Dialog
の垂直位置。 この属性を変更すると、Dialog
が垂直方向に移動します。
-
setY
public final void setY(double y)
プロパティyの値を設定します。- プロパティの説明:
- この
Dialog
の垂直位置。 この属性を変更すると、Dialog
が垂直方向に移動します。
-
yProperty
public final ReadOnlyDoubleProperty yProperty()
このDialog
の垂直位置。 この属性を変更すると、Dialog
が垂直方向に移動します。- 関連項目:
getY()
、setY(double)
-
buildEventDispatchChain
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)
このターゲットのイベント・ディスパッチ・チェーンを構築します。 イベント・ディスパッチ・チェーンには、このEventTarget
を対象にしたイベントの処理に関係する可能性があるイベント・ディスパッチャが含まれます。 このイベント・ターゲットはチェーンに自動的には追加されないため、これがイベントを処理する場合は、それ自体のEventDispatcher
をチェーンに追加する必要があります。イベント・ターゲットが階層の一部である場合、そのチェーンは通常、階層のルートからイベント・ターゲットまでの収集されたイベント・ディスパッチャから作成されます。
イベント・ディスパッチ・チェーンは、提供される初期イベント・ディスパッチ・チェーンに対する変更によって構築されます。 返されるチェーンでは初期チェーンが最後にある必要があるため、ディスパッチャは初期チェーンの前に追加される必要があります。
呼出し元は、初期チェーンが変更されないままであることや、返される値によって異なるチェーンが参照されることを想定できません。
- 定義:
buildEventDispatchChain
、インタフェース:EventTarget
- パラメータ:
tail
- 構築元となる初期チェーン- 戻り値:
- このターゲットの結果のイベント・ディスパッチ・チェーン
-
setOnShowing
public final void setOnShowing(EventHandler<DialogEvent> value)
プロパティonShowingの値を設定します。- プロパティの説明:
- Dialogが表示される直前に呼び出されます。
-
getOnShowing
public final EventHandler<DialogEvent> getOnShowing()
プロパティonShowingの値を取得します。- プロパティの説明:
- Dialogが表示される直前に呼び出されます。
-
onShowingProperty
public final ObjectProperty<EventHandler<DialogEvent>> onShowingProperty()
Dialogが表示される直前に呼び出されます。
-
setOnShown
public final void setOnShown(EventHandler<DialogEvent> value)
プロパティonShownの値を設定します。- プロパティの説明:
- Dialogが表示された直後に呼び出されます。
-
getOnShown
public final EventHandler<DialogEvent> getOnShown()
プロパティonShownの値を取得します。- プロパティの説明:
- Dialogが表示された直後に呼び出されます。
-
onShownProperty
public final ObjectProperty<EventHandler<DialogEvent>> onShownProperty()
Dialogが表示された直後に呼び出されます。
-
setOnHiding
public final void setOnHiding(EventHandler<DialogEvent> value)
プロパティonHidingの値を設定します。- プロパティの説明:
- Dialogが非表示になる直前に呼び出されます。
-
getOnHiding
public final EventHandler<DialogEvent> getOnHiding()
プロパティonHidingの値を取得します。- プロパティの説明:
- Dialogが非表示になる直前に呼び出されます。
-
onHidingProperty
public final ObjectProperty<EventHandler<DialogEvent>> onHidingProperty()
Dialogが非表示になる直前に呼び出されます。
-
setOnHidden
public final void setOnHidden(EventHandler<DialogEvent> value)
プロパティonHiddenの値を設定します。- プロパティの説明:
- Dialogが非表示になった直後に呼び出されます。
Dialog
が非表示の場合、このイベント・ハンドラが呼び出され、開発者はAlert
が閉じられたときにリソースをクリーンアップしたり、その他のタスクを実行できます。
-
getOnHidden
public final EventHandler<DialogEvent> getOnHidden()
プロパティonHiddenの値を取得します。- プロパティの説明:
- Dialogが非表示になった直後に呼び出されます。
Dialog
が非表示の場合、このイベント・ハンドラが呼び出され、開発者はAlert
が閉じられたときにリソースをクリーンアップしたり、その他のタスクを実行できます。
-
onHiddenProperty
public final ObjectProperty<EventHandler<DialogEvent>> onHiddenProperty()
Dialogが非表示になった直後に呼び出されます。Dialog
が非表示の場合、このイベント・ハンドラが呼び出され、開発者はAlert
が閉じられたときにリソースをクリーンアップしたり、その他のタスクを実行できます。
-
setOnCloseRequest
public final void setOnCloseRequest(EventHandler<DialogEvent> value)
プロパティonCloseRequestの値を設定します。- プロパティの説明:
- この
Dialog
を閉じる外部リクエストがあると呼び出されます。 インストールされたイベント・ハンドラは、受け取ったイベントを使用することで、ダイアログが閉じられることを回避できます。
-
getOnCloseRequest
public final EventHandler<DialogEvent> getOnCloseRequest()
プロパティonCloseRequestの値を取得します。- プロパティの説明:
- この
Dialog
を閉じる外部リクエストがあると呼び出されます。 インストールされたイベント・ハンドラは、受け取ったイベントを使用することで、ダイアログが閉じられることを回避できます。
-
onCloseRequestProperty
public final ObjectProperty<EventHandler<DialogEvent>> onCloseRequestProperty()
このDialog
を閉じる外部リクエストがあると呼び出されます。 インストールされたイベント・ハンドラは、受け取ったイベントを使用することで、ダイアログが閉じられることを回避できます。
-
-