Eclipse Platform
Release 3.7

org.eclipse.swt.graphics
Class LineAttributes

java.lang.Object
  extended by org.eclipse.swt.graphics.LineAttributes

public class LineAttributes
extends Object

LineAttributes defines a set of line attributes that can be modified in a GC.

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.3
See Also:
GC.getLineAttributes(), GC.setLineAttributes(LineAttributes), Sample code and further information

Field Summary
 int cap
          The line cap style.
 float[] dash
          The line dash style for SWT.LINE_CUSTOM.
 float dashOffset
          The line dash style offset for SWT.LINE_CUSTOM.
 int join
          The line join style.
 float miterLimit
          The line miter limit.
 int style
          The line style.
 float width
          The line width.
 
Constructor Summary
LineAttributes(float width)
          Create a new line attributes with the specified line width.
LineAttributes(float width, int cap, int join)
          Create a new line attributes with the specified line cap, join and width.
LineAttributes(float width, int cap, int join, int style, float[] dash, float dashOffset, float miterLimit)
          Create a new line attributes with the specified arguments.
 
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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

width

public float width
The line width.


style

public int style
The line style.

See Also:
SWT.LINE_CUSTOM, SWT.LINE_DASH, SWT.LINE_DASHDOT, SWT.LINE_DASHDOTDOT, SWT.LINE_DOT, SWT.LINE_SOLID

cap

public int cap
The line cap style.

See Also:
SWT.CAP_FLAT, SWT.CAP_ROUND, SWT.CAP_SQUARE

join

public int join
The line join style.

See Also:
SWT.JOIN_BEVEL, SWT.JOIN_MITER, SWT.JOIN_ROUND

dash

public float[] dash
The line dash style for SWT.LINE_CUSTOM.


dashOffset

public float dashOffset
The line dash style offset for SWT.LINE_CUSTOM.


miterLimit

public float miterLimit
The line miter limit.

Constructor Detail

LineAttributes

public LineAttributes(float width)
Create a new line attributes with the specified line width.

Parameters:
width - the line width

LineAttributes

public LineAttributes(float width,
                      int cap,
                      int join)
Create a new line attributes with the specified line cap, join and width.

Parameters:
width - the line width
cap - the line cap style
join - the line join style

LineAttributes

public LineAttributes(float width,
                      int cap,
                      int join,
                      int style,
                      float[] dash,
                      float dashOffset,
                      float miterLimit)
Create a new line attributes with the specified arguments.

Parameters:
width - the line width
cap - the line cap style
join - the line join style
style - the line style
dash - the line dash style
dashOffset - the line dash style offset
miterLimit - the line miter limit
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)

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

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