Media (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
class Media

java.lang.Object
  javax.print.attribute.EnumSyntax
      javax.print.attribute.standard.Media

All Implemented Interfaces:: Serializable, Cloneable, DocAttribute, PrintJobAttribute, PrintRequestAttribute

Direct Known Subclasses:: MediaName, MediaSizeName, MediaTray

public abstract class Media
extends EnumSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute

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.

Constructor Summary
`protected`	`Media(int value)` Constructs a new media attribute specified by name.

Method Summary
`boolean`	`equals(Object object)` Returns whether this media attribute is equivalent to the passed in object.
`Class`	`getCategory()` Get the printing attribute class which is to be used as the "category" for this printing attribute value.
`String`	`getName()` Get the name of the category of which this attribute value is an instance.

Methods inherited from class javax.print.attribute.EnumSyntax
`clone, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Media

protected Media(int value)

Constructs a new media attribute specified by name.

Parameters:: value - a value

Method Detail

equals

public boolean equals(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:

object is not null.
object is of the same subclass of Media as this object.
The values are equal.

Overrides:: equals in class Object
Parameters:: object - Object to compare to.
Returns:: True if object is equivalent to this media attribute, false otherwise.

getCategory

public final Class getCategory()

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.

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

getName

public final String getName()

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".

Returns:: Attribute category name.