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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.gtk.linux.ppc64le Show documentation
Standard Widget Toolkit for GTK on ppc64le
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2018 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.graphics;

import org.eclipse.swt.*;

/**
 * TextStyle defines a set of styles that can be applied
 * to a range of text.
 * 
 * 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 TextLayout
 * @see Font
 * @see Color
 * @see TextLayout, TextStyle snippets
 * @see Sample code and further information
 *
 * @since 3.0
 */
public class TextStyle {

	/**
	 * the font of the style
	 */
	public Font font;

	/**
	 * the foreground of the style
	 */
	public Color foreground;

	/**
	 * the background of the style
	 */
	public Color background;

	/**
	 * the underline flag of the style. The default underline
	 * style is SWT.UNDERLINE_SINGLE.
	 *
	 *
	 * @since 3.1
	 */
	public boolean underline;

	/**
	 * the underline color of the style
	 *
	 * @since 3.4
	 */
	public Color underlineColor;

	/**
	 * the underline style. This style is ignored when
	 * underline is false.
	 * 
	 * This value should be one of SWT.UNDERLINE_SINGLE,
	 * SWT.UNDERLINE_DOUBLE, SWT.UNDERLINE_ERROR,
	 * SWT.UNDERLINE_SQUIGGLE, or SWT.UNDERLINE_LINK.
	 * 
	 *
	 * @see SWT#UNDERLINE_SINGLE
	 * @see SWT#UNDERLINE_DOUBLE
	 * @see SWT#UNDERLINE_ERROR
	 * @see SWT#UNDERLINE_SQUIGGLE
	 * @see SWT#UNDERLINE_LINK
	 *
	 * @since 3.4
	 */
	public int underlineStyle;

	/**
	 * the strikeout flag of the style
	 *
	 * @since 3.1
	 */
	public boolean strikeout;

	/**
	 * the strikeout color of the style
	 *
	 * @since 3.4
	 */
	public Color strikeoutColor;

	/**
	 * the border style. The default border style is SWT.NONE.
	 * 
	 * This value should be one of SWT.BORDER_SOLID,
	 * SWT.BORDER_DASH,SWT.BORDER_DOT or
	 * SWT.NONE.
	 * 
	 *
	 * @see SWT#BORDER_SOLID
	 * @see SWT#BORDER_DASH
	 * @see SWT#BORDER_DOT
	 * @see SWT#NONE
	 *
	 * @since 3.4
	 */
	public int borderStyle;

	/**
	 * the border color of the style
	 *
	 * @since 3.4
	 */
	public Color borderColor;

	/**
	 * the GlyphMetrics of the style
	 *
	 * @since 3.2
	 */
	public GlyphMetrics metrics;

	/**
	 * the baseline rise of the style.
	 *
	 * @since 3.2
	 */
	public int rise;


	/**
	 * the data. An user data field. It can be used to hold the HREF when the range
	 * is used as a link or the embed object when the range is used with GlyphMetrics.
	 *
	 * @since 3.5
	 */
	public Object data;


/**
 * Create an empty text style.
 *
 * @since 3.4
 */
public TextStyle () {
}

/**
 * Create a new text style with the specified font, foreground
 * and background.
 *
 * @param font the font of the style, null if none
 * @param foreground the foreground color of the style, null if none
 * @param background the background color of the style, null if none
 */
public TextStyle (Font font, Color foreground, Color background) {
	if (font != null && font.isDisposed()) SWT.error (SWT.ERROR_INVALID_ARGUMENT);
	if (foreground != null && foreground.isDisposed()) SWT.error (SWT.ERROR_INVALID_ARGUMENT);
	if (background != null && background.isDisposed()) SWT.error (SWT.ERROR_INVALID_ARGUMENT);
	this.font = font;
	this.foreground = foreground;
	this.background = background;
}


/**
 * Create a new text style from an existing text style.
 *
 * @param style the style to copy
 *
 * @since 3.4
 */
public TextStyle (TextStyle style) {
	if (style == null) SWT.error (SWT.ERROR_INVALID_ARGUMENT);
	font = style.font;
	foreground = style.foreground;
	background = style.background;
	underline = style.underline;
	underlineColor = style.underlineColor;
	underlineStyle = style.underlineStyle;
	strikeout = style.strikeout;
	strikeoutColor = style.strikeoutColor;
	borderStyle = style.borderStyle;
	borderColor = style.borderColor;
	metrics = style.metrics;
	rise = style.rise;
	data = style.data;
}

/**
 * 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()
 */
@Override
public boolean equals(Object object) {
	if (object == this) return true;
	if (object == null) return false;
	if (!(object instanceof TextStyle style)) return false;
	if (foreground != null) {
		if (!foreground.equals(style.foreground)) return false;
	} else if (style.foreground != null) return false;
	if (background != null) {
		if (!background.equals(style.background)) return false;
	} else if (style.background != null) return false;
	if (font != null) {
		if (!font.equals(style.font)) return false;
	} else if (style.font != null) return false;
	if (metrics != null) {
		if (!metrics.equals(style.metrics)) return false;
	} else if (style.metrics != null) return false;
	if (underline != style.underline) return false;
	if (underlineStyle != style.underlineStyle) return false;
	if (borderStyle != style.borderStyle) return false;
	if (strikeout != style.strikeout) return false;
	if (rise != style.rise) return false;
	if (underlineColor != null) {
		if (!underlineColor.equals(style.underlineColor)) return false;
	} else if (style.underlineColor != null) return false;
	if (strikeoutColor != null) {
		if (!strikeoutColor.equals(style.strikeoutColor)) return false;
	} else if (style.strikeoutColor != null) return false;
	if (underlineStyle != style.underlineStyle) return false;
	if (borderColor != null) {
		if (!borderColor.equals(style.borderColor)) return false;
	} else if (style.borderColor != null) return false;
	if (data != null) {
		if (!data.equals(style.data)) return false;
	} else if (style.data != null) return false;
	return true;
}

/**
 * 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)
 */
@Override
public int hashCode() {
	int hash = 0;
	if (foreground != null) hash ^= foreground.hashCode();
	if (background != null) hash ^= background.hashCode();
	if (font != null) hash ^= font.hashCode();
	if (metrics != null) hash ^= metrics.hashCode();
	if (underline) hash ^= (hash << 1);
	if (strikeout) hash ^= (hash << 2);
	hash ^= rise;
	if (underlineColor != null) hash ^= underlineColor.hashCode();
	if (strikeoutColor != null) hash ^= strikeoutColor.hashCode();
	if (borderColor != null) hash ^= borderColor.hashCode();
	hash ^= underlineStyle;
	return hash;
}

boolean isAdherentBorder(TextStyle style) {
	if (this == style) return true;
	if (style == null) return false;
	if (borderStyle != style.borderStyle) return false;
	if (borderColor != null) {
		if (!borderColor.equals(style.borderColor)) return false;
	} else {
		if (style.borderColor != null) return false;
		if (foreground != null) {
			if (!foreground.equals(style.foreground)) return false;
		} else if (style.foreground != null) return false;
	}
	return true;
}

boolean isAdherentUnderline(TextStyle style) {
	if (this == style) return true;
	if (style == null) return false;
	if (underline != style.underline) return false;
	if (underlineStyle != style.underlineStyle) return false;
	if (underlineColor != null) {
		if (!underlineColor.equals(style.underlineColor)) return false;
	} else {
		if (style.underlineColor != null) return false;
		if (foreground != null) {
			if (!foreground.equals(style.foreground)) return false;
		} else if (style.foreground != null) return false;
	}
	return true;
}

boolean isAdherentStrikeout(TextStyle style) {
	if (this == style) return true;
	if (style == null) return false;
	if (strikeout != style.strikeout) return false;
	if (strikeoutColor != null) {
		if (!strikeoutColor.equals(style.strikeoutColor)) return false;
	} else {
		if (style.strikeoutColor != null) return false;
		if (foreground != null) {
			if (!foreground.equals(style.foreground)) return false;
		} else if (style.foreground != null) return false;
	}
	return true;
}

/**
 * Returns a string containing a concise, human-readable
 * description of the receiver.
 *
 * @return a string representation of the TextStyle
 */
@Override
public String toString () {
	StringBuilder buffer = new StringBuilder("TextStyle {"); //$NON-NLS-1$
	int startLength = buffer.length();
	if (font != null) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("font="); //$NON-NLS-1$
		buffer.append(font);
	}
	if (foreground != null) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("foreground="); //$NON-NLS-1$
		buffer.append(foreground);
	}
	if (background != null) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("background="); //$NON-NLS-1$
		buffer.append(background);
	}
	if (underline) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("underline="); //$NON-NLS-1$
		switch (underlineStyle) {
			case SWT.UNDERLINE_SINGLE: buffer.append("single"); break; //$NON-NLS-1$
			case SWT.UNDERLINE_DOUBLE: buffer.append("double"); break; //$NON-NLS-1$
			case SWT.UNDERLINE_SQUIGGLE: buffer.append("squiggle"); break; //$NON-NLS-1$
			case SWT.UNDERLINE_ERROR: buffer.append("error"); break; //$NON-NLS-1$
			case SWT.UNDERLINE_LINK: buffer.append("link"); break; //$NON-NLS-1$
		}
		if (underlineColor != null) {
			buffer.append(", underlineColor="); //$NON-NLS-1$
			buffer.append(underlineColor);
		}
	}
	if (strikeout) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("striked out"); //$NON-NLS-1$
		if (strikeoutColor != null) {
			buffer.append(", strikeoutColor="); //$NON-NLS-1$
			buffer.append(strikeoutColor);
		}
	}
	if (borderStyle != SWT.NONE) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("border="); //$NON-NLS-1$
		switch (borderStyle) {
			case SWT.BORDER_SOLID:	buffer.append("solid"); break; //$NON-NLS-1$
			case SWT.BORDER_DOT:	buffer.append("dot"); break; //$NON-NLS-1$
			case SWT.BORDER_DASH:	buffer.append("dash"); break; //$NON-NLS-1$
		}
		if (borderColor != null) {
			buffer.append(", borderColor="); //$NON-NLS-1$
			buffer.append(borderColor);
		}
	}
	if (rise != 0) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("rise="); //$NON-NLS-1$
		buffer.append(rise);
	}
	if (metrics != null) {
		if (buffer.length() > startLength) buffer.append(", "); //$NON-NLS-1$
		buffer.append("metrics="); //$NON-NLS-1$
		buffer.append(metrics);
	}
	buffer.append("}"); //$NON-NLS-1$
	return buffer.toString();
}

}