org.eclipse.swt.graphics.Pattern Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2012 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.graphics;
import org.eclipse.swt.*;
import org.eclipse.swt.internal.cocoa.*;
/**
* 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.
*
*
* This class requires the operating system's advanced graphics subsystem
* which may not be available on some platforms.
*
*
* @see Path, Pattern snippets
* @see SWT Example: GraphicsExample
* @see Sample code and further information
*
* @since 3.1
*/
public class Pattern extends Resource {
NSColor color;
NSGradient gradient;
NSPoint pt1, pt2;
Image image;
double /*float*/ [] color1, color2;
int alpha1, alpha2;
/**
* Constructs a new Pattern given an image. Drawing with the resulting
* pattern will cause the image to be tiled over the resulting area.
*
* This operation requires the operating system's advanced
* graphics subsystem which may not be available on some
* platforms.
*
*
* You must dispose the pattern when it is no longer required.
*
*
* @param device the device on which to allocate the pattern
* @param image the image that the pattern will draw
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the device is null and there is no current device, or the image is null
* - ERROR_INVALID_ARGUMENT - if the image has been disposed
*
* @exception SWTException
* - ERROR_NO_GRAPHICS_LIBRARY - if advanced graphics are not available
*
* @exception SWTError
* - ERROR_NO_HANDLES if a handle for the pattern could not be obtained
*
*
* @see #dispose()
*/
public Pattern(Device device, Image image) {
super(device);
if (image == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
if (image.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
NSAutoreleasePool pool = null;
if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
try {
this.image = image;
color = NSColor.colorWithPatternImage(image.handle);
color.retain();
init();
} finally {
if (pool != null) pool.release();
}
}
/**
* 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.
*
* This operation requires the operating system's advanced
* graphics subsystem which may not be available on some
* platforms.
*
*
* You must dispose the pattern when it is no longer required.
*
*
* @param device the device on which to allocate the pattern
* @param x1 the x coordinate of the starting corner of the gradient
* @param y1 the y coordinate of the starting corner of the gradient
* @param x2 the x coordinate of the ending corner of the gradient
* @param y2 the y coordinate of the ending corner of the gradient
* @param color1 the starting color of the gradient
* @param color2 the ending color of the gradient
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the device is null and there is no current device,
* or if either color1 or color2 is null
* - ERROR_INVALID_ARGUMENT - if either color1 or color2 has been disposed
*
* @exception SWTException
* - ERROR_NO_GRAPHICS_LIBRARY - if advanced graphics are not available
*
* @exception SWTError
* - ERROR_NO_HANDLES if a handle for the pattern could not be obtained
*
*
* @see #dispose()
*/
public Pattern(Device device, float x1, float y1, float x2, float y2, Color color1, Color color2) {
this(device, x1, y1, x2, y2, color1, 0xFF, color2, 0xFF);
}
/**
* 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.
*
* This operation requires the operating system's advanced
* graphics subsystem which may not be available on some
* platforms.
*
*
* You must dispose the pattern when it is no longer required.
*
*
* @param device the device on which to allocate the pattern
* @param x1 the x coordinate of the starting corner of the gradient
* @param y1 the y coordinate of the starting corner of the gradient
* @param x2 the x coordinate of the ending corner of the gradient
* @param y2 the y coordinate of the ending corner of the gradient
* @param color1 the starting color of the gradient
* @param alpha1 the starting alpha value of the gradient
* @param color2 the ending color of the gradient
* @param alpha2 the ending alpha value of the gradient
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the device is null and there is no current device,
* or if either color1 or color2 is null
* - ERROR_INVALID_ARGUMENT - if either color1 or color2 has been disposed
*
* @exception SWTException
* - ERROR_NO_GRAPHICS_LIBRARY - if advanced graphics are not available
*
* @exception SWTError
* - ERROR_NO_HANDLES if a handle for the pattern could not be obtained
*
*
* @see #dispose()
*
* @since 3.2
*/
public Pattern(Device device, float x1, float y1, float x2, float y2, Color color1, int alpha1, Color color2, int alpha2) {
super(device);
if (color1 == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
if (color1.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
if (color2 == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
if (color2.isDisposed()) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
NSAutoreleasePool pool = null;
if (!NSThread.isMainThread()) pool = (NSAutoreleasePool) new NSAutoreleasePool().alloc().init();
try {
pt1 = new NSPoint();
pt2 = new NSPoint();
pt1.x = x1;
pt1.y = y1;
pt2.x = x2;
pt2.y = y2;
this.color1 = color1.handle;
this.color2 = color2.handle;
this.alpha1 = alpha1;
this.alpha2 = alpha2;
NSColor start = NSColor.colorWithDeviceRed(color1.handle[0], color1.handle[1], color1.handle[2], alpha1 / 255f);
NSColor end = NSColor.colorWithDeviceRed(color2.handle[0], color2.handle[1], color2.handle[2], alpha2 / 255f);
gradient = ((NSGradient)new NSGradient().alloc()).initWithStartingColor(start, end);
init();
} finally {
if (pool != null) pool.release();
}
}
@Override
void destroy() {
if (color != null) color.release();
color = null;
if (gradient != null) gradient.release();
gradient = null;
image = null;
color1 = color2 = null;
}
/**
* 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 (except {@link #dispose()}) using the Pattern.
*
* @return true when the Pattern is disposed, and false otherwise
*/
@Override
public boolean isDisposed() {
return device == null;
}
/**
* Returns a string containing a concise, human-readable
* description of the receiver.
*
* @return a string representation of the receiver
*/
@Override
public String toString() {
if (isDisposed()) return "Pattern {*DISPOSED*}";
return "Pattern {" + (color != null ? color.id : gradient.id) + "}";
}
}