Class Dimension

java.lang.Object
java.awt.geom.Dimension2D
java.awt.Dimension
All Implemented Interfaces:
Serializable,Cloneable
Direct Known Subclasses:
DimensionUIResource
public classDimensionextendsDimension2DimplementsSerializable
TheDimension class encapsulates the width and height of a component (in integer precision) in a single object. The class is associated with certain properties of components. Several methods defined by theComponent class and theLayoutManager interface return aDimension object.

Normally the values ofwidth andheight are non-negative integers. The constructors that allow you to create a dimension do not prevent you from setting a negative value for these properties. If the value ofwidth orheight is negative, the behavior of some methods defined by other objects is undefined.

Since:
1.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    The height dimension; negative values can be used.
    int
    The width dimension; negative values can be used.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance ofDimension with a width of zero and a height of zero.
    Dimension(int width, int height)
    Constructs aDimension and initializes it to the specified width and specified height.
    Creates an instance ofDimension whose width and height are the same as for the specified dimension.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Checks whether two dimension objects have equal values.
    double
    Returns the height of thisDimension in double precision.
    Gets the size of thisDimension object.
    double
    Returns the width of thisDimension in double precision.
    int
    Returns the hash code for thisDimension.
    void
    setSize(double width, double height)
    Sets the size of thisDimension object to the specified width and height in double precision.
    void
    setSize(int width, int height)
    Sets the size of thisDimension object to the specified width and height.
    void
    Sets the size of thisDimension object to the specified size.
    Returns a string representation of the values of thisDimension object'sheight andwidth fields.

    Methods declared in class java.awt.geom.Dimension2D

    clone,setSize

    Methods declared in class java.lang.Object

    finalize,getClass,notify,notifyAll,wait,wait,wait

  • Field Details

  • Constructor Details

    • Dimension

      public Dimension()
      Creates an instance ofDimension with a width of zero and a height of zero.

    • Dimension

      public Dimension(Dimension d)
      Creates an instance ofDimension whose width and height are the same as for the specified dimension.
      Parameters:
      d - the specified dimension for thewidth andheight values

    • Dimension

      public Dimension(int width, int height)
      Constructs aDimension and initializes it to the specified width and specified height.
      Parameters:
      width - the specified width
      height - the specified height

  • Method Details

    • getWidth

      public double getWidth()
      Returns the width of thisDimension in double precision.
      Specified by:
      getWidth in class Dimension2D
      Returns:
      the width of thisDimension.
      Since:
      1.2

    • getHeight

      public double getHeight()
      Returns the height of thisDimension in double precision.
      Specified by:
      getHeight in class Dimension2D
      Returns:
      the height of thisDimension.
      Since:
      1.2

    • setSize

      public void setSize(double width, double height)
      Sets the size of thisDimension object to the specified width and height in double precision. Note that ifwidth orheight are larger thanInteger.MAX_VALUE, they will be reset toInteger.MAX_VALUE.
      Specified by:
      setSize in class Dimension2D
      Parameters:
      width - the new width for theDimension object
      height - the new height for theDimension object
      Since:
      1.2

    • getSize

      public Dimension getSize()
      Gets the size of thisDimension object. This method is included for completeness, to parallel thegetSize method defined byComponent.
      Returns:
      the size of this dimension, a new instance ofDimension with the same width and height
      Since:
      1.1
      See Also:

    • setSize

      public void setSize(Dimension d)
      Sets the size of thisDimension object to the specified size. This method is included for completeness, to parallel thesetSize method defined byComponent.
      Parameters:
      d - the new size for thisDimension object
      Since:
      1.1
      See Also:

    • setSize

      public void setSize(int width, int height)
      Sets the size of thisDimension object to the specified width and height. This method is included for completeness, to parallel thesetSize method defined byComponent.
      Parameters:
      width - the new width for thisDimension object
      height - the new height for thisDimension object
      Since:
      1.1
      See Also:

    • equals

      public boolean equals(Object obj)
      Checks whether two dimension objects have equal values.
      Overrides:
      equals in class Object
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if this object is the same as the obj argument;false otherwise.
      See Also:

    • hashCode

      public int hashCode()
      Returns the hash code for thisDimension.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code for thisDimension
      See Also:

    • toString

      public String toString()
      Returns a string representation of the values of thisDimension object'sheight andwidth fields. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull.
      Overrides:
      toString in class Object
      Returns:
      a string representation of thisDimension object