java.awt
Class DisplayMode

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.DisplayMode

public final class DisplayMode
extends Object sample code for java.lang.Object definition code for java.lang.Object

The DisplayMode class encapsulates the bit depth, height, width, and refresh rate of a GraphicsDevice. Display modes are hardware-dependent and may not always be available.

Since:
1.4
See Also:
GraphicsDevice sample code for java.awt.GraphicsDevice definition code for java.awt.GraphicsDevice

Field Summary
static int BIT_DEPTH_MULTI sample code for java.awt.DisplayMode.BIT_DEPTH_MULTI definition code for java.awt.DisplayMode.BIT_DEPTH_MULTI
          Value of the bit depth if multiple bit depths are supported in this dislay mode.
static int REFRESH_RATE_UNKNOWN sample code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN definition code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN
          Value of the refresh rate if not known
 
Constructor Summary
DisplayMode sample code for java.awt.DisplayMode.DisplayMode(int, int, int, int) definition code for java.awt.DisplayMode.DisplayMode(int, int, int, int) (int width, int height, int bitDepth, int refreshRate)
          Create a new display mode object with the supplied parameters.
 
Method Summary
 boolean equals sample code for java.awt.DisplayMode.equals(java.awt.DisplayMode) definition code for java.awt.DisplayMode.equals(java.awt.DisplayMode) (DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode  dm)
           
 boolean equals sample code for java.awt.DisplayMode.equals(java.lang.Object) definition code for java.awt.DisplayMode.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  dm)
          Indicates whether some other object is "equal to" this one.
 int getBitDepth sample code for java.awt.DisplayMode.getBitDepth() definition code for java.awt.DisplayMode.getBitDepth() ()
           
 int getHeight sample code for java.awt.DisplayMode.getHeight() definition code for java.awt.DisplayMode.getHeight() ()
           
 int getRefreshRate sample code for java.awt.DisplayMode.getRefreshRate() definition code for java.awt.DisplayMode.getRefreshRate() ()
           
 int getWidth sample code for java.awt.DisplayMode.getWidth() definition code for java.awt.DisplayMode.getWidth() ()
           
 int hashCode sample code for java.awt.DisplayMode.hashCode() definition code for java.awt.DisplayMode.hashCode() ()
          Returns a hash code value for the object.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , 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() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , 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

BIT_DEPTH_MULTI sample code for java.awt.DisplayMode.BIT_DEPTH_MULTI

public static final int BIT_DEPTH_MULTI
Value of the bit depth if multiple bit depths are supported in this dislay mode.

See Also:
getBitDepth() sample code for java.awt.DisplayMode.getBitDepth() definition code for java.awt.DisplayMode.getBitDepth() , Constant Field Values

REFRESH_RATE_UNKNOWN sample code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN

public static final int REFRESH_RATE_UNKNOWN
Value of the refresh rate if not known

See Also:
getRefreshRate() sample code for java.awt.DisplayMode.getRefreshRate() definition code for java.awt.DisplayMode.getRefreshRate() , Constant Field Values
Constructor Detail

DisplayMode sample code for java.awt.DisplayMode(int, int, int, int) definition code for java.awt.DisplayMode(int, int, int, int)

public DisplayMode(int width,
                   int height,
                   int bitDepth,
                   int refreshRate)
Create a new display mode object with the supplied parameters.

Parameters:
width - the width of the display, in pixels
height - the height of the display, in pixels
bitDepth - the bit depth of the display, in bits per pixel. This can be BIT_DEPTH_MULTI if multiple bit depths are available.
refreshRate - the refresh rate of the display, in hertz. This can be REFRESH_RATE_UNKNOWN if the information is not available.
See Also:
BIT_DEPTH_MULTI sample code for java.awt.DisplayMode.BIT_DEPTH_MULTI definition code for java.awt.DisplayMode.BIT_DEPTH_MULTI , REFRESH_RATE_UNKNOWN sample code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN definition code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN
Method Detail

getHeight sample code for java.awt.DisplayMode.getHeight() definition code for java.awt.DisplayMode.getHeight()

public int getHeight()
Returns:
the height of the display, in pixels

getWidth sample code for java.awt.DisplayMode.getWidth() definition code for java.awt.DisplayMode.getWidth()

public int getWidth()
Returns:
the width of the display, in pixels

getBitDepth sample code for java.awt.DisplayMode.getBitDepth() definition code for java.awt.DisplayMode.getBitDepth()

public int getBitDepth()
Returns:
the bit depth of the display, in bits per pixel. This may be BIT_DEPTH_MULTI if multiple bit depths are supported in this display mode.
See Also:
BIT_DEPTH_MULTI sample code for java.awt.DisplayMode.BIT_DEPTH_MULTI definition code for java.awt.DisplayMode.BIT_DEPTH_MULTI

getRefreshRate sample code for java.awt.DisplayMode.getRefreshRate() definition code for java.awt.DisplayMode.getRefreshRate()

public int getRefreshRate()
Returns:
the refresh rate of the display, in hertz. This may be REFRESH_RATE_UNKNOWN if the information is not available.
See Also:
REFRESH_RATE_UNKNOWN sample code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN definition code for java.awt.DisplayMode.REFRESH_RATE_UNKNOWN

equals sample code for java.awt.DisplayMode.equals(java.awt.DisplayMode) definition code for java.awt.DisplayMode.equals(java.awt.DisplayMode)

public boolean equals(DisplayMode sample code for java.awt.DisplayMode definition code for java.awt.DisplayMode  dm)
Returns:
whether the two display modes are equal

equals sample code for java.awt.DisplayMode.equals(java.lang.Object) definition code for java.awt.DisplayMode.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  dm)
Description copied from class: Object sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object)
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
dm - the reference object with which to compare.
Returns:
whether the two display modes are equal
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.awt.DisplayMode.hashCode() definition code for java.awt.DisplayMode.hashCode()

public int hashCode()
Description copied from class: Object sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a hash code value for this object
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable