java.awt
Class PageAttributes

java.lang.Object
  extended by java.awt.PageAttributes
All Implemented Interfaces:
Cloneable

public final class PageAttributes
extends Object
implements Cloneable

Missing Documentation

Since:
1.3

Nested Class Summary
static class PageAttributes.ColorType
           
static class PageAttributes.MediaType
           
static class PageAttributes.OrientationRequestedType
           
static class PageAttributes.OriginType
           
static class PageAttributes.PrintQualityType
           
 
Constructor Summary
PageAttributes()
           
PageAttributes(PageAttributes.ColorType color, PageAttributes.MediaType media, PageAttributes.OrientationRequestedType orientation, PageAttributes.OriginType origin, PageAttributes.PrintQualityType quality, int[] resolution)
           
PageAttributes(PageAttributes attr)
           
 
Method Summary
 Object clone()
          This method may be called to create a new copy of the Object.
 boolean equals(Object o)
          Determine whether this Object is semantically equal to another Object.
 PageAttributes.ColorType getColor()
           
 PageAttributes.MediaType getMedia()
           
 PageAttributes.OrientationRequestedType getOrientationRequested()
           
 PageAttributes.OriginType getOrigin()
           
 int[] getPrinterResolution()
           
 PageAttributes.PrintQualityType getPrintQuality()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 void set(PageAttributes attr)
           
 void setColor(PageAttributes.ColorType color)
           
 void setMedia(PageAttributes.MediaType media)
           
 void setMediaToDefault()
           
 void setOrientationRequested(int orientation)
           
 void setOrientationRequested(PageAttributes.OrientationRequestedType orientation)
           
 void setOrientationRequestedToDefault()
           
 void setOrigin(PageAttributes.OriginType origin)
           
 void setPrinterResolution(int resolution)
           
 void setPrinterResolution(int[] resolution)
           
 void setPrinterResolutionToDefault()
           
 void setPrintQuality(int quality)
           
 void setPrintQuality(PageAttributes.PrintQualityType quality)
           
 void setPrintQualityToDefault()
           
 String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageAttributes

public PageAttributes()

PageAttributes

public PageAttributes(PageAttributes attr)

PageAttributes

public PageAttributes(PageAttributes.ColorType color,
                      PageAttributes.MediaType media,
                      PageAttributes.OrientationRequestedType orientation,
                      PageAttributes.OriginType origin,
                      PageAttributes.PrintQualityType quality,
                      int[] resolution)
Method Detail

clone

public Object clone()
Description copied from class: Object
This method may be called to create a new copy of the Object. The typical behavior is as follows:

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Overrides:
clone in class Object
Returns:
a copy of the Object
See Also:
Cloneable

set

public void set(PageAttributes attr)

getColor

public PageAttributes.ColorType getColor()

setColor

public void setColor(PageAttributes.ColorType color)

getMedia

public PageAttributes.MediaType getMedia()

setMedia

public void setMedia(PageAttributes.MediaType media)

setMediaToDefault

public void setMediaToDefault()

getOrientationRequested

public PageAttributes.OrientationRequestedType getOrientationRequested()

setOrientationRequested

public void setOrientationRequested(PageAttributes.OrientationRequestedType orientation)

setOrientationRequested

public void setOrientationRequested(int orientation)

setOrientationRequestedToDefault

public void setOrientationRequestedToDefault()

getOrigin

public PageAttributes.OriginType getOrigin()

setOrigin

public void setOrigin(PageAttributes.OriginType origin)

getPrintQuality

public PageAttributes.PrintQualityType getPrintQuality()

setPrintQuality

public void setPrintQuality(PageAttributes.PrintQualityType quality)

setPrintQuality

public void setPrintQuality(int quality)

setPrintQualityToDefault

public void setPrintQualityToDefault()

getPrinterResolution

public int[] getPrinterResolution()

setPrinterResolution

public void setPrinterResolution(int[] resolution)

setPrinterResolution

public void setPrinterResolution(int resolution)

setPrinterResolutionToDefault

public void setPrinterResolutionToDefault()

equals

public boolean equals(Object o)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
o - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()
Description copied from class: Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)