Class MediaPrintableArea
- All Implemented Interfaces:
- Serializable,- Attribute,- DocAttribute,- PrintJobAttribute,- PrintRequestAttribute
MediaPrintableArea is a printing attribute used to distinguish
 the printable and non-printable areas of media.
 The printable area is specified to be a rectangle, within the overall dimensions of a media.
Most printers cannot print on the entire surface of the media, due to printer hardware limitations. This class can be used to query the acceptable values for a supposed print job, and to request an area within the constraints of the printable area to be used in a print job.
To query for the printable area, a client must supply a suitable context. Without specifying at the very least the size of the media being used no meaningful value for printable area can be obtained.
The attribute is not described in terms of the distance from the edge of the paper, in part to emphasise that this attribute is not independent of a particular media, but must be described within the context of a choice of other attributes. Additionally it is usually more convenient for a client to use the printable area.
 The hardware's minimum margins is not just a property of the printer, but may
 be a function of the media size, orientation, media type, and any specified
 finishings. PrintService provides the method to query the supported
 values of an attribute in a suitable context : See
 PrintService.getSupportedAttributeValues()
 
The rectangular printable area is defined thus: The (x,y) origin is positioned at the top-left of the paper in portrait mode regardless of the orientation specified in the requesting context. For example a printable area for A4 paper in portrait or landscape orientation will have height > width.
A printable area attribute's values are stored internally as integers in units of micrometers (µm), where 1 micrometer = 10-6 meter = 1/1000 millimeter = 1/25400 inch. This permits dimensions to be represented exactly to a precision of 1/1000 mm (= 1 µm) or 1/100 inch (= 254 µm). If fractional inches are expressed in negative powers of two, this permits dimensions to be represented exactly to a precision of 1/8 inch (= 3175 µm) but not 1/16 inch (because 1/16 inch does not equal an integral number of µm).
IPP Compatibility: MediaPrintableArea is not an IPP attribute.
- See Also:
- 
Field SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionMediaPrintableArea(float x, float y, float w, float h, int units) Constructs aMediaPrintableAreaobject from floating point values.MediaPrintableArea(int x, int y, int w, int h, int units) Constructs aMediaPrintableAreaobject from integer values.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanReturns whether this media margins attribute is equivalent to the passed in object.Get the printing attribute class which is to be used as the "category" for this printing attribute value.floatgetHeight(int units) Get theheightof the printable area in the specified units.final StringgetName()Get the name of the category of which this attribute value is an instance.float[]getPrintableArea(int units) Get the printable area as an array of 4 values in the orderx, y, w, h.floatgetWidth(int units) Get thewidthof the printable area in the specified units.floatgetX(int units) Get thexlocation of the origin of the printable area in the specified units.floatgetY(int units) Get theylocation of the origin of the printable area in the specified units.inthashCode()Returns a hash code value for this attribute.toString()Returns a string version of this rectangular size attribute in mm.Returns a string version of this rectangular size attribute in the given units.
- 
Field Details- 
INCHpublic static final int INCHValue to indicate units of inches (in). It is actually the conversion factor by which to multiply inches to yield µm (25400).- See Also:
 
- 
MMpublic static final int MMValue to indicate units of millimeters (mm). It is actually the conversion factor by which to multiply mm to yield µm (1000).- See Also:
 
 
- 
- 
Constructor Details- 
MediaPrintableAreapublic MediaPrintableArea(float x, float y, float w, float h, int units) Constructs aMediaPrintableAreaobject from floating point values.- Parameters:
- x- printable x
- y- printable y
- w- printable width
- h- printable height
- units- in which the values are expressed
- Throws:
- IllegalArgumentException- if- x < 0or- y < 0or- w <= 0or- h <= 0or- units < 1
 
- 
MediaPrintableAreapublic MediaPrintableArea(int x, int y, int w, int h, int units) Constructs aMediaPrintableAreaobject from integer values.- Parameters:
- x- printable x
- y- printable y
- w- printable width
- h- printable height
- units- in which the values are expressed
- Throws:
- IllegalArgumentException- if- x < 0or- y < 0or- w <= 0or- h <= 0or- units < 1
 
 
- 
- 
Method Details- 
getPrintableAreapublic float[] getPrintableArea(int units) Get the printable area as an array of 4 values in the orderx, y, w, h. The values returned are in the given units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- Returns:
- printable area as array of x, y, w, hin the specified units
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
getXpublic float getX(int units) Get thexlocation of the origin of the printable area in the specified units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- Returns:
- xlocation of the origin of the printable area in the specified units
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
getYpublic float getY(int units) Get theylocation of the origin of the printable area in the specified units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- Returns:
- ylocation of the origin of the printable area in the specified units
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
getWidthpublic float getWidth(int units) Get thewidthof the printable area in the specified units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- Returns:
- widthof the printable area in the specified units
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
getHeightpublic float getHeight(int units) Get theheightof the printable area in the specified units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- Returns:
- heightof the printable area in the specified units
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
equalsReturns whether this media margins attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:- objectis not- null.
- objectis an instance of class- MediaPrintableArea.
- The origin and dimensions are the same.
 
- 
getCategoryGet the printing attribute class which is to be used as the "category" for this printing attribute value.For class MediaPrintableArea, the category is classMediaPrintableAreaitself.- Specified by:
- getCategoryin interface- Attribute
- Returns:
- printing attribute class (category), an instance of class
         java.lang.Class
 
- 
getName
- 
toStringReturns a string version of this rectangular size attribute in the given units.- Parameters:
- units- unit conversion factor, e.g.- INCHor- MM
- unitsName- units name string, e.g.- "in"or- "mm". If- null, no units name is appended to the result
- Returns:
- string version of this two-dimensional size attribute
- Throws:
- IllegalArgumentException- if- units < 1
 
- 
toString
- 
hashCode
 
-