javax.print.attribute.standard

Class MediaSize

java.lang.Object

javax.print.attribute.Size2DSyntax

javax.print.attribute.standard.MediaSize

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.print.attribute.Attribute

public class MediaSize
extends javax.print.attribute.Size2DSyntax
implements javax.print.attribute.Attribute

The MediaSize printing attribute class specifies the size of a printing media. The size is defined in portrait orientation with x at the bottom edge and y at the left edge.

There are several media sizes predefined through the nested classes. Further sizes may be provided by the application. MediaSize is not used as a printing attribute currently. It may be used to get the actual sizes for a named media or to find a suitable MediaSizeName instance by querying with the needed sizes.

IPP Compatibility: MediaSize is not an IPP 1.1 attribute.

See Also:

MediaSizeName, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaSize.Engineering Container class for predefined US Engineering media sizes.
static class	MediaSize.ISO Container class for predefined ISO media sizes.
static class	MediaSize.JIS Container class for predefined Japanese JIS media sizes.
static class	MediaSize.NA Container class for predefined North American media sizes.
static class	MediaSize.Other Container class for miscellaneous media sizes.

Field Summary

Fields inherited from class javax.print.attribute.Size2DSyntax

INCH, MM

Constructor Summary

Constructors

Constructor and Description
MediaSize(float x, float y, int units) Creates a MediaSize object.
MediaSize(float x, float y, int units, MediaSizeName media) Creates a MediaSize object associated with the given media name.
MediaSize(int x, int y, int units) Creates a MediaSize object.
MediaSize(int x, int y, int units, MediaSizeName media) Creates a MediaSize object associated with the given media name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tests if the given object is equal to this object.
static MediaSizeName	findMedia(float x, float y, int units) Searches for a MediaSize object with the given dimensions.
java.lang.Class<? extends javax.print.attribute.Attribute>	getCategory() Returns category of this class.
static MediaSize	getMediaSizeForName(MediaSizeName media) Returns the associated MediaSize instance for the given named media MediaSizeName instance.
MediaSizeName	getMediaSizeName() Returns the media name of this size.
java.lang.String	getName() Returns the name of this attribute.

Methods inherited from class javax.print.attribute.Size2DSyntax

getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MediaSize

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

Creates a MediaSize object. The created object will be added to an internal cache used in the static methods of this class for lookup of available MediaSize instances.

Parameters:

x - the size in x direction

y - the size in y direction

units - the units to use for the sizes

Throws:

java.lang.IllegalArgumentException - if x or y < 0 or units < 1

See Also:

findMedia(float, float, int), getMediaSizeForName(MediaSizeName)

MediaSize

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

Creates a MediaSize object associated with the given media name. The created object will be added to an internal cache used in the static methods of this class for lookup of available MediaSize instances.

Parameters:

x - the size in x direction

y - the size in y direction

units - the units to use for the sizes

media - the media name to associate

Throws:

java.lang.IllegalArgumentException - if x or y < 0 or units < 1

See Also:

findMedia(float, float, int), getMediaSizeForName(MediaSizeName)

MediaSize

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

Creates a MediaSize object. The created object will be added to an internal cache used in the static methods of this class for lookup of available MediaSize instances.

Parameters:

x - the size in x direction

y - the size in y direction

units - the units to use for the sizes

Throws:

java.lang.IllegalArgumentException - if x or y < 0 or units < 1

See Also:

findMedia(float, float, int), getMediaSizeForName(MediaSizeName)

MediaSize

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

Creates a MediaSize object associated with the given media name. The created object will be added to an internal cache used in the static methods of this class for lookup of available MediaSize instances.

Parameters:

x - the size in x direction

y - the size in y direction

units - the units to use for the sizes

media - the media name to associate

Throws:

java.lang.IllegalArgumentException - if x or y < 0 or units < 1

See Also:

findMedia(float, float, int), getMediaSizeForName(MediaSizeName)

Method Detail

getCategory

public java.lang.Class<? extends javax.print.attribute.Attribute> getCategory()

Returns category of this class.

Specified by:

getCategory in interface javax.print.attribute.Attribute

Returns:

The class MediaSize itself.

findMedia

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

Searches for a MediaSize object with the given dimensions. If none is found with exact dimensions, the closest match is used. Afterwards the MediaSizeName of the found MediaSize object is returned - which might be null if none is specified.

Parameters:

x - the dimension for x

y - the dimension for y

units - the units to be used for comparison

Returns:

the corresponding MediaSizeName object, or null

getMediaSizeForName

public static MediaSize getMediaSizeForName(MediaSizeName media)

Returns the associated MediaSize instance for the given named media MediaSizeName instance.

Parameters:

media - the named media to search for.

Returns:

The corresponding MediaSize instance or null if none found.

equals

public boolean equals(java.lang.Object obj)

Tests if the given object is equal to this object.

Overrides:

equals in class javax.print.attribute.Size2DSyntax

Parameters:

obj - the object to test

Returns:

true if both objects are equal, false otherwise.

See Also:

Object.hashCode()

getMediaSizeName

public MediaSizeName getMediaSizeName()

Returns the media name of this size.

Returns:

The media name.

getName

public final java.lang.String getName()

Returns the name of this attribute.

Specified by:

getName in interface javax.print.attribute.Attribute

Returns:

The name "media-size".