WindowEvent (JavaFX 17)

Module javafx.graphics
Package javafx.stage

## Class WindowEvent

- java.lang.Object
- - java.util.EventObject
  - - javafx.event.Event
    - - javafx.stage.WindowEvent

- All Implemented Interfaces:
    `Serializable`, `Cloneable`

      public class WindowEvent
      extends Event

  Event related to window showing/hiding actions.
  Since:
    JavaFX 2.0
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static EventType<WindowEvent>` | `ANY` | Common supertype for all window event types.
    `static EventType<WindowEvent>` | `WINDOW_CLOSE_REQUEST` | This event is delivered to a window when there is an external request to close that window.
    `static EventType<WindowEvent>` | `WINDOW_HIDDEN` | This event occurs on window just after it is hidden.
    `static EventType<WindowEvent>` | `WINDOW_HIDING` | This event occurs on window just before it is hidden.
    `static EventType<WindowEvent>` | `WINDOW_SHOWING` | This event occurs on window just before it is shown.
    `static EventType<WindowEvent>` | `WINDOW_SHOWN` | This event occurs on window just after it is shown.

    - ### Fields declared in class javafx.event.Event

      `consumed, eventType, NULL_SOURCE_TARGET, target`

    - ### Fields declared in class java.util.EventObject

      `source`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `WindowEvent​(Window source, EventType<? extends Event> eventType)` | Construct a new `Event` with the specified event source, target and type.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `WindowEvent` | `copyFor​(Object newSource, EventTarget newTarget, EventType<WindowEvent> type)` | Creates a copy of the given event with the given fields substituted.
    `String` | `toString()` | Returns a string representation of this `WindowEvent` object.

    - ### Methods declared in class javafx.event.Event

      `clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed`

    - ### Methods declared in class java.util.EventObject

      `getSource`

    - ### Methods declared in class java.lang.Object

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

- - ### Field Detail

    - #### ANY

          public static final EventType<WindowEvent> ANY

      Common supertype for all window event types.

    - #### WINDOW_SHOWING

          public static final EventType<WindowEvent> WINDOW_SHOWING

      This event occurs on window just before it is shown.

    - #### WINDOW_SHOWN

          public static final EventType<WindowEvent> WINDOW_SHOWN

      This event occurs on window just after it is shown.

    - #### WINDOW_HIDING

          public static final EventType<WindowEvent> WINDOW_HIDING

      This event occurs on window just before it is hidden.

    - #### WINDOW_HIDDEN

          public static final EventType<WindowEvent> WINDOW_HIDDEN

      This event occurs on window just after it is hidden.

    - #### WINDOW_CLOSE_REQUEST

          public static final EventType<WindowEvent> WINDOW_CLOSE_REQUEST

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

  - ### Constructor Detail

    - #### WindowEvent

          public WindowEvent​(Window source,
                             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` - the event source which sent the event
        `eventType` - the event type

  - ### Method Detail

    - #### toString

          public String toString()

      Returns a string representation of this `WindowEvent` object.
      Overrides:
        `toString` in class `EventObject`
      Returns:
        a string representation of this `WindowEvent` object.

    - #### copyFor

          public WindowEvent copyFor​(Object newSource,
                                     EventTarget newTarget,
                                     EventType<WindowEvent> 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
      Since:
        JavaFX 8.0