javax.print.attribute.standard: abstract public class: Media

javax.print.attribute.standard
abstract public class: Media [javadoc | source]

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

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

Direct Known Subclasses:
MediaTray, MediaSizeName, MediaName

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

Constructor:

Constructor:
protected Media(int value) { super (value); } Constructs a new media attribute specified by name. Parameters: `value` - a value

 protected Media(int value) {
           super (value);
}

Constructs a new media attribute specified by name.

Parameters:

value - a value

Method from javax.print.attribute.standard.Media Summary:
equals, getCategory, getName

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

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

Method from javax.print.attribute.standard.Media Detail:
public boolean equals(Object object) { return(object != null && object instanceof Media && object.getClass() == this.getClass() && ((Media)object).getValue() == this.getValue()); } 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.
public final Class<Attribute> getCategory() { return Media.class; } 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.
public final String getName() { return "media"; } 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"`.

Method from javax.print.attribute.standard.Media Detail:

 public boolean equals(Object object) {
        return(object != null && object instanceof Media &&
               object.getClass() == this.getClass() &&
               ((Media)object).getValue() == this.getValue());
}

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

 public final Class<Attribute> getCategory() {
        return Media.class;
}

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

 public final String getName() {
        return "media";
}

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