 Known Direct Subclasses
| MediaName |
Class MediaName is a subclass of Media, a printing attribute class (an
enumeration) that specifies the media for a print job as a name. |
| MediaSizeName |
Class MediaSizeName is a subclass of Media. |
| MediaTray |
Class MediaTray is a subclass of Media. |
|
Class Overview
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.
Summary
| Protected Constructors |
|---|
|
|
Media(int value)
Constructs a new media attribute specified by name.
|
| Public Methods |
|---|
|
boolean
|
equals(Object object)
Returns whether this media attribute is equivalent to the passed in
object.
|
|
final
Class<? extends Attribute>
|
getCategory()
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
|
|
final
String
|
getName()
Get the name of the category of which this attribute value is an
instance.
|
|
[Expand]
Inherited Methods |
|---|
From class
javax.print.attribute.EnumSyntax
|
Object
|
clone()
Returns a clone of this enumeration value, which to preserve the
semantics of enumeration values is the same object as this enumeration
value.
|
|
EnumSyntax[]
|
getEnumValueTable()
Returns the enumeration value table for this enumeration value's
enumeration class.
|
|
int
|
getOffset()
Returns the lowest integer value used by this enumeration value's
enumeration class.
|
|
String[]
|
getStringTable()
Returns the string table for this enumeration value's enumeration class.
|
|
int
|
getValue()
Returns this enumeration value's integer value.
|
|
int
|
hashCode()
Returns a hash code value for this enumeration value.
|
|
Object
|
readResolve()
During object input, convert this deserialized enumeration instance to
the proper enumeration value defined in the enumeration attribute class.
|
|
String
|
toString()
Returns a string value corresponding to this enumeration value.
|
|
From class
java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this object.
|
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
|
int
|
hashCode()
Returns a hash code value for the object.
|
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
|
String
|
toString()
Returns a string representation of the object.
|
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object. |
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed. |
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed. |
|
From interface
javax.print.attribute.Attribute
|
abstract
Class<? extends Attribute>
|
getCategory()
Get the printing attribute class which is to be used as the "category"
for this printing attribute value when it is added to an attribute set.
|
|
abstract
String
|
getName()
Get the name of the category of which this attribute value is an
instance.
|
|
Protected Constructors
protected
Media
(int value)
Constructs a new media attribute specified by name.
Public Methods
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.
Parameters
| object
| Object to compare to. |
Returns
- True if
object is equivalent to this media
attribute, false otherwise.
public
final
Class<? extends Attribute>
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.
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".