org.eclipse.jface.text.TextAttribute Maven / Gradle / Ivy
/*******************************************************************************
* 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.jface.text;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
/**
* Description of textual attributes such as color and style. Text attributes
* are considered value objects.
*
* Clients usually instantiate object of the class.
*/
public class TextAttribute {
/**
* Text attribute for strikethrough style.
* (value 1 << 29
).
* @since 3.1
*/
public static final int STRIKETHROUGH= 1 << 29;
/**
* Text attribute for underline style.
* (value 1 << 30
)
* @since 3.1
*/
public static final int UNDERLINE= 1 << 30;
/** Foreground color */
private Color foreground;
/** Background color */
private Color background;
/** The text style */
private int style;
/**
* The text font.
* @since 3.3
*/
private Font font;
/**
* Cached hash code.
* @since 3.3
*/
private int fHashCode;
/**
* Creates a text attribute with the given colors and style.
*
* @param foreground the foreground color, null
if none
* @param background the background color, null
if none
* @param style the style
*/
public TextAttribute(Color foreground, Color background, int style) {
this.foreground= foreground;
this.background= background;
this.style= style;
}
/**
* Creates a text attribute with the given colors and style.
*
* @param foreground the foreground color, null
if none
* @param background the background color, null
if none
* @param style the style
* @param font the font, null
if none
* @since 3.3
*/
public TextAttribute(Color foreground, Color background, int style, Font font) {
this.foreground= foreground;
this.background= background;
this.style= style;
this.font= font;
}
/**
* Creates a text attribute for the given foreground color, no background color and
* with the SWT normal style.
*
* @param foreground the foreground color, null
if none
*/
public TextAttribute(Color foreground) {
this(foreground, null, SWT.NORMAL);
}
/*
* @see Object#equals(Object)
*/
public boolean equals(Object object) {
if (object == this)
return true;
if (!(object instanceof TextAttribute))
return false;
TextAttribute a= (TextAttribute)object;
return (a.style == style && equals(a.foreground, foreground) && equals(a.background, background) && equals(a.font, font));
}
/**
* Returns whether the two given objects are equal.
*
* @param o1 the first object, can be null
* @param o2 the second object, can be null
* @return true
if the given objects are equals
* @since 2.0
*/
private boolean equals(Object o1, Object o2) {
if (o1 != null)
return o1.equals(o2);
return (o2 == null);
}
/*
* @see Object#hashCode()
*/
public int hashCode() {
if (fHashCode == 0) {
int multiplier= 37; // some prime
fHashCode= 13; // some random value
fHashCode= multiplier * fHashCode + (font == null ? 0 : font.hashCode());
fHashCode= multiplier * fHashCode + (background == null ? 0 : background.hashCode());
fHashCode= multiplier * fHashCode + (foreground == null ? 0 : foreground.hashCode());
fHashCode= multiplier * fHashCode + style;
}
return fHashCode;
}
/**
* Returns the attribute's foreground color.
*
* @return the attribute's foreground color or null
if not set
*/
public Color getForeground() {
return foreground;
}
/**
* Returns the attribute's background color.
*
* @return the attribute's background color or null
if not set
*/
public Color getBackground() {
return background;
}
/**
* Returns the attribute's style.
*
* @return the attribute's style
*/
public int getStyle() {
return style;
}
/**
* Returns the attribute's font.
*
* @return the attribute's font or null
if not set
* @since 3.3
*/
public Font getFont() {
return font;
}
}