Package org.eclipse.swt.custom
Class StyleRange
- java.lang.Object
-
- org.eclipse.swt.graphics.TextStyle
-
- org.eclipse.swt.custom.StyleRange
-
- All Implemented Interfaces:
Cloneable
public class StyleRange extends TextStyle implements Cloneable
StyleRangedefines a set of styles for a specified 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.
- See Also:
- Sample code and further information
-
-
Field Summary
Fields Modifier and Type Field Description intfontStylethe font style of the range.intlengththe length of the rangeintstartthe start offset of the range, zero-based from the document start-
Fields inherited from class org.eclipse.swt.graphics.TextStyle
background, borderColor, borderStyle, data, font, foreground, metrics, rise, strikeout, strikeoutColor, underline, underlineColor, underlineStyle
-
-
Constructor Summary
Constructors Constructor Description StyleRange()Create a new style range with no stylesStyleRange(int start, int length, Color foreground, Color background)Create a new style range.StyleRange(int start, int length, Color foreground, Color background, int fontStyle)Create a new style range.StyleRange(TextStyle style)Create a new style range from an existing text style.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Returns a new StyleRange with the same values as this StyleRange.booleanequals(Object object)Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.inthashCode()Returns an integer hash code for the receiver.booleanisUnstyled()Returns whether or not the receiver is unstyled (i.e., does not have any style attributes specified).booleansimilarTo(StyleRange style)Compares the specified object to this StyleRange and answer if the two are similar.StringtoString()Returns a string containing a concise, human-readable description of the receiver.
-
-
-
Field Detail
-
start
public int start
the start offset of the range, zero-based from the document start
-
length
public int length
the length of the range
-
fontStyle
public int fontStyle
the font style of the range. It may be a combination of SWT.NORMAL, SWT.ITALIC or SWT.BOLD Note: the font style is not used if thefontattribute is set
-
-
Constructor Detail
-
StyleRange
public StyleRange()
Create a new style range with no styles- Since:
- 3.2
-
StyleRange
public StyleRange(TextStyle style)
Create a new style range from an existing text style.- Parameters:
style- the text style to copy- Since:
- 3.4
-
StyleRange
public StyleRange(int start, int length, Color foreground, Color background)Create a new style range.- Parameters:
start- start offset of the stylelength- length of the styleforeground- foreground color of the style, null if nonebackground- background color of the style, null if none
-
StyleRange
public StyleRange(int start, int length, Color foreground, Color background, int fontStyle)Create a new style range.- Parameters:
start- start offset of the stylelength- length of the styleforeground- foreground color of the style, null if nonebackground- background color of the style, null if nonefontStyle- font style of the style, may be SWT.NORMAL, SWT.ITALIC or SWT.BOLD
-
-
Method Detail
-
equals
public boolean equals(Object object)
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.- Overrides:
equalsin classTextStyle- Parameters:
object- the object to compare with this object- Returns:
trueif the object is the same as this object andfalseotherwise- See Also:
hashCode()
-
hashCode
public int hashCode()
Returns an integer hash code for the receiver. Any two objects that returntruewhen passed toequalsmust return the same value for this method.- Overrides:
hashCodein classTextStyle- Returns:
- the receiver's hash
- See Also:
equals(Object)
-
isUnstyled
public boolean isUnstyled()
Returns whether or not the receiver is unstyled (i.e., does not have any style attributes specified).- Returns:
- true if the receiver is unstyled, false otherwise.
-
similarTo
public boolean similarTo(StyleRange style)
Compares the specified object to this StyleRange and answer if the two are similar. The object must be an instance of StyleRange and have the same field values for except for start and length.- Parameters:
style- the object to compare with this object- Returns:
- true if the objects are similar, false otherwise
-
clone
public Object clone()
Returns a new StyleRange with the same values as this StyleRange.
-
-