public class

MediaSize

extends Size2DSyntax
implements Attribute

java.lang.Object
↳	javax.print.attribute.Size2DSyntax
	↳	javax.print.attribute.standard.MediaSize

Class Overview

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 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.

Summary

Nested Classes
class	MediaSize.Engineering	Class MediaSize.Engineering includes `MediaSize` values for engineering media.
class	MediaSize.ISO	Class MediaSize.ISO includes `MediaSize` values for ISO media.
class	MediaSize.JIS	Class MediaSize.JIS includes `MediaSize` values for JIS (Japanese) media.
class	MediaSize.NA	Class MediaSize.NA includes `MediaSize` values for North American media.
class	MediaSize.Other	Class MediaSize.Other includes `MediaSize` values for miscellaneous media.

[Expand]

Inherited Constants

From class javax.print.attribute.Size2DSyntax

Public Constructors
	MediaSize(float x, float y, int units) 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(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, MediaSizeName media) Construct a new media size attribute from the given integer values.

Public Methods
boolean	equals(Object object) 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.
final Class<? extends Attribute>	getCategory() 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	getMediaSizeName() Get the media name, if any, for this size.
final String	getName() Get the name of the category of which this attribute value is an instance.

[Expand]

Inherited Methods

From class javax.print.attribute.Size2DSyntax

boolean	equals(Object object) Returns whether this two-dimensional size attribute is equivalent to the passed in object.
float[]	getSize(int units) Get this two-dimensional size attribute's dimensions in the given units as floating-point values.
float	getX(int units) Returns this two-dimensional size attribute's X dimension in the given units as a floating-point value.
int	getXMicrometers() Returns this two-dimensional size attribute's X dimension in units of micrometers (µm).
float	getY(int units) Returns this two-dimensional size attribute's Y dimension in the given units as a floating-point value.
int	getYMicrometers() Returns this two-dimensional size attribute's Y dimension in units of micrometers (µm).
int	hashCode() Returns a hash code value for this two-dimensional size attribute.
String	toString(int units, String unitsName) Returns a string version of this two-dimensional size attribute in the given units.
String	toString() Returns a string version of this two-dimensional size attribute.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.print.attribute.Attribute

Public Constructors

public MediaSize (float x, float y, int units)

Construct a new media size attribute from the given floating-point values.

Parameters

x	X dimension.
y	Y dimension.
units	Unit conversion factor, e.g. `Size2DSyntax.INCH` or `Size2DSyntax.MM`.

Throws

IllegalArgumentException	(Unchecked exception) Thrown if `x` < 0 or `y` < 0 or `units` < 1 or `x` > `y`.

public MediaSize (int x, int y, int units)

Construct a new media size attribute from the given integer values.

Parameters

x	X dimension.
y	Y dimension.
units	Unit conversion factor, e.g. `Size2DSyntax.INCH` or `Size2DSyntax.MM`.

Throws

IllegalArgumentException	(Unchecked exception) Thrown if `x` < 0 or `y` < 0 or `units` < 1 or `x` > `y`.

public MediaSize (float x, float y, int units, MediaSizeName media)

Construct a new media size attribute from the given floating-point values.

Parameters

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 MediaSize

Throws

IllegalArgumentException	(Unchecked exception) Thrown if `x` < 0 or `y` < 0 or `units` < 1 or `x` > `y`.

public MediaSize (int x, int y, int units, MediaSizeName media)

Construct a new media size attribute from the given integer values.

Parameters

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 MediaSize

Throws

IllegalArgumentException	(Unchecked exception) Thrown if `x` < 0 or `y` < 0 or `units` < 1 or `x` > `y`.

Public Methods

public boolean equals (Object object)

Returns whether this media size attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

object is not null.
object is an instance of class MediaSize.
This media size attribute's X dimension is equal to object's X dimension.
This media size attribute's Y dimension is equal to object's Y dimension.

Parameters

object	Object to compare to.

Returns

True if object is equivalent to this media size attribute, false otherwise.

public 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. If there is no exact match, the closest match is used.

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.

Parameters

x	- X dimension
y	- Y dimension.
units	Unit conversion factor, e.g. `Size2DSyntax.INCH` or `Size2DSyntax.MM`

Returns

MediaSizeName matching these dimensions, or null.

Throws

IllegalArgumentException	if x <= 0, y <= 0, or units < 1

public final Class<? extends Attribute> getCategory ()

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

For class MediaSize and any vendor-defined subclasses, the category is class MediaSize itself.

Returns

Printing attribute class (category), an instance of class java.lang.Class.

public static MediaSize getMediaSizeForName (MediaSizeName media)

Get the MediaSize for the specified named media.

Parameters

media	- the name of the media for which the size is sought

Returns

size of the media, or null if this media is not associated with any size.

public MediaSizeName getMediaSizeName ()

Get the media name, if any, for this size.

Returns

the name for this media size, or null if no name was associated with this size (an anonymous size).

public final String getName ()

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

For class MediaSize and any vendor-defined subclasses, the category name is "media-size".

Returns

Attribute category name.

Classes

MediaSize

Class Overview

Summary

Public Constructors

public MediaSize (float x, float y, int units)

Parameters

Throws

public MediaSize (int x, int y, int units)

Parameters

Throws

public MediaSize (float x, float y, int units, MediaSizeName media)

Parameters

Throws

public MediaSize (int x, int y, int units, MediaSizeName media)

Parameters

Throws

Public Methods

public boolean equals (Object object)

Parameters

Returns

public static MediaSizeName findMedia (float x, float y, int units)

Parameters

Returns

Throws

public final Class<? extends Attribute> getCategory ()

Returns

public static MediaSize getMediaSizeForName (MediaSizeName media)

Parameters

Returns

public MediaSizeName getMediaSizeName ()

Returns

public final String getName ()

Returns