org.eclipse.swt.custom
Class StyleRange

java.lang.Object
  org.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 the background of the range
Font	font
int	fontStyle the font style of the range.
Color	foreground the foreground of the range
int	length the length of the range
EmbeddedObject	object
int	rise
int	start the start offset of the range. zero-based from the document start
boolean	strikeout the strikeout flag of the range
boolean	underline the underline flag of the range

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

the start offset of the range. zero-based from the document start

length

public int length

the length of the range

foreground

public Color foreground

the foreground of the range

background

public Color background

the background of the range

underline

public boolean underline

the underline flag of the range

strikeout

public boolean strikeout

the strikeout flag 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

font

public Font font

rise

public int rise

object

public EmbeddedObject object

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