| |
|
| java.lang.Object java.awt.PageAttributes
PageAttributes | final public class PageAttributes implements Cloneable(Code) | | A set of attributes which control the output of a printed page.
Instances of this class control the color state, paper size (media type),
orientation, logical origin, print quality, and resolution of every
page which uses the instance. Attribute names are compliant with the
Internet Printing Protocol (IPP) 1.1 where possible. Attribute values
are partially compliant where possible.
To use a method which takes an inner class type, pass a reference to
one of the constant fields of the inner class. Client code cannot create
new instances of the inner class types because none of those classes
has a public constructor. For example, to set the color state to
monochrome, use the following code:
import java.awt.PageAttributes;
public class MonochromeExample {
public void setMonochrome(PageAttributes pageAttributes) {
pageAttributes.setColor(PageAttributes.ColorType.MONOCHROME);
}
}
Every IPP attribute which supports an attributeName-default value
has a corresponding setattributeNameToDefault method.
Default value fields are not provided.
version: 1.15, 05/05/07 author: David Mendenhall since: 1.3 |
Inner Class :final public static class ColorType extends AttributeValue | |
Inner Class :final public static class MediaType extends AttributeValue | |
Inner Class :final public static class OrientationRequestedType extends AttributeValue | |
Inner Class :final public static class OriginType extends AttributeValue | |
Inner Class :final public static class PrintQualityType extends AttributeValue | |
Constructor Summary | |
public | PageAttributes() Constructs a PageAttributes instance with default values for every
attribute. | public | PageAttributes(PageAttributes obj) Constructs a PageAttributes instance which is a copy of the supplied
PageAttributes. | public | PageAttributes(ColorType color, MediaType media, OrientationRequestedType orientationRequested, OriginType origin, PrintQualityType printQuality, int[] printerResolution) Constructs a PageAttributes instance with the specified values for
every attribute.
Parameters: color - ColorType.COLOR or ColorType.MONOCHROME. Parameters: media - one of the constant fields of the MediaType class. Parameters: orientationRequested - OrientationRequestedType.PORTRAIT orOrientationRequestedType.LANDSCAPE. Parameters: origin - OriginType.PHYSICAL or OriginType.PRINTABLE Parameters: printQuality - PrintQualityType.DRAFT, PrintQualityType.NORMAL,or PrintQualityType.HIGH Parameters: printerResolution - an integer array of 3 elements. |
Method Summary | |
public Object | clone() Creates and returns a copy of this PageAttributes.
the newly created copy. | public boolean | equals(Object obj) Determines whether two PageAttributes are equal to each other.
Two PageAttributes are equal if and only if each of their attributes are
equal. | public ColorType | getColor() Returns whether pages using these attributes will be rendered in
color or monochrome. | public MediaType | getMedia() Returns the paper size for pages using these attributes. | public OrientationRequestedType | getOrientationRequested() Returns the print orientation for pages using these attributes. | public OriginType | getOrigin() Returns whether drawing at (0, 0) to pages using these attributes
draws at the upper-left corner of the physical page, or at the
upper-left corner of the printable area. | public PrintQualityType | getPrintQuality() Returns the print quality for pages using these attributes. | public int[] | getPrinterResolution() Returns the print resolution for pages using these attributes.
Index 0 of the array specifies the cross feed direction resolution
(typically the horizontal resolution). | public int | hashCode() Returns a hash code value for this PageAttributes. | public void | set(PageAttributes obj) Sets all of the attributes of this PageAttributes to the same values as
the attributes of obj. | public void | setColor(ColorType color) Specifies whether pages using these attributes will be rendered in
color or monochrome. | public void | setMedia(MediaType media) Specifies the desired paper size for pages using these attributes. | public void | setMediaToDefault() Sets the paper size for pages using these attributes to the default
size for the default locale. | public void | setOrientationRequested(OrientationRequestedType orientationRequested) Specifies the print orientation for pages using these attributes. | public void | setOrientationRequested(int orientationRequested) Specifies the print orientation for pages using these attributes.
Specifying 3 denotes portrait. | public void | setOrientationRequestedToDefault() Sets the print orientation for pages using these attributes to the
default. | public void | setOrigin(OriginType origin) Specifies whether drawing at (0, 0) to pages using these attributes
draws at the upper-left corner of the physical page, or at the
upper-left corner of the printable area. | public void | setPrintQuality(PrintQualityType printQuality) Specifies the print quality for pages using these attributes. | public void | setPrintQuality(int printQuality) Specifies the print quality for pages using these attributes.
Specifying 3 denotes draft. | public void | setPrintQualityToDefault() Sets the print quality for pages using these attributes to the default. | public void | setPrinterResolution(int[] printerResolution) Specifies the desired print resolution for pages using these attributes.
The actual resolution will be determined by the limitations of the
implementation and the target printer. | public void | setPrinterResolution(int printerResolution) Specifies the desired cross feed and feed print resolutions in dots per
inch for pages using these attributes. | public void | setPrinterResolutionToDefault() Sets the printer resolution for pages using these attributes to the
default. | public String | toString() Returns a string representation of this PageAttributes. |
PageAttributes | public PageAttributes()(Code) | | Constructs a PageAttributes instance with default values for every
attribute.
|
PageAttributes | public PageAttributes(PageAttributes obj)(Code) | | Constructs a PageAttributes instance which is a copy of the supplied
PageAttributes.
Parameters: obj - the PageAttributes to copy. |
PageAttributes | public PageAttributes(ColorType color, MediaType media, OrientationRequestedType orientationRequested, OriginType origin, PrintQualityType printQuality, int[] printerResolution)(Code) | | Constructs a PageAttributes instance with the specified values for
every attribute.
Parameters: color - ColorType.COLOR or ColorType.MONOCHROME. Parameters: media - one of the constant fields of the MediaType class. Parameters: orientationRequested - OrientationRequestedType.PORTRAIT orOrientationRequestedType.LANDSCAPE. Parameters: origin - OriginType.PHYSICAL or OriginType.PRINTABLE Parameters: printQuality - PrintQualityType.DRAFT, PrintQualityType.NORMAL,or PrintQualityType.HIGH Parameters: printerResolution - an integer array of 3 elements. The firstelement must be greater than 0. The second element must bemust be greater than 0. The third element must be either3 or 4 . throws: IllegalArgumentException - if one or more of the aboveconditions is violated. |
clone | public Object clone()(Code) | | Creates and returns a copy of this PageAttributes.
the newly created copy. It is safe to cast this Object intoa PageAttributes. |
equals | public boolean equals(Object obj)(Code) | | Determines whether two PageAttributes are equal to each other.
Two PageAttributes are equal if and only if each of their attributes are
equal. Attributes of enumeration type are equal if and only if the
fields refer to the same unique enumeration object. This means that
an aliased media is equal to its underlying unique media. Printer
resolutions are equal if and only if the feed resolution, cross feed
resolution, and units are equal.
Parameters: obj - the object whose equality will be checked. whether obj is equal to this PageAttribute according to theabove criteria. |
getColor | public ColorType getColor()(Code) | | Returns whether pages using these attributes will be rendered in
color or monochrome. This attribute is updated to the value chosen
by the user.
ColorType.COLOR or ColorType.MONOCHROME. |
getMedia | public MediaType getMedia()(Code) | | Returns the paper size for pages using these attributes. This
attribute is updated to the value chosen by the user.
one of the constant fields of the MediaType class. |
getOrientationRequested | public OrientationRequestedType getOrientationRequested()(Code) | | Returns the print orientation for pages using these attributes. This
attribute is updated to the value chosen by the user.
OrientationRequestedType.PORTRAIT orOrientationRequestedType.LANDSCAPE. |
getOrigin | public OriginType getOrigin()(Code) | | Returns whether drawing at (0, 0) to pages using these attributes
draws at the upper-left corner of the physical page, or at the
upper-left corner of the printable area. (Note that these locations
could be equivalent.) This attribute cannot be modified by,
and is not subject to any limitations of, the implementation or the
target printer.
OriginType.PHYSICAL or OriginType.PRINTABLE |
getPrintQuality | public PrintQualityType getPrintQuality()(Code) | | Returns the print quality for pages using these attributes. This
attribute is updated to the value chosen by the user.
PrintQualityType.DRAFT, PrintQualityType.NORMAL, orPrintQualityType.HIGH |
getPrinterResolution | public int[] getPrinterResolution()(Code) | | Returns the print resolution for pages using these attributes.
Index 0 of the array specifies the cross feed direction resolution
(typically the horizontal resolution). Index 1 of the array specifies
the feed direction resolution (typically the vertical resolution).
Index 2 of the array specifies whether the resolutions are in dots per
inch or dots per centimeter. 3 denotes dots per inch.
4 denotes dots per centimeter.
an integer array of 3 elements. The firstelement must be greater than 0. The second element must bemust be greater than 0. The third element must be either3 or 4 . |
hashCode | public int hashCode()(Code) | | Returns a hash code value for this PageAttributes.
the hash code. |
set | public void set(PageAttributes obj)(Code) | | Sets all of the attributes of this PageAttributes to the same values as
the attributes of obj.
Parameters: obj - the PageAttributes to copy. |
setColor | public void setColor(ColorType color)(Code) | | Specifies whether pages using these attributes will be rendered in
color or monochrome. Not specifying this attribute is equivalent to
specifying ColorType.MONOCHROME.
Parameters: color - ColorType.COLOR or ColorType.MONOCHROME. throws: IllegalArgumentException - if color is null. |
setMedia | public void setMedia(MediaType media)(Code) | | Specifies the desired paper size for pages using these attributes. The
actual paper size will be determined by the limitations of the target
printer. If an exact match cannot be found, an implementation will
choose the closest possible match. Not specifying this attribute is
equivalent to specifying the default size for the default locale. The
default size for locales in the United States and Canada is
MediaType.NA_LETTER. The default size for all other locales is
MediaType.ISO_A4.
Parameters: media - one of the constant fields of the MediaType class. throws: IllegalArgumentException - if media is null. |
setMediaToDefault | public void setMediaToDefault()(Code) | | Sets the paper size for pages using these attributes to the default
size for the default locale. The default size for locales in the
United States and Canada is MediaType.NA_LETTER. The default size for
all other locales is MediaType.ISO_A4.
|
setOrientationRequested | public void setOrientationRequested(OrientationRequestedType orientationRequested)(Code) | | Specifies the print orientation for pages using these attributes. Not
specifying the property is equivalent to specifying
OrientationRequestedType.PORTRAIT.
Parameters: orientationRequested - OrientationRequestedType.PORTRAIT orOrientationRequestedType.LANDSCAPE. throws: IllegalArgumentException - if orientationRequested is null. |
setOrientationRequested | public void setOrientationRequested(int orientationRequested)(Code) | | Specifies the print orientation for pages using these attributes.
Specifying 3 denotes portrait. Specifying 4
denotes landscape. Specifying any other value will generate an
IllegalArgumentException. Not specifying the property is equivalent
to calling setOrientationRequested(OrientationRequestedType.PORTRAIT).
Parameters: orientationRequested - 3 or 4 throws: IllegalArgumentException - if orientationRequested is not3 or 4 |
setOrientationRequestedToDefault | public void setOrientationRequestedToDefault()(Code) | | Sets the print orientation for pages using these attributes to the
default. The default orientation is portrait.
|
setOrigin | public void setOrigin(OriginType origin)(Code) | | Specifies whether drawing at (0, 0) to pages using these attributes
draws at the upper-left corner of the physical page, or at the
upper-left corner of the printable area. (Note that these locations
could be equivalent.) Not specifying the property is equivalent to
specifying OriginType.PHYSICAL.
Parameters: origin - OriginType.PHYSICAL or OriginType.PRINTABLE throws: IllegalArgumentException - if origin is null. |
setPrintQuality | public void setPrintQuality(PrintQualityType printQuality)(Code) | | Specifies the print quality for pages using these attributes. Not
specifying the property is equivalent to specifying
PrintQualityType.NORMAL.
Parameters: printQuality - PrintQualityType.DRAFT, PrintQualityType.NORMAL,or PrintQualityType.HIGH throws: IllegalArgumentException - if printQuality is null. |
setPrintQuality | public void setPrintQuality(int printQuality)(Code) | | Specifies the print quality for pages using these attributes.
Specifying 3 denotes draft. Specifying 4
denotes normal. Specifying 5 denotes high. Specifying
any other value will generate an IllegalArgumentException. Not
specifying the property is equivalent to calling
setPrintQuality(PrintQualityType.NORMAL).
Parameters: printQuality - 3 , 4 , or 5 throws: IllegalArgumentException - if printQuality is not 3 , 4 , or 5 |
setPrintQualityToDefault | public void setPrintQualityToDefault()(Code) | | Sets the print quality for pages using these attributes to the default.
The default print quality is normal.
|
setPrinterResolution | public void setPrinterResolution(int[] printerResolution)(Code) | | Specifies the desired print resolution for pages using these attributes.
The actual resolution will be determined by the limitations of the
implementation and the target printer. Index 0 of the array specifies
the cross feed direction resolution (typically the horizontal
resolution). Index 1 of the array specifies the feed direction
resolution (typically the vertical resolution). Index 2 of the array
specifies whether the resolutions are in dots per inch or dots per
centimeter. 3 denotes dots per inch. 4
denotes dots per centimeter. Note that the 1.1 printing implementation
(Toolkit.getPrintJob) requires that the feed and cross feed resolutions
be the same. Not specifying the property is equivalent to calling
setPrinterResolution(72).
Parameters: printerResolution - an integer array of 3 elements. The firstelement must be greater than 0. The second element must bemust be greater than 0. The third element must be either3 or 4 . throws: IllegalArgumentException - if one or more of the aboveconditions is violated. |
setPrinterResolution | public void setPrinterResolution(int printerResolution)(Code) | | Specifies the desired cross feed and feed print resolutions in dots per
inch for pages using these attributes. The same value is used for both
resolutions. The actual resolutions will be determined by the
limitations of the implementation and the target printer. Not
specifying the property is equivalent to specifying 72 .
Parameters: printerResolution - an integer greater than 0. throws: IllegalArgumentException - if printerResolution is less than orequal to 0. |
setPrinterResolutionToDefault | public void setPrinterResolutionToDefault()(Code) | | Sets the printer resolution for pages using these attributes to the
default. The default is 72 dpi for both the feed and cross feed
resolutions.
|
toString | public String toString()(Code) | | Returns a string representation of this PageAttributes.
the string representation. |
|
|
|