Top Description Fields Constructors Methods
javafx.scene.control

public Class DialogEvent

extends Event
Class Inheritance
Imports
javafx.beans.NamedArg, javafx.event.Event, .EventTarget, .EventType

Event related to dialog showing/hiding actions. In particular, this event is used exclusively by the following methods:
Since
JavaFX 8u40
See Also
Dialog

Field Summary

Modifier and TypeField and Description
public static final EventType<DialogEvent>
ANY

Hides javafx.event.Event.ANY.

Common supertype for all dialog event types.
public static final EventType<DialogEvent>
DIALOG_CLOSE_REQUEST

This event is delivered to a dialog when there is an external request to close that dialog.

public static final EventType<DialogEvent>
DIALOG_HIDDEN

This event occurs on dialog just after it is hidden.

public static final EventType<DialogEvent>
DIALOG_HIDING

This event occurs on dialog just before it is hidden.

public static final EventType<DialogEvent>
DIALOG_SHOWING

This event occurs on dialog just before it is shown.

public static final EventType<DialogEvent>
DIALOG_SHOWN

This event occurs on dialog just after it is shown.

private static final long
Inherited from javafx.event.Event:
consumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
public
DialogEvent(final Dialog<?>
the event source which sent the event
source
,
final EventType<? extends Event>
the event type
eventType
)

Construct a new Event with the specified event source, target and type.

Method Summary

Modifier and TypeMethod and Description
public DialogEvent
copyFor(Object
the new source of the copied event
newSource
,
EventTarget
the new target of the copied event
newTarget
)

Overrides javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target.

public DialogEvent

Returns:

the event copy with the fields substituted
copyFor
(Object
the new source of the copied event
newSource
,
EventTarget
the new target of the copied event
newTarget
,
EventType<DialogEvent>
the new eventType
type
)

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

public EventType<DialogEvent>
getEventType()

Overrides javafx.event.Event.getEventType.

Gets the event type of this event.

public String

Returns:

a string representation of this DialogEvent object.
toString
()

Overrides java.util.EventObject.toString.

Returns a string representation of this DialogEvent object.

Inherited from javafx.event.Event:
cloneconsumefireEventgetTargetisConsumed

Field Detail

ANYback to summary
public static final EventType<DialogEvent> ANY

Hides javafx.event.Event.ANY.

Common supertype for all dialog event types.

DIALOG_CLOSE_REQUESTback to summary
public static final EventType<DialogEvent> 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.

DIALOG_HIDDENback to summary
public static final EventType<DialogEvent> DIALOG_HIDDEN

This event occurs on dialog just after it is hidden.

DIALOG_HIDINGback to summary
public static final EventType<DialogEvent> DIALOG_HIDING

This event occurs on dialog just before it is hidden.

DIALOG_SHOWINGback to summary
public static final EventType<DialogEvent> DIALOG_SHOWING

This event occurs on dialog just before it is shown.

DIALOG_SHOWNback to summary
public static final EventType<DialogEvent> DIALOG_SHOWN

This event occurs on dialog just after it is shown.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javafx.event.Event.serialVersionUID.

Constructor Detail

DialogEventback to summary
public DialogEvent(final Dialog<?> source, final EventType<? extends Event> 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:Dialog<?>

the event source which sent the event

eventType:EventType<? extends Event>

the event type

Method Detail

copyForback to summary
public DialogEvent copyFor(Object newSource, EventTarget newTarget)

Overrides javafx.event.Event.copyFor.

Doc from javafx.event.Event.copyFor.

Creates and returns a copy of this event with the specified event source and target. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

Parameters
newSource:Object

the new source of the copied event

newTarget:EventTarget

the new target of the copied event

Returns:DialogEvent

the event copy with the new source and target

Annotations
@Override
copyForback to summary
public DialogEvent copyFor(Object newSource, EventTarget newTarget, EventType<DialogEvent> type)

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

Parameters
newSource:Object

the new source of the copied event

newTarget:EventTarget

the new target of the copied event

type:EventType<DialogEvent>

the new eventType

Returns:DialogEvent

the event copy with the fields substituted

getEventTypeback to summary
public EventType<DialogEvent> getEventType()

Overrides javafx.event.Event.getEventType.

Doc from javafx.event.Event.getEventType.

Gets the event type of this event. Objects of the same Event class can have different event types. These event types further specify what kind of event occurred.

Returns:EventType<DialogEvent>

the event type

Annotations
@SuppressWarnings:unchecked
@Override
toStringback to summary
public String toString()

Overrides java.util.EventObject.toString.

Returns a string representation of this DialogEvent object.

Returns:String

a string representation of this DialogEvent object.

Annotations
@Override