Package org.eclipse.swt.graphics
Class TextStyle
java.lang.Object
org.eclipse.swt.graphics.TextStyle
- Direct Known Subclasses:
StyleRange
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.
- Since:
- 3.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionthe background of the stylethe border color of the styleint
the border style.the data.the font of the stylethe foreground of the stylethe GlyphMetrics of the styleint
the baseline rise of the style.boolean
the strikeout flag of the stylethe strikeout color of the styleboolean
the underline flag of the style.the underline color of the styleint
the underline style. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.int
hashCode()
Returns an integer hash code for the receiver.toString()
Returns a string containing a concise, human-readable description of the receiver.
-
Field Details
-
font
the font of the style -
foreground
the foreground of the style -
background
the background of the style -
underline
public boolean underlinethe underline flag of the style. The default underline style isSWT.UNDERLINE_SINGLE
.- Since:
- 3.1
-
underlineColor
the underline color of the style- Since:
- 3.4
-
underlineStyle
public int underlineStylethe underline style. This style is ignored whenunderline
is false.This value should be one of
SWT.UNDERLINE_SINGLE
,SWT.UNDERLINE_DOUBLE
,SWT.UNDERLINE_ERROR
,SWT.UNDERLINE_SQUIGGLE
, orSWT.UNDERLINE_LINK
.- Since:
- 3.4
- See Also:
-
strikeout
public boolean strikeoutthe strikeout flag of the style- Since:
- 3.1
-
strikeoutColor
the strikeout color of the style- Since:
- 3.4
-
borderStyle
public int borderStylethe border style. The default border style isSWT.NONE
.This value should be one of
SWT.BORDER_SOLID
,SWT.BORDER_DASH
,SWT.BORDER_DOT
orSWT.NONE
.- Since:
- 3.4
- See Also:
-
borderColor
the border color of the style- Since:
- 3.4
-
metrics
the GlyphMetrics of the style- Since:
- 3.2
-
rise
public int risethe baseline rise of the style.- Since:
- 3.2
-
data
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 withGlyphMetrics
.- Since:
- 3.5
-
-
Constructor Details
-
TextStyle
public TextStyle()Create an empty text style.- Since:
- 3.4
-
TextStyle
Create a new text style with the specified font, foreground and background.- Parameters:
font
- the font of the style,null
if noneforeground
- the foreground color of the style,null
if nonebackground
- the background color of the style,null
if none
-
TextStyle
Create a new text style from an existing text style.- Parameters:
style
- the style to copy- Since:
- 3.4
-
-
Method Details
-
equals
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. -
hashCode
public int hashCode()Returns an integer hash code for the receiver. Any two objects that returntrue
when passed toequals
must return the same value for this method. -
toString
Returns a string containing a concise, human-readable description of the receiver.
-