org.eclipse.swt.graphics.Font Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2010, 2012 IBM Corporation, Gerhardt Informatics Kft. 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
* Gerhardt Informatics Kft. - GEFGWT port
*******************************************************************************/
package org.eclipse.swt.graphics;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTError;
import org.eclipse.swt.SWTException;
/**
* Instances of this class manage operating system resources that define how
* text looks when it is displayed. Fonts may be constructed by providing a
* device and either name, size and style information or a FontData
* object which encapsulates this data.
*
* Application code must explicitly invoke the Font.dispose()
* method to release the operating system resources managed by each instance
* when those instances are no longer required.
*
*
* @see FontData
* @see Font snippets
* @see SWT Examples:
* GraphicsExample, PaintExample
* @see Sample code and further
* information
*/
public final class Font extends Resource {
/**
* the handle to the OS font resource (Warning: This field is platform
* dependent)
*
* IMPORTANT: This field is not part of the SWT public API.
* It is marked public only so that it can be shared within the packages
* provided by SWT. It is not available on all platforms and should never be
* accessed from application code.
*
*
* @noreference This field is not intended to be referenced by clients.
*/
public long /* int */handle;
private FontData fontData;
Font(Device device) {
super(device);
fontData = new FontData();
}
/**
* Constructs a new font given a device and font data which describes the
* desired font's appearance.
*
* You must dispose the font when it is no longer required.
*
*
* @param device
* the device to create the font on
* @param fd
* the FontData that describes the desired font (must not be
* null)
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if device is null and there is
* no current device
* - ERROR_NULL_ARGUMENT - if the fd argument is null
*
* @exception SWTError
*
* - ERROR_NO_HANDLES - if a font could not be created from
* the given font data
*
*/
public Font(Device device, FontData fd) {
super(device);
if (fd == null)
SWT.error(SWT.ERROR_NULL_ARGUMENT);
this.fontData = fd;
init(fd.getName(), fd.getHeightF(), fd.getStyle(), fd.string);
init();
}
/**
* Constructs a new font given a device and an array of font data which
* describes the desired font's appearance.
*
* You must dispose the font when it is no longer required.
*
*
* @param device
* the device to create the font on
* @param fds
* the array of FontData that describes the desired font (must
* not be null)
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if device is null and there is
* no current device
* - ERROR_NULL_ARGUMENT - if the fds argument is null
* - ERROR_INVALID_ARGUMENT - if the length of fds is zero
* - ERROR_NULL_ARGUMENT - if any fd in the array is null
*
* @exception SWTError
*
* - ERROR_NO_HANDLES - if a font could not be created from
* the given font data
*
*
* @since 2.1
*/
public Font(Device device, FontData[] fds) {
super(device);
if (fds == null)
SWT.error(SWT.ERROR_NULL_ARGUMENT);
if (fds.length == 0)
SWT.error(SWT.ERROR_INVALID_ARGUMENT);
for (int i = 0; i < fds.length; i++) {
if (fds[i] == null)
SWT.error(SWT.ERROR_INVALID_ARGUMENT);
}
this.fontData = fds[0];
FontData fd = fds[0];
init(fd.getName(), fd.getHeightF(), fd.getStyle(), fd.string);
init();
}
/**
* Constructs a new font given a device, a font name, the height of the
* desired font in points, and a font style.
*
* You must dispose the font when it is no longer required.
*
*
* @param device
* the device to create the font on
* @param name
* the name of the font (must not be null)
* @param height
* the font height in points
* @param style
* a bit or combination of NORMAL, BOLD, ITALIC
*
* @exception IllegalArgumentException
*
* - ERROR_NULL_ARGUMENT - if device is null and there is
* no current device
* - ERROR_NULL_ARGUMENT - if the name argument is null
* - ERROR_INVALID_ARGUMENT - if the height is negative
*
* @exception SWTError
*
* - ERROR_NO_HANDLES - if a font could not be created from
* the given arguments
*
*/
public Font(Device device, String name, int height, int style) {
super(device);
this.fontData = new FontData(name, height, style);
init(name, height, style, null);
init();
}
/* public */Font(Device device, String name, float height, int style) {
super(device);
this.fontData = new FontData(name, height, style);
init(name, height, style, null);
init();
}
void destroy() {
}
/**
* 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 Font) == false)
return false;
// if (((Font) object).fontData != null) {
// return ((Font) object).fontData.equals(this.fontData);
// }
return ((Font) object).fontData.equals(this.fontData);
}
/**
* Returns an array of FontDatas representing the receiver. On
* Windows, only one FontData will be returned per font. On X however, a
* Font object may be composed of multiple X fonts. To
* support this case, we return an array of font data objects.
*
* @return an array of font data objects describing the receiver
*
* @exception SWTException
*
* - ERROR_GRAPHIC_DISPOSED - if the receiver has been
* disposed
*
*/
public FontData[] getFontData() {
return new FontData[] { new FontData(fontData) };
}
/**
* Invokes platform specific functionality to allocate a new font.
*
* IMPORTANT: This method is not part of the public API for
* Font. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms, and should never be called from application code.
*
*
* @param device
* the device on which to allocate the color
* @param handle
* the handle for the font
*
* @noreference This method is not intended to be referenced by clients.
*/
public static Font gtk_new(Device device, long /* int */handle) {
Font font = new Font(device);
font.handle = handle;
return font;
}
/**
* 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
*/
public int hashCode() {
return (int) /* 64 */handle;
}
void init(String name, float height, int style, byte[] fontString) {
}
/**
* Returns true if the font has been disposed, and
* false otherwise.
*
* This method gets the dispose state for the font. When a font has been
* disposed, it is an error to invoke any other method (except
* {@link #dispose()}) using the font.
*
* @return true when the font is disposed and
* false otherwise
*/
public boolean isDisposed() {
// return handle == 0;
return false;
}
/**
* Returns a string containing a concise, human-readable description of the
* receiver.
*
* @return a string representation of the receiver
*/
public String toString() {
if (isDisposed())
return "Font {*DISPOSED*}";
return "Font {" + handle + "}";
}
FontData getFD() {
return this.fontData;
}
}