org.eclipse.swt.graphics.GlyphMetrics Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.win32.win32.x86 Show documentation

SWT is an open source widget toolkit for Java designed to provide efficient, portable access to the user-interface facilities of the operating systems on which it is implemented.

The newest version!

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.graphics;

import org.eclipse.swt.*;

/**
 * Instances of this class represent glyph metrics.
 * 
 * The hashCode() method in this class uses the values of the public
 * fields to compute the hash value. When storing instances of the
 * class in hashed collections, do not modify these fields after the
 * object has been inserted.  
 * 
 * 
 * Application code does not need to explicitly release the
 * resources managed by each instance when those instances are no longer
 * required, and thus no dispose() method is provided.
 * 
 * 
 * @see TextStyle
 * @see TextLayout
 * @see Sample code and further information
 * 
 * @since 3.2
 */
public final class GlyphMetrics {
	
	/**
	 * the ascent of the GlyphMetrics
	 */
	public int ascent;
	
	/**
	 * the descent of the GlyphMetrics
	 */
	public int descent;
	
	/**
	 * the width of the GlyphMetrics
	 */
	public int width;
	
/**
 * Constructs an instance of this class with the given
 * ascent, descent and width values.
 *
 * @param ascent the GlyphMetrics ascent
 * @param descent the GlyphMetrics descent
 * @param width the GlyphMetrics width
 *
 * @exception IllegalArgumentException 
 *    ERROR_INVALID_ARGUMENT - if the ascent, descent or width argument is negative
 * 
 */
public GlyphMetrics(int ascent, int descent, int width) {
	if (ascent < 0 || descent < 0 || width < 0) {
		SWT.error(SWT.ERROR_INVALID_ARGUMENT);
	}
	this.ascent = ascent;
	this.descent = descent;
	this.width = width;
}

/**
 * Compares the argument to the receiver, and returns true
 * if they represent the same object using a class
 * specific comparison.
 *
 * @param object the object to compare with this object
 * @return true if the object is the same as this object and false otherwise
 *
 * @see #hashCode()
 */
public boolean equals (Object object) {
	if (object == this) return true;
	if (!(object instanceof GlyphMetrics)) return false;
	GlyphMetrics metrics = (GlyphMetrics)object;
	return metrics.ascent == ascent && metrics.descent == descent && metrics.width == width;
}

/**
 * Returns an integer hash code for the receiver. Any two 
 * objects that return true when passed to 
 * equals must return the same value for this
 * method.
 *
 * @return the receiver's hash
 *
 * @see #equals(Object)
 */
public int hashCode () {
	return ascent ^ descent ^ width;
}

/**
 * Returns a string containing a concise, human-readable
 * description of the receiver.
 *
 * @return a string representation of the GlyphMetrics
 */
public String toString () {
	return "GlyphMetrics {" + ascent + ", " + descent + ", " + width + "}"; //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
}

}