FileDocCategorySizeDatePackage
Media.javaAPI DocJava SE 6 API3421Tue Jun 10 00:26:24 BST 2008javax.print.attribute.standard

Media

public abstract class Media extends EnumSyntax implements PrintJobAttribute, PrintRequestAttribute, DocAttribute
Class Media is a printing attribute class that specifies the medium on which to print.

Media may be specified in different ways.

  • it may be specified by paper source - eg paper tray
  • it may be specified by a standard size - eg "A4"
  • it may be specified by a name - eg "letterhead"
Each of these corresponds to the IPP "media" attribute. The current API does not support describing media by characteristics (eg colour, opacity). This may be supported in a later revision of the specification.

A Media object is constructed with a value which represents one of the ways in which the Media attribute can be specified.

IPP Compatibility: The category name returned by getName() is the IPP attribute name. The enumeration's integer value is the IPP enum value. The toString() method returns the IPP string representation of the attribute value.

author
Phil Race

Fields Summary
private static final long
serialVersionUID
Constructors Summary
protected Media(int value)
Constructs a new media attribute specified by name.

param
value a value

  
     
                              
       
	   super (value);
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this media 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 of the same subclass of Media as this object.
  3. The values are equal.

param
object Object to compare to.
return
True if object is equivalent to this media attribute, false otherwise.

	return(object != null && object instanceof Media &&
	       object.getClass() == this.getClass() &&
	       ((Media)object).getValue() == this.getValue());
public final java.lang.ClassgetCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

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

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return Media.class;
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

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

return
Attribute category name.

	return "media";