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
StyleRange defines 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:

  • Field Details

    • 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 the font attribute is set

  • Constructor Details

    • 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 style
      length - length of the style
      foreground - foreground color of the style, null if none
      background - 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 style
      length - length of the style
      foreground - foreground color of the style, null if none
      background - background color of the style, null if none
      fontStyle - font style of the style, may be SWT.NORMAL, SWT.ITALIC or SWT.BOLD

  • Method Details

    • 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:
      equals in class TextStyle
      Parameters:
      object - the object to compare with this object
      Returns:
      true if the object is the same as this object and false otherwise
      See Also:

    • hashCode

      public int hashCode()
      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.
      Overrides:
      hashCode in class TextStyle
      Returns:
      the receiver's hash
      See Also:

    • 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.
      Overrides:
      clone in class Object
      Returns:
      a shallow copy of this StyleRange

    • toString

      public String toString()
      Returns a string containing a concise, human-readable description of the receiver.
      Overrides:
      toString in class TextStyle
      Returns:
      a string representation of the StyleRange