Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.print.attribute.standard

Class MediaSize

Implemented Interfaces:
Attribute, Cloneable, Serializable
public class MediaSize
extends Size2DSyntax
implements 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

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

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

Class<
? extends Attribute> getCategory()
Returns category of this class.
boolean
equals(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.
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.
String
getName()
Returns the name of this attribute.

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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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:
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:
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:
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:
IllegalArgumentException - if x or y < 0 or units < 1
See Also:
findMedia(float,float,int), getMediaSizeForName(MediaSizeName)

Method Details

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()
Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
The class MediaSize itself.

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.
Overrides:
equals in interface Size2DSyntax
Parameters:
obj - the object to test
Returns:
true if both objects are equal, false otherwise.

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.

getMediaSizeName

public MediaSizeName getMediaSizeName()
Returns the media name of this size.
Returns:
The media name.

getName

public final String getName()
Returns the name of this attribute.
Specified by:
getName in interface Attribute
Returns:
The name "media-size".
MediaSize.java -- Copyright (C) 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About