Package org.eclipse.jface.text
Class TextAttribute
- java.lang.Object
-
- org.eclipse.jface.text.TextAttribute
-
public class TextAttribute extends Object
Description of textual attributes such as color and style. Text attributes are considered value objects.Clients usually instantiate object of the class.
-
-
Field Summary
Fields Modifier and Type Field Description static intSTRIKETHROUGHText attribute for strikethrough style.static intUNDERLINEText attribute for underline style.
-
Constructor Summary
Constructors Constructor Description TextAttribute(Color foreground)Creates a text attribute for the given foreground color, no background color and with the SWT normal style.TextAttribute(Color foreground, Color background, int style)Creates a text attribute with the given colors and style.TextAttribute(Color foreground, Color background, int style, Font font)Creates a text attribute with the given colors and style.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)ColorgetBackground()Returns the attribute's background color.FontgetFont()Returns the attribute's font.ColorgetForeground()Returns the attribute's foreground color.intgetStyle()Returns the attribute's style.inthashCode()
-
-
-
Field Detail
-
STRIKETHROUGH
public static final int STRIKETHROUGH
Text attribute for strikethrough style. (value1 << 29).- Since:
- 3.1
- See Also:
- Constant Field Values
-
UNDERLINE
public static final int UNDERLINE
Text attribute for underline style. (value1 << 30)- Since:
- 3.1
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TextAttribute
public TextAttribute(Color foreground, Color background, int style)
Creates a text attribute with the given colors and style.- Parameters:
foreground- the foreground color,nullif nonebackground- the background color,nullif nonestyle- the style
-
TextAttribute
public TextAttribute(Color foreground, Color background, int style, Font font)
Creates a text attribute with the given colors and style.- Parameters:
foreground- the foreground color,nullif nonebackground- the background color,nullif nonestyle- the stylefont- the font,nullif none- Since:
- 3.3
-
TextAttribute
public TextAttribute(Color foreground)
Creates a text attribute for the given foreground color, no background color and with the SWT normal style.- Parameters:
foreground- the foreground color,nullif none
-
-
Method Detail
-
getForeground
public Color getForeground()
Returns the attribute's foreground color.- Returns:
- the attribute's foreground color or
nullif not set
-
getBackground
public Color getBackground()
Returns the attribute's background color.- Returns:
- the attribute's background color or
nullif not set
-
getStyle
public int getStyle()
Returns the attribute's style.- Returns:
- the attribute's style
-
getFont
public Font getFont()
Returns the attribute's font.- Returns:
- the attribute's font or
nullif not set - Since:
- 3.3
-
-