JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
WindowClosingProtocol.java
Go to the documentation of this file.
1/**
2 * Copyright 2010 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.nativewindow;
30
31/**
32 * Protocol for handling window closing events.
33 * <p>
34 * The implementation shall obey either the user value set by this interface,<br>
35 * an underlying toolkit set user value or it's default, eg. {@link WindowClosingMode#DO_NOTHING_ON_CLOSE DO_NOTHING_ON_CLOSE} within an AWT environment.<br>
36 * If none of the above determines the operation,
37 * this protocol default behavior {@link WindowClosingMode#DISPOSE_ON_CLOSE DISPOSE_ON_CLOSE} shall be used.</p>
38 */
39public interface WindowClosingProtocol {
40
41 /**
42 * Window closing mode if triggered by toolkit close operation.
43 */
44 public enum WindowClosingMode {
45 /**
46 * Do nothing on native window close operation.<br>
47 * This is the default behavior within an AWT environment.
48 */
50
51 /**
52 * Dispose resources on native window close operation.<br>
53 * This is the default behavior in case no underlying toolkit defines otherwise.
54 */
56 }
57
58
59 /**
60 * @return the current close operation value
61 * @see WindowClosingMode#DISPOSE_ON_CLOSE
62 * @see WindowClosingMode#DO_NOTHING_ON_CLOSE
63 */
65
66 /**
67 * @param op the new close operation value
68 * @return the previous close operation value
69 * @see WindowClosingMode#DISPOSE_ON_CLOSE
70 * @see WindowClosingMode#DO_NOTHING_ON_CLOSE
71 */
73}
Window closing mode if triggered by toolkit close operation.
DO_NOTHING_ON_CLOSE
Do nothing on native window close operation.
DISPOSE_ON_CLOSE
Dispose resources on native window close operation.
Protocol for handling window closing events.
WindowClosingMode setDefaultCloseOperation(WindowClosingMode op)