Class Color
RGB or RGBA.
Colors do not need to be disposed, however to maintain compatibility with older code, disposing a Color is not an error. As Colors do not require disposal, the constructors which do not require a Device are recommended.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionintthe handle to the OS color resource (Warning: This field is platform dependent) -
Constructor Summary
ConstructorsConstructorDescriptionColor(int red, int green, int blue) Constructs a new instance of this class given the desired red, green and blue values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).Color(int red, int green, int blue, int alpha) Constructs a new instance of this class given the desired red, green, blue & alpha values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).Constructs a new instance of this class given a device and the desired red, green and blue values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).Constructs a new instance of this class given a device and the desired red, green, blue & alpha values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).Constructs a new instance of this class given a device and anRGBdescribing the desired red, green and blue values.Constructs a new instance of this class given a device and anRGBAdescribing the desired red, green, blue & alpha values.Constructs a new instance of this class given a device, anRGBdescribing the desired red, green and blue values, alpha specifying the level of transparency.Constructs a new instance of this class given anRGBdescribing the desired red, green and blue values.Constructs a new instance of this class given anRGBAdescribing the desired red, green, blue & alpha values.Constructs a new instance of this class given anRGBdescribing the desired red, green and blue values, alpha specifying the level of transparency. -
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Colors do not need to be disposed, however to maintain compatibility with older code, disposing a Color is not an error.booleanCompares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.intgetAlpha()Returns the amount of alpha in the color, from 0 (transparent) to 255 (opaque).intgetBlue()Returns the amount of blue in the color, from 0 to 255.Returns theDevicewhere this resource was created.intgetGreen()Returns the amount of green in the color, from 0 to 255.intgetRed()Returns the amount of red in the color, from 0 to 255.getRGB()Returns anRGBrepresenting the receiver.getRGBA()Returns anRGBArepresenting the receiver.inthashCode()Returns an integer hash code for the receiver.booleanReturnstrueif the color has been disposed, andfalseotherwise.toString()Returns a string containing a concise, human-readable description of the receiver.static ColorInvokes platform specific functionality to allocate a new color.static ColorInvokes platform specific functionality to allocate a new color.Methods inherited from class org.eclipse.swt.graphics.Resource
setNonDisposeHandler
-
Field Details
-
handle
public int handlethe handle to the OS color resource (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.
- Restriction:
- This field is not intended to be referenced by clients.
-
-
Constructor Details
-
Color
Constructs a new instance of this class given a device and the desired red, green and blue values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).- Parameters:
device- the device on which to allocate the colorred- the amount of red in the colorgreen- the amount of green in the colorblue- the amount of blue in the color- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_INVALID_ARGUMENT - if the red, green or blue argument is not between 0 and 255
- See Also:
-
Color
public Color(int red, int green, int blue) Constructs a new instance of this class given the desired red, green and blue values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).- Parameters:
red- the amount of red in the colorgreen- the amount of green in the colorblue- the amount of blue in the color- Throws:
IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the red, green or blue argument is not between 0 and 255
- Since:
- 3.115
-
Color
Constructs a new instance of this class given a device and the desired red, green, blue & alpha values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).- Parameters:
device- the device on which to allocate the colorred- the amount of red in the colorgreen- the amount of green in the colorblue- the amount of blue in the coloralpha- the amount of alpha in the color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha argument is not between 0 and 255
- Since:
- 3.104
- See Also:
-
Color
public Color(int red, int green, int blue, int alpha) Constructs a new instance of this class given the desired red, green, blue & alpha values expressed as ints in the range 0 to 255 (where 0 is black and 255 is full brightness).- Parameters:
red- the amount of red in the colorgreen- the amount of green in the colorblue- the amount of blue in the coloralpha- the amount of alpha in the color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha argument is not between 0 and 255
- Since:
- 3.115
-
Color
Constructs a new instance of this class given a device and anRGBdescribing the desired red, green and blue values.- Parameters:
device- the device on which to allocate the colorrgb- the RGB values of the desired color- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_NULL_ARGUMENT - if the rgb argument is null
- ERROR_INVALID_ARGUMENT - if the red, green or blue components of the argument are not between 0 and 255
- See Also:
-
Color
Constructs a new instance of this class given anRGBdescribing the desired red, green and blue values.- Parameters:
rgb- the RGB values of the desired color- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if the rgb argument is null
- ERROR_INVALID_ARGUMENT - if the red, green or blue components of the argument are not between 0 and 255
- Since:
- 3.115
-
Color
Constructs a new instance of this class given a device and anRGBAdescribing the desired red, green, blue & alpha values.- Parameters:
device- the device on which to allocate the colorrgba- the RGBA values of the desired color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_NULL_ARGUMENT - if the rgba argument is null
- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255
- Since:
- 3.104
- See Also:
-
Color
Constructs a new instance of this class given anRGBAdescribing the desired red, green, blue & alpha values.- Parameters:
rgba- the RGBA values of the desired color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if the rgba argument is null
- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255
- Since:
- 3.115
-
Color
Constructs a new instance of this class given a device, anRGBdescribing the desired red, green and blue values, alpha specifying the level of transparency.- Parameters:
device- the device on which to allocate the colorrgb- the RGB values of the desired coloralpha- the alpha value of the desired color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if device is null and there is no current device
- ERROR_NULL_ARGUMENT - if the rgb argument is null
- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255
- Since:
- 3.104
- See Also:
-
Color
Constructs a new instance of this class given anRGBdescribing the desired red, green and blue values, alpha specifying the level of transparency.- Parameters:
rgb- the RGB values of the desired coloralpha- the alpha value of the desired color. Currently, SWT only honors extreme values for alpha i.e. 0 (transparent) or 255 (opaque).- Throws:
IllegalArgumentException-- ERROR_NULL_ARGUMENT - if the rgb argument is null
- ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255
- Since:
- 3.115
-
-
Method Details
-
dispose
public void dispose()Colors do not need to be disposed, however to maintain compatibility with older code, disposing a Color is not an error. -
getDevice
Returns theDevicewhere this resource was created. In cases where noDevicewas used at creation, returns the current or default Device.As Color does not require a Device it is recommended to not use
getDevice(). -
equals
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. -
getAlpha
public int getAlpha()Returns the amount of alpha in the color, from 0 (transparent) to 255 (opaque).- Returns:
- the alpha component of the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
- Since:
- 3.104
-
getBlue
public int getBlue()Returns the amount of blue in the color, from 0 to 255.- Returns:
- the blue component of the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
-
getGreen
public int getGreen()Returns the amount of green in the color, from 0 to 255.- Returns:
- the green component of the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
-
getRed
public int getRed()Returns the amount of red in the color, from 0 to 255.- Returns:
- the red component of the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
-
getRGB
Returns anRGBrepresenting the receiver.- Returns:
- the RGB for the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
-
getRGBA
Returns anRGBArepresenting the receiver.- Returns:
- the RGBA for the color
- Throws:
SWTException-- ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed
- Since:
- 3.104
-
hashCode
public int hashCode()Returns an integer hash code for the receiver. Any two objects that returntruewhen passed toequalsmust return the same value for this method. -
isDisposed
public boolean isDisposed()Returnstrueif the color has been disposed, andfalseotherwise.This method gets the dispose state for the color. When a color has been disposed, it is an error to invoke any other method (except
dispose()) using the color.- Specified by:
isDisposedin classResource- Returns:
truewhen the color is disposed andfalseotherwise
-
toString
Returns a string containing a concise, human-readable description of the receiver. -
win32_new
Invokes platform specific functionality to allocate a new color.IMPORTANT: This method is not part of the public API for
Color. 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 called from application code.- Parameters:
device- the device on which to allocate the colorhandle- the handle for the color- Returns:
- a new color object containing the specified device and handle
- Restriction:
- This method is not intended to be referenced by clients.
-
win32_new
Invokes platform specific functionality to allocate a new color.IMPORTANT: This method is not part of the public API for
Color. 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 called from application code.- Parameters:
device- the device on which to allocate the colorhandle- the handle for the coloralpha- the int for the alpha content in the color- Returns:
- a new color object containing the specified device and handle
- Restriction:
- This method is not intended to be referenced by clients.
-