Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.swt.graphics
Class TextStyle

java.lang.Object
  extended by 
org.eclipse.swt.graphics.TextStyle
Direct Known Subclasses:
StyleRange

public class TextStyle
extends Object

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:
TextLayout, Font, Color, TextLayout, TextStyle snippets, Sample code and further information

Field Summary
  Color background
          the background of the style
  Color borderColor
          the border color of the style
 int borderStyle
          the border style.
  Object data
          the data.
  Font font
          the font of the style
  Color foreground
          the foreground of the style
  GlyphMetrics metrics
          the GlyphMetrics of the style
 int rise
          the baseline rise of the style.
 boolean strikeout
          the strikeout flag of the style
  Color strikeoutColor
          the strikeout color of the style
 boolean underline
          the underline flag of the style.
  Color underlineColor
          the underline color of the style
 int underlineStyle
          the underline style.
 
Constructor Summary
TextStyle ()
          Create an empty text style.
TextStyle ( Font font, Color foreground, Color background)
          Create a new text style with the specified font, foreground and background.
TextStyle ( TextStyle style)
          Create a new text style from an existing text style.
 
Method Summary
 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.
  String toString ()
          Returns a string containing a concise, human-readable description of the receiver.
 
Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

font

public 
Font font
the font of the style


foreground

public 
Color foreground
the foreground of the style


background

public 
Color background
the background of the style


underline

public boolean underline
the underline flag of the style. The default underline style is SWT.UNDERLINE_SINGLE.

Since:
3.1

underlineColor

public 
Color underlineColor
the underline color of the style

Since:
3.4

underlineStyle

public int underlineStyle
the underline style. This style is ignored when underline is false.

This value should be one of SWT.UNDERLINE_SINGLE, SWT.UNDERLINE_DOUBLE, SWT.UNDERLINE_ERROR, or SWT.UNDERLINE_SQUIGGLE.

Since:
3.4
See Also:
SWT.UNDERLINE_SINGLE, SWT.UNDERLINE_DOUBLE, SWT.UNDERLINE_ERROR, SWT.UNDERLINE_SQUIGGLE, SWT.UNDERLINE_LINK

strikeout

public boolean strikeout
the strikeout flag of the style

Since:
3.1

strikeoutColor

public 
Color strikeoutColor
the strikeout color of the style

Since:
3.4

borderStyle

public int borderStyle
the border style. The default border style is SWT.NONE.

This value should be one of SWT.BORDER_SOLID, SWT.BORDER_DASH,SWT.BORDER_DOT or SWT.NONE.

Since:
3.4
See Also:
SWT.BORDER_SOLID, SWT.BORDER_DASH, SWT.BORDER_DOT, SWT.NONE

borderColor

public 
Color borderColor
the border color of the style

Since:
3.4

metrics

public 
GlyphMetrics metrics
the GlyphMetrics of the style

Since:
3.2

rise

public int rise
the baseline rise of the style.

Since:
3.2

data

public 
Object 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 with GlyphMetrics.

Since:
3.5
Constructor Detail

TextStyle

public TextStyle()
Create an empty text style.

Since:
3.4

TextStyle

public TextStyle(
Font font,
                 
Color foreground,
                 
Color background)
Create a new text style with the specified font, foreground and background.

Parameters:
font - the font of the style, null if none
foreground - the foreground color of the style, null if none
background - the background color of the style, null if none

TextStyle

public TextStyle(
TextStyle style)
Create a new text style from an existing text style.

Parameters:
style - the style to copy
Since:
3.4
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:
equals in class Object
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.

Overrides:
hashCode in class Object
Returns:
the receiver's hash
See Also:
equals(Object)

toString

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

Overrides:
toString in class Object
Returns:
a string representation of the TextStyle

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire