javax.print.attribute.standard
Class OrientationRequested

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax 
      extended by javax.print.attribute.standard.OrientationRequested
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 , DocAttribute sample code for javax.print.attribute.DocAttribute definition code for javax.print.attribute.DocAttribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute , PrintRequestAttribute sample code for javax.print.attribute.PrintRequestAttribute definition code for javax.print.attribute.PrintRequestAttribute

public final class OrientationRequested
extends EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
implements DocAttribute sample code for javax.print.attribute.DocAttribute definition code for javax.print.attribute.DocAttribute , PrintRequestAttribute sample code for javax.print.attribute.PrintRequestAttribute definition code for javax.print.attribute.PrintRequestAttribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute

Class OrientationRequested is a printing attribute class, an enumeration, that indicates the desired orientation for printed print-stream pages; it does not describe the orientation of the client-supplied print-stream pages.

For some document formats (such as "application/postscript"), the desired orientation of the print-stream pages is specified within the document data. This information is generated by a device driver prior to the submission of the print job. Other document formats (such as "text/plain") do not include the notion of desired orientation within the document data. In the latter case it is possible for the printer to bind the desired orientation to the document data after it has been submitted. It is expected that a printer would only support the OrientationRequested attribute for some document formats (e.g., "text/plain" or "text/html") but not others (e.g. "application/postscript"). This is no different from any other job template attribute, since a print job can always impose constraints among the values of different job template attributes. However, a special mention is made here since it is very likely that a printer will support the OrientationRequested attribute for only a subset of the supported document formats.

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.

See Also:
Serialized Form

Field Summary
static OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested LANDSCAPE sample code for javax.print.attribute.standard.OrientationRequested.LANDSCAPE definition code for javax.print.attribute.standard.OrientationRequested.LANDSCAPE
          The content will be imaged across the long edge of the medium.
static OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested PORTRAIT sample code for javax.print.attribute.standard.OrientationRequested.PORTRAIT definition code for javax.print.attribute.standard.OrientationRequested.PORTRAIT
          The content will be imaged across the short edge of the medium.
static OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested REVERSE_LANDSCAPE sample code for javax.print.attribute.standard.OrientationRequested.REVERSE_LANDSCAPE definition code for javax.print.attribute.standard.OrientationRequested.REVERSE_LANDSCAPE
          The content will be imaged across the long edge of the medium, but in the opposite manner from landscape.
static OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested REVERSE_PORTRAIT sample code for javax.print.attribute.standard.OrientationRequested.REVERSE_PORTRAIT definition code for javax.print.attribute.standard.OrientationRequested.REVERSE_PORTRAIT
          The content will be imaged across the short edge of the medium, but in the opposite manner from portrait.
 
Constructor Summary
protected OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested.OrientationRequested(int) definition code for javax.print.attribute.standard.OrientationRequested.OrientationRequested(int) (int value)
          Construct a new orientation requested enumeration value with the given integer value.
 
Method Summary
 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.OrientationRequested.getCategory() definition code for javax.print.attribute.standard.OrientationRequested.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
protected  EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable sample code for javax.print.attribute.standard.OrientationRequested.getEnumValueTable() definition code for javax.print.attribute.standard.OrientationRequested.getEnumValueTable() ()
          Returns the enumeration value table for class OrientationRequested.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.OrientationRequested.getName() definition code for javax.print.attribute.standard.OrientationRequested.getName() ()
          Get the name of the category of which this attribute value is an instance.
protected  int getOffset sample code for javax.print.attribute.standard.OrientationRequested.getOffset() definition code for javax.print.attribute.standard.OrientationRequested.getOffset() ()
          Returns the lowest integer value used by class OrientationRequested.
protected  String sample code for java.lang.String definition code for java.lang.String [] getStringTable sample code for javax.print.attribute.standard.OrientationRequested.getStringTable() definition code for javax.print.attribute.standard.OrientationRequested.getStringTable() ()
          Returns the string table for class OrientationRequested.
 
Methods inherited from class javax.print.attribute.EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
clone sample code for javax.print.attribute.EnumSyntax.clone() definition code for javax.print.attribute.EnumSyntax.clone() , getValue sample code for javax.print.attribute.EnumSyntax.getValue() definition code for javax.print.attribute.EnumSyntax.getValue() , hashCode sample code for javax.print.attribute.EnumSyntax.hashCode() definition code for javax.print.attribute.EnumSyntax.hashCode() , readResolve sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve() , toString sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , 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)
 

Field Detail

PORTRAIT sample code for javax.print.attribute.standard.OrientationRequested.PORTRAIT

public static final OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested  PORTRAIT
The content will be imaged across the short edge of the medium.


LANDSCAPE sample code for javax.print.attribute.standard.OrientationRequested.LANDSCAPE

public static final OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested  LANDSCAPE
The content will be imaged across the long edge of the medium. Landscape is defined to be a rotation of the print-stream page to be imaged by +90 degrees with respect to the medium (i.e. anti-clockwise) from the portrait orientation. Note: The +90 direction was chosen because simple finishing on the long edge is the same edge whether portrait or landscape.


REVERSE_LANDSCAPE sample code for javax.print.attribute.standard.OrientationRequested.REVERSE_LANDSCAPE

public static final OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested  REVERSE_LANDSCAPE
The content will be imaged across the long edge of the medium, but in the opposite manner from landscape. Reverse-landscape is defined to be a rotation of the print-stream page to be imaged by -90 degrees with respect to the medium (i.e. clockwise) from the portrait orientation. Note: The REVERSE_LANDSCAPE value was added because some applications rotate landscape -90 degrees from portrait, rather than +90 degrees.


REVERSE_PORTRAIT sample code for javax.print.attribute.standard.OrientationRequested.REVERSE_PORTRAIT

public static final OrientationRequested sample code for javax.print.attribute.standard.OrientationRequested definition code for javax.print.attribute.standard.OrientationRequested  REVERSE_PORTRAIT
The content will be imaged across the short edge of the medium, but in the opposite manner from portrait. Reverse-portrait is defined to be a rotation of the print-stream page to be imaged by 180 degrees with respect to the medium from the portrait orientation. Note: The REVERSE_PORTRAIT value was added for use with the Finishings sample code for javax.print.attribute.standard.Finishings definition code for javax.print.attribute.standard.Finishings attribute in cases where the opposite edge is desired for finishing a portrait document on simple finishing devices that have only one finishing position. Thus a "text/plain" portrait document can be stapled "on the right" by a simple finishing device as is common use with some Middle Eastern languages such as Hebrew.

Constructor Detail

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

protected OrientationRequested(int value)
Construct a new orientation requested enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getStringTable sample code for javax.print.attribute.standard.OrientationRequested.getStringTable() definition code for javax.print.attribute.standard.OrientationRequested.getStringTable()

protected String sample code for java.lang.String definition code for java.lang.String [] getStringTable()
Returns the string table for class OrientationRequested.

Overrides:
getStringTable sample code for javax.print.attribute.EnumSyntax.getStringTable() definition code for javax.print.attribute.EnumSyntax.getStringTable() in class EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
Returns:
the string table

getEnumValueTable sample code for javax.print.attribute.standard.OrientationRequested.getEnumValueTable() definition code for javax.print.attribute.standard.OrientationRequested.getEnumValueTable()

protected EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable()
Returns the enumeration value table for class OrientationRequested.

Overrides:
getEnumValueTable sample code for javax.print.attribute.EnumSyntax.getEnumValueTable() definition code for javax.print.attribute.EnumSyntax.getEnumValueTable() in class EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
Returns:
the value table

getOffset sample code for javax.print.attribute.standard.OrientationRequested.getOffset() definition code for javax.print.attribute.standard.OrientationRequested.getOffset()

protected int getOffset()
Returns the lowest integer value used by class OrientationRequested.

Overrides:
getOffset sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.getOffset() in class EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
Returns:
the offset of the lowest enumeration value.

getCategory sample code for javax.print.attribute.standard.OrientationRequested.getCategory() definition code for javax.print.attribute.standard.OrientationRequested.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 OrientationRequested, the category is class OrientationRequested 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.OrientationRequested.getName() definition code for javax.print.attribute.standard.OrientationRequested.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 OrientationRequested, the category name is "orientation-requested".

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.