Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
Class MediaSize

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.Size2DSyntax sample code for javax.print.attribute.Size2DSyntax definition code for javax.print.attribute.Size2DSyntax 
      extended by javax.print.attribute.standard.MediaSize
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute 
public class MediaSize
extends Size2DSyntax sample code for javax.print.attribute.Size2DSyntax definition code for javax.print.attribute.Size2DSyntax 
implements Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.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 MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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.

See Also:
Serialized Form

Nested Class Summary
static class MediaSize.Engineering sample code for javax.print.attribute.standard.MediaSize.Engineering definition code for javax.print.attribute.standard.MediaSize.Engineering
          Class MediaSize.Engineering includes MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize values for engineering media.
static class MediaSize.ISO sample code for javax.print.attribute.standard.MediaSize.ISO definition code for javax.print.attribute.standard.MediaSize.ISO
          Class MediaSize.ISO includes MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize values for ISO media.
static class MediaSize.JIS sample code for javax.print.attribute.standard.MediaSize.JIS definition code for javax.print.attribute.standard.MediaSize.JIS
          Class MediaSize.JIS includes MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize values for JIS (Japanese) media.
static class MediaSize.NA sample code for javax.print.attribute.standard.MediaSize.NA definition code for javax.print.attribute.standard.MediaSize.NA
          Class MediaSize.NA includes MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize values for North American media.
static class MediaSize.Other sample code for javax.print.attribute.standard.MediaSize.Other definition code for javax.print.attribute.standard.MediaSize.Other
          Class MediaSize.Other includes MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize values for miscellaneous media.
 
Field Summary
 
Fields inherited from class javax.print.attribute.Size2DSyntax sample code for javax.print.attribute.Size2DSyntax definition code for javax.print.attribute.Size2DSyntax
INCH sample code for javax.print.attribute.Size2DSyntax.INCH definition code for javax.print.attribute.Size2DSyntax.INCH , MM sample code for javax.print.attribute.Size2DSyntax.MM definition code for javax.print.attribute.Size2DSyntax.MM
 
Constructor Summary
MediaSize sample code for javax.print.attribute.standard.MediaSize.MediaSize(float, float, int) definition code for javax.print.attribute.standard.MediaSize.MediaSize(float, float, int) (float x, float y, int units)
          Construct a new media size attribute from the given floating-point values.
MediaSize sample code for javax.print.attribute.standard.MediaSize.MediaSize(float, float, int, javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize.MediaSize(float, float, int, javax.print.attribute.standard.MediaSizeName) (float x, float y, int units, MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.MediaSizeName  media)
          Construct a new media size attribute from the given floating-point values.
MediaSize sample code for javax.print.attribute.standard.MediaSize.MediaSize(int, int, int) definition code for javax.print.attribute.standard.MediaSize.MediaSize(int, int, int) (int x, int y, int units)
          Construct a new media size attribute from the given integer values.
MediaSize sample code for javax.print.attribute.standard.MediaSize.MediaSize(int, int, int, javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize.MediaSize(int, int, int, javax.print.attribute.standard.MediaSizeName) (int x, int y, int units, MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.MediaSizeName  media)
          Construct a new media size attribute from the given integer values.
 
Method Summary
 boolean equals sample code for javax.print.attribute.standard.MediaSize.equals(java.lang.Object) definition code for javax.print.attribute.standard.MediaSize.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  object)
          Returns whether this media size attribute is equivalent to the passed in object.
static MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.MediaSizeName findMedia sample code for javax.print.attribute.standard.MediaSize.findMedia(float, float, int) definition code for javax.print.attribute.standard.MediaSize.findMedia(float, float, int) (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 sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory sample code for javax.print.attribute.standard.MediaSize.getCategory() definition code for javax.print.attribute.standard.MediaSize.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
static MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize getMediaSizeForName sample code for javax.print.attribute.standard.MediaSize.getMediaSizeForName(javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize.getMediaSizeForName(javax.print.attribute.standard.MediaSizeName) (MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.MediaSizeName  media)
          Get the MediaSize for the specified named media.
 MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.MediaSizeName getMediaSizeName sample code for javax.print.attribute.standard.MediaSize.getMediaSizeName() definition code for javax.print.attribute.standard.MediaSize.getMediaSizeName() ()
          Get the media name, if any, for this size.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.MediaSize.getName() definition code for javax.print.attribute.standard.MediaSize.getName() ()
          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.Size2DSyntax sample code for javax.print.attribute.Size2DSyntax definition code for javax.print.attribute.Size2DSyntax
getSize sample code for javax.print.attribute.Size2DSyntax.getSize(int) definition code for javax.print.attribute.Size2DSyntax.getSize(int) , getX sample code for javax.print.attribute.Size2DSyntax.getX(int) definition code for javax.print.attribute.Size2DSyntax.getX(int) , getXMicrometers sample code for javax.print.attribute.Size2DSyntax.getXMicrometers() definition code for javax.print.attribute.Size2DSyntax.getXMicrometers() , getY sample code for javax.print.attribute.Size2DSyntax.getY(int) definition code for javax.print.attribute.Size2DSyntax.getY(int) , getYMicrometers sample code for javax.print.attribute.Size2DSyntax.getYMicrometers() definition code for javax.print.attribute.Size2DSyntax.getYMicrometers() , hashCode sample code for javax.print.attribute.Size2DSyntax.hashCode() definition code for javax.print.attribute.Size2DSyntax.hashCode() , toString sample code for javax.print.attribute.Size2DSyntax.toString() definition code for javax.print.attribute.Size2DSyntax.toString() , toString sample code for javax.print.attribute.Size2DSyntax.toString(int, java.lang.String) definition code for javax.print.attribute.Size2DSyntax.toString(int, java.lang.String)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

MediaSize sample code for javax.print.attribute.standard.MediaSize(float, float, int) definition code for javax.print.attribute.standard.MediaSize(float, float, int) 

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1 or x > y.

MediaSize sample code for javax.print.attribute.standard.MediaSize(int, int, int) definition code for javax.print.attribute.standard.MediaSize(int, int, int) 

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1 or x > y.

MediaSize sample code for javax.print.attribute.standard.MediaSize(float, float, int, javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize(float, float, int, javax.print.attribute.standard.MediaSizeName) 

public MediaSize(float x,
                 float y,
                 int units,
                 MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1 or x > y.

MediaSize sample code for javax.print.attribute.standard.MediaSize(int, int, int, javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize(int, int, int, javax.print.attribute.standard.MediaSizeName) 

public MediaSize(int x,
                 int y,
                 int units,
                 MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1 or x > y.
Method Detail

getMediaSizeName sample code for javax.print.attribute.standard.MediaSize.getMediaSizeName() definition code for javax.print.attribute.standard.MediaSize.getMediaSizeName() 

public MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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).

getMediaSizeForName sample code for javax.print.attribute.standard.MediaSize.getMediaSizeForName(javax.print.attribute.standard.MediaSizeName) definition code for javax.print.attribute.standard.MediaSize.getMediaSizeForName(javax.print.attribute.standard.MediaSizeName) 

public static MediaSize sample code for javax.print.attribute.standard.MediaSize definition code for javax.print.attribute.standard.MediaSize  getMediaSizeForName(MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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.

findMedia sample code for javax.print.attribute.standard.MediaSize.findMedia(float, float, int) definition code for javax.print.attribute.standard.MediaSize.findMedia(float, float, int) 

public static MediaSizeName sample code for javax.print.attribute.standard.MediaSizeName definition code for javax.print.attribute.standard.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if x <= 0, y <= 0, or units < 1

equals sample code for javax.print.attribute.standard.MediaSize.equals(java.lang.Object) definition code for javax.print.attribute.standard.MediaSize.equals(java.lang.Object) 

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.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:
  1. object is not null.
  2. object is an instance of class MediaSize.
  3. This media size attribute's X dimension is equal to object's X dimension.
  4. This media size attribute's Y dimension is equal to object's Y dimension.

Overrides:
equals sample code for javax.print.attribute.Size2DSyntax.equals(java.lang.Object) definition code for javax.print.attribute.Size2DSyntax.equals(java.lang.Object) in class Size2DSyntax sample code for javax.print.attribute.Size2DSyntax definition code for javax.print.attribute.Size2DSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this media size attribute, false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

getCategory sample code for javax.print.attribute.standard.MediaSize.getCategory() definition code for javax.print.attribute.standard.MediaSize.getCategory() 

public final Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.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.

Specified by:
getCategory sample code for javax.print.attribute.Attribute.getCategory() definition code for javax.print.attribute.Attribute.getCategory() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class sample code for java.lang.Class definition code for java.lang.Class .

getName sample code for javax.print.attribute.standard.MediaSize.getName() definition code for javax.print.attribute.standard.MediaSize.getName() 

public final String sample code for java.lang.String definition code for java.lang.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".

Specified by:
getName sample code for javax.print.attribute.Attribute.getName() definition code for javax.print.attribute.Attribute.getName() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Attribute category name.
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD