Eclipse Platform
Release 3.1

org.eclipse.swt.custom
Class StyleRange

java.lang.Object
  extended byorg.eclipse.swt.custom.StyleRange
All Implemented Interfaces:
Cloneable, org.eclipse.swt.internal.CloneableCompatibility

public class StyleRange
extends Object
implements org.eclipse.swt.internal.CloneableCompatibility


Field Summary
 Color background
           
 int fontStyle
           
 Color foreground
           
 int length
           
 int start
           
 boolean strikeout
           
 boolean underline
           
 
Constructor Summary
StyleRange()
           
StyleRange(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.
 
Method Summary
 Object clone()
          Answers a new StyleRange with the same values as this StyleRange.
 boolean equals(Object object)
          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.
 boolean isUnstyled()
          Returns whether or not the receiver is unstyled (i.e., does not have any style attributes specified).
 boolean similarTo(StyleRange style)
          Compares the specified object to this StyleRange and answer if the two are similar.
 String toString()
          Returns a string containing a concise, human-readable description of the receiver.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

start

public int start

length

public int length

foreground

public Color foreground

background

public Color background

fontStyle

public int fontStyle

underline

public boolean underline

strikeout

public boolean strikeout
Constructor Detail

StyleRange

public StyleRange()

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 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.

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()

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.

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()
Answers a new StyleRange with the same values as this StyleRange.

Returns:
a shallow copy of this StyleRange

toString

public String toString()
Returns a string containing a concise, human-readable description of the receiver.

Returns:
a string representation of the event

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.