https://openjdk.java.net/ 
/*
 * Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.print.attribute.standard;

import java.awt.Window;
import java.io.Serial;

import javax.print.attribute.Attribute;
import javax.print.attribute.PrintRequestAttribute;

import sun.print.DialogOwnerAccessor;


An attribute class used to support requesting a print or page setup dialog
be kept displayed on top of all windows or some specific window.

 Constructed without any arguments it will request that a print or page setup dialog be configured as if the application directly was to specify java.awt.Window.setAlwaysOnTop(true), subject to permission checks. 
 Constructed with a Window parameter, it requests that the dialog be owned by the specified window. 
Since:11
/**
 * An attribute class used to support requesting a print or page setup dialog
 * be kept displayed on top of all windows or some specific window.
 * <p>
 * Constructed without any arguments it will request that a print or page
 * setup dialog be configured as if the application directly was to specify
 * {@code java.awt.Window.setAlwaysOnTop(true)}, subject to permission checks.
 * <p>
 * Constructed with a {@link java.awt.Window} parameter, it requests that
 * the dialog be owned by the specified window.
 *
 * @since 11
 */
public final class DialogOwner implements PrintRequestAttribute {

    private static class Accessor extends DialogOwnerAccessor {

         public long getOwnerID(DialogOwner owner) {
             return owner.getID();
         }
    }

    static private Accessor accessor = new Accessor();
    static {
             DialogOwnerAccessor.setAccessor(accessor);
    }

    
Use serialVersionUID from JDK 11 for interoperability.

/**
     * Use serialVersionUID from JDK 11 for interoperability.
     */
    @Serial
    private static final long serialVersionUID = -1901909867156076547L;

    
The owner of the dialog.

/**
     * The owner of the dialog.
     */
    private Window owner;
    private transient long id;

    
Constructs an instance which can be used to request java.awt.Window.setAlwaysOnTop(true) behaviour. This should be used where there is no application preferred owner window. Whether this has any effect depends on if always on top is supported for this platform and the particular dialog to be displayed. 
/**
     * Constructs an instance which can be used to request
     * {@code java.awt.Window.setAlwaysOnTop(true)} behaviour.
     * This should be used where there is no application preferred owner window.
     * Whether this has any effect depends on if always on top is supported
     * for this platform and the particular dialog to be displayed.
     */
    public DialogOwner() {
    }

    
Constructs an instance which can be used to request that the specified Window be the owner of the dialog. 
Params:
  • owner – window.
/**
     * Constructs an instance which can be used to request that the
     * specified {@link java.awt.Window} be the owner of the dialog.
     * @param owner window.
     */
    public DialogOwner(Window owner) {
        this.owner = owner;
    }

    
Constructs an instance which requests that the dialog be displayed as if it were a child of a native platform window, specified using its opqaue platform identifier or handle. This is useful mainly for the case where the id represents a window which may not be an AWT Window, but instead was created by another UI toolkit, such as OpenJFX. Any effect is platform dependent. 
Params:
  • id – a native window identifier or handle
/**
     * Constructs an instance which requests that the dialog be displayed
     * as if it were a child of a native platform window, specified
     * using its opqaue platform identifier or handle.
     * This is useful mainly for the case where the id represents a window
     * which may not be an AWT {@code Window}, but instead was created by
     * another UI toolkit, such as OpenJFX.
     * Any effect is platform dependent.
     * @param id a native window identifier or handle
     */
    DialogOwner(long id) {
        this.id = id;
    }

    
Returns a native platform id or handle, if one was specified,
otherwise, zero.

Returns:a native platform id.
/**
     * Returns a native platform id or handle, if one was specified,
     * otherwise, zero.
     * @return a native platform id.
     */
    long getID() {
        return id;
    }

    
Returns a Window owner, if one was specified, otherwise null. 
Returns:an owner window.
/**
     * Returns a {@code Window owner}, if one was specified,
     * otherwise {@code null}.
     * @return an owner window.
     */
    public Window getOwner() {
        return owner;
    }

    
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.

 For class DialogOwner, the category is class DialogOwner itself. 
Returns:printing attribute class (category), an instance of class java.lang.Class
/**
     * Get the printing attribute class which is to be used as the "category"
     * for this printing attribute value.
     * <p>
     * For class {@code DialogOwner}, the category is class
     * {@code DialogOwner} itself.
     *
     * @return printing attribute class (category), an instance of class
     *         {@link Class java.lang.Class}
     */
    public final Class<? extends Attribute> getCategory() {
        return DialogOwner.class;
    }

    
Get the name of the category of which this attribute value is an
instance.

 For class DialogOwner, the category name is "dialog-owner". 
/**
     * Get the name of the category of which this attribute value is an
     * instance.
     * <p>
     * For class {@code DialogOwner}, the category name is
     * {@code "dialog-owner"}.
     *
     */
    public final String getName() {
        return "dialog-owner";

    }
}