Eclipse Platform
Release 3.1

org.eclipse.swt.graphics
Class Pattern

java.lang.Object
  extended byorg.eclipse.swt.graphics.Resource
      extended byorg.eclipse.swt.graphics.Pattern

public class Pattern
extends Resource

Instances of this class represent patterns to use while drawing. Patterns can be specified either as bitmaps or gradients.

Application code must explicitly invoke the Pattern.dispose() method to release the operating system resources managed by each instance when those instances are no longer required.

Since:
3.1

Field Summary
 int handle
          the OS resource for the Pattern (Warning: This field is platform dependent) IMPORTANT: This field is not part of the SWT public API.
 
Constructor Summary
Pattern(Device device, float x1, float y1, float x2, float y2, Color color1, Color color2)
          Constructs a new Pattern that represents a linear, two color gradient.
Pattern(Device device, Image image)
          Constructs a new Pattern given an image.
 
Method Summary
 void dispose()
          Disposes of the operating system resources associated with the Pattern.
 boolean isDisposed()
          Returns true if the Pattern has been disposed, and false otherwise.
 String toString()
          Returns a string containing a concise, human-readable description of the receiver.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

handle

public int handle
the OS resource for the Pattern (Warning: This field is platform dependent)

IMPORTANT: This field is not part of the SWT public API. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.

Constructor Detail

Pattern

public Pattern(Device device,
               Image image)
Constructs a new Pattern given an image. Drawing with the resulting pattern will cause the image to be tiled over the resulting area.

Parameters:
device - the device on which to allocate the pattern
image - the image that the pattern will draw
Throws:
IllegalArgumentException -
SWTError -
See Also:
dispose()

Pattern

public Pattern(Device device,
               float x1,
               float y1,
               float x2,
               float y2,
               Color color1,
               Color color2)
Constructs a new Pattern that represents a linear, two color gradient. Drawing with the pattern will cause the resulting area to be tiled with the gradient specified by the arguments.

Parameters:
device - the device on which to allocate the pattern
x1 - the x coordinate of the starting corner of the gradient
y1 - the y coordinate of the starting corner of the gradient
x2 - the x coordinate of the ending corner of the gradient
y2 - the y coordinate of the ending corner of the gradient
color1 - the starting color of the gradient
color2 - the ending color of the gradient
Throws:
IllegalArgumentException -
SWTError -
See Also:
dispose()
Method Detail

dispose

public void dispose()
Disposes of the operating system resources associated with the Pattern. Applications must dispose of all Patterns that they allocate.

Specified by:
dispose in class Resource

isDisposed

public boolean isDisposed()
Returns true if the Pattern has been disposed, and false otherwise.

This method gets the dispose state for the Pattern. When a Pattern has been disposed, it is an error to invoke any other method using the Pattern.

Specified by:
isDisposed in class Resource
Returns:
true when the Pattern is disposed, and false otherwise

toString

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

Returns:
a string representation of the receiver

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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