javafx.scene.control

Class DialogEvent

java.lang.Object

Event

javafx.scene.control.DialogEvent

public class DialogEvent
extends Event

Event related to dialog showing/hiding actions. In particular, this event is used exclusively by the following methods:

• Dialog.onShowingProperty()
• Dialog.onShownProperty()
• Dialog.onHidingProperty()
• Dialog.onCloseRequestProperty()
• Dialog.onHiddenProperty()

Since:

JavaFX 8u40

See Also:

Dialog

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	ANY Common supertype for all dialog event types.
static <any>	DIALOG_CLOSE_REQUEST This event is delivered to a dialog when there is an external request to close that dialog.
static <any>	DIALOG_HIDDEN This event occurs on dialog just after it is hidden.
static <any>	DIALOG_HIDING This event occurs on dialog just before it is hidden.
static <any>	DIALOG_SHOWING This event occurs on dialog just before it is shown.
static <any>	DIALOG_SHOWN This event occurs on dialog just after it is shown.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
DialogEvent(Dialog<?> source, <any> eventType) Construct a new Event with the specified event source, target and type.

Method Summary

Modifier and Type	Method and Description
DialogEvent	copyFor(java.lang.Object newSource, EventTarget newTarget)
DialogEvent	copyFor(java.lang.Object newSource, EventTarget newTarget, <any> type) Creates a copy of the given event with the given fields substituted.
<any>	getEventType()
java.lang.String	toString() Returns a string representation of this DialogEvent object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ANY

public static final <any> ANY

Common supertype for all dialog event types.

DIALOG_SHOWING

public static final <any> DIALOG_SHOWING

This event occurs on dialog just before it is shown.

DIALOG_SHOWN

public static final <any> DIALOG_SHOWN

This event occurs on dialog just after it is shown.

DIALOG_HIDING

public static final <any> DIALOG_HIDING

This event occurs on dialog just before it is hidden.

DIALOG_HIDDEN

public static final <any> DIALOG_HIDDEN

This event occurs on dialog just after it is hidden.

DIALOG_CLOSE_REQUEST

public static final <any> DIALOG_CLOSE_REQUEST

This event is delivered to a dialog when there is an external request to close that dialog. If the event is not consumed by any installed dialog event handler, the default handler for this event closes the corresponding dialog.

Constructor Detail

DialogEvent

public DialogEvent(Dialog<?> source,
                   <any> eventType)

Construct a new Event with the specified event source, target and type. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Parameters:

source - the event source which sent the event

eventType - the event type

Method Detail

toString

public java.lang.String toString()

Returns a string representation of this DialogEvent object.

Returns:

a string representation of this DialogEvent object.

copyFor

public DialogEvent copyFor(java.lang.Object newSource,
                           EventTarget newTarget)

copyFor

public DialogEvent copyFor(java.lang.Object newSource,
                           EventTarget newTarget,
                           <any> type)

Creates a copy of the given event with the given fields substituted.

Parameters:

newSource - the new source of the copied event

newTarget - the new target of the copied event

type - the new eventType

Returns:

the event copy with the fields substituted

getEventType

public <any> getEventType()