javafx.print.PrinterAttributes Maven / Gradle / Ivy
/*
* Copyright (c) 2013, 2022, 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 javafx.print;
import java.util.Set;
import com.sun.javafx.print.PrinterImpl;
/**
* This class encapsulates the attributes of a printer which
* relate to its job printing capabilities and other attributes.
*
* there are methods to retrieve the default or current value,
* as well as the set or range of supported values, as appropriate.
*
* Instances of this class are delegates of the Printer
* and must be obtained from the printer. They cannot be mutated by
* the application as changing settings of a printer is outside the
* scope of this API.
*
* @since JavaFX 8.0
*/
public final class PrinterAttributes {
private PrinterImpl impl;
PrinterAttributes(PrinterImpl impl) {
this.impl = impl;
}
/**
* The default number of copies to print.
* @return default number of copies
*/
public int getDefaultCopies() {
return impl.defaultCopies();
}
/**
* The maximum supported number of copies.
* @return the maximum supported number of copies
*/
public int getMaxCopies() {
return impl.maxCopies();
}
/**
* Reports if page ranges are supported.
* @return true if page ranges supported.
*/
public boolean supportsPageRanges() {
return impl.supportsPageRanges();
}
/**
* The default collation setting.
* @return default value of Collation
*/
public Collation getDefaultCollation() {
return impl.defaultCollation();
}
/**
* Returns an unmodifiable set of the supported collation settings
* for this printer.
* @return the supported values of Collation
*/
public Set getSupportedCollations() {
return impl.supportedCollations();
}
/**
* Returns the default value for duplex settings.
* @return default value of PrintSides
*/
public PrintSides getDefaultPrintSides() {
return impl.defaultSides();
}
/**
* Returns an unmodifiable set of the supported duplex settings
* for this printer.
* @return the supported values of PrintSides
*/
public Set getSupportedPrintSides() {
return impl.supportedSides();
}
/**
* Get the default color setting : greyscale or color
* @return default print color setting.
*/
public PrintColor getDefaultPrintColor() {
return impl.defaultPrintColor();
}
/**
* Returns an unmodifiable set of the supported color settings
* for this printer.
* @return the supported values of PrintColor
*/
public Set getSupportedPrintColors() {
return impl.supportedPrintColor();
}
/**
* Return the default quality setting
* @return default print quality setting.
*/
public PrintQuality getDefaultPrintQuality() {
return impl.defaultPrintQuality();
}
/**
* Returns an unmodifiable set of the supported quality settings
* for this printer.
* @return the supported values of PrintQuality
*/
public Set getSupportedPrintQuality() {
return impl.supportedPrintQuality();
}
/**
* Return the default print resolution for paper on this printer.
* @return default paper resolution
*/
public PrintResolution getDefaultPrintResolution() {
return impl.defaultPrintResolution();
}
/**
* Returns an unmodifiable set of the supported print resolutions
* for this printer.
* @return the supported values of PrintResolution
*/
public Set getSupportedPrintResolutions() {
return impl.supportedPrintResolution();
}
/**
* Return the default orientation for paper on this printer.
* @return default paper orientation
*/
public PageOrientation getDefaultPageOrientation() {
return impl.defaultOrientation();
}
/**
* Returns an unmodifiable set of the supported orientations
* for this printer.
* @return the supported values of PageOrientation
*/
public Set getSupportedPageOrientations() {
return impl.supportedOrientation();
}
/**
* Return the default paper size used on this printer.
* @return default Paper
*/
public Paper getDefaultPaper() {
return impl.defaultPaper();
}
/**
* Returns an unmodifiable set of the supported paper sizes
* for this printer.
* @return the supported values of Paper
*/
public Set getSupportedPapers() {
return impl.supportedPapers();
}
/**
* Return the default paper input source/tray/
* @return the default paper input source.
*/
public PaperSource getDefaultPaperSource() {
return impl.defaultPaperSource();
}
/**
* Returns an unmodifiable set of the supported paper sources
* (ie input bins or trays) for this printer.
* @return the supported paper input sources
*/
public Set getSupportedPaperSources() {
return impl.supportedPaperSources();
}
}