| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class MediaSize extends Size2DSyntax implements Attribute
Class MediaSize is a two-dimensional size valued printing attribute class that indicates the dimensions of the medium in a portrait orientation, with the X dimension running along the bottom edge and the Y dimension running along the left edge. Thus, the Y dimension must be greater than or equal to the X dimension. Class MediaSize declares many standard media size values, organized into nested classes for ISO, JIS, North American, engineering, and other media.
MediaSize is not yet used to specify media. Its current role is
as a mapping for named media (see {@link MediaSizeName MediaSizeName}).
Clients can use the mapping method
MediaSize.getMediaSizeForName(MediaSizeName)
to find the physical dimensions of the MediaSizeName instances
enumerated in this API. This is useful for clients which need this
information to format & paginate printing.
Nested Class Summary | |
---|---|
static class |
Class MediaSize.Engineering includes javax.print.attribute.standard.MediaSize values for engineering media. |
static class |
Class MediaSize.ISO includes javax.print.attribute.standard.MediaSize values for ISO media. |
static class |
Class MediaSize.JIS includes javax.print.attribute.standard.MediaSize values for JIS (Japanese) media. |
static class |
Class MediaSize.NA includes javax.print.attribute.standard.MediaSize values for North American media. |
static class |
Class MediaSize.Other includes javax.print.attribute.standard.MediaSize values for miscellaneous media. |
Field Summary |
---|
Fields inherited from class javax.print.attribute.Size2DSyntax |
---|
INCH, MM |
Constructor Summary | |
---|---|
MediaSize(float x, float y, int units) Construct a new media size attribute from the given floating-point values. |
|
MediaSize(float x, float y, int units, MediaSizeName media) Construct a new media size attribute from the given floating-point values. |
|
MediaSize(int x, int y, int units) Construct a new media size attribute from the given integer values. |
|
MediaSize(int x, int y, int units, MediaSizeName media) Construct a new media size attribute from the given integer values. |
Method Summary | |
---|---|
boolean |
Returns whether this media size attribute is equivalent to the passed in object. |
static MediaSizeName |
findMedia(float x, float y, int units) The specified dimensions are used to locate a matching MediaSize instance from amongst all the standard MediaSize instances. |
Class |
Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
static MediaSize |
getMediaSizeForName(MediaSizeName media) Get the MediaSize for the specified named media. |
MediaSizeName |
Get the media name, if any, for this size. |
String |
getName() Get the name of the category of which this attribute value is an instance. |
Methods inherited from class javax.print.attribute.Size2DSyntax |
---|
equals, getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MediaSize(float x, float y, int units)
x
- X dimension.y
- Y dimension.units
- Unit conversion factor, e.g. Size2DSyntax.INCH
or
Size2DSyntax.MM
.public MediaSize(float x, float y, int units, MediaSizeName media)
x
- X dimension.y
- Y dimension.units
- Unit conversion factor, e.g. Size2DSyntax.INCH
or
Size2DSyntax.MM
.media
- a media name to associate with this MediaSizepublic MediaSize(int x, int y, int units)
x
- X dimension.y
- Y dimension.units
- Unit conversion factor, e.g. Size2DSyntax.INCH
or
Size2DSyntax.MM
.public MediaSize(int x, int y, int units, MediaSizeName media)
x
- X dimension.y
- Y dimension.units
- Unit conversion factor, e.g. Size2DSyntax.INCH
or
Size2DSyntax.MM
.media
- a media name to associate with this MediaSizeMethod Detail |
---|
public boolean equals(Object object)
object
is not null.
object
is an instance of class MediaSize.
object
's X dimension.
object
's Y dimension.
equals
in class Size2DSyntax
object
- Object to compare to.object
is equivalent to this media size
attribute, false otherwise.public static MediaSizeName findMedia(float x, float y, int units)
The MediaSize is in turn used to locate the MediaSizeName object. This method may return null if the closest matching MediaSize has no corresponding Media instance.
This method is useful for clients which have only dimensions and want to find a Media which corresponds to the dimensions.
x
- - X dimensiony
- - Y dimension.units
- Unit conversion factor, e.g. Size2DSyntax.INCH
or
Size2DSyntax.MM
public final Class getCategory()
For class MediaSize and any vendor-defined subclasses, the category is class MediaSize itself.
public static MediaSize getMediaSizeForName(MediaSizeName media)
media
- - the name of the media for which the size is soughtpublic MediaSizeName getMediaSizeName()
public final String getName()
For class MediaSize and any vendor-defined subclasses, the category
name is "media-size"
.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |