|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.print.attribute.Size2DSyntax
javax.print.attribute.standard.MediaSize
public class MediaSize
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.
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 | |
|---|---|
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. |
Class<? extends 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. |
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 |
|---|
public MediaSize(float x,
float y,
int units)
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.
x - the size in x directiony - the size in y directionunits - the units to use for the sizes
IllegalArgumentException - if x or y < 0 or units < 1findMedia(float, float, int),
getMediaSizeForName(MediaSizeName)
public MediaSize(float x,
float y,
int units,
MediaSizeName media)
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.
x - the size in x directiony - the size in y directionunits - the units to use for the sizesmedia - the media name to associate
IllegalArgumentException - if x or y < 0 or units < 1findMedia(float, float, int),
getMediaSizeForName(MediaSizeName)
public MediaSize(int x,
int y,
int units)
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.
x - the size in x directiony - the size in y directionunits - the units to use for the sizes
IllegalArgumentException - if x or y < 0 or units < 1findMedia(float, float, int),
getMediaSizeForName(MediaSizeName)
public MediaSize(int x,
int y,
int units,
MediaSizeName media)
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.
x - the size in x directiony - the size in y directionunits - the units to use for the sizesmedia - the media name to associate
IllegalArgumentException - if x or y < 0 or units < 1findMedia(float, float, int),
getMediaSizeForName(MediaSizeName)| Method Detail |
|---|
public Class<? extends Attribute> getCategory()
getCategory in interface AttributeMediaSize itself.
public static MediaSizeName findMedia(float x,
float y,
int units)
x - the dimension for xy - the dimension for yunits - the units to be used for comparison
public static MediaSize getMediaSizeForName(MediaSizeName media)
MediaSize instance for the
given named media MediaSizeName instance.
media - the named media to search for.
MediaSize instance or
null if none found.public boolean equals(Object obj)
equals in class Size2DSyntaxobj - the object to test
true if both objects are equal,
false otherwise.Object.hashCode()public MediaSizeName getMediaSizeName()
public final String getName()
getName in interface Attribute
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||