Eclipse Remote Application Platform

org.eclipse.swt.widgets
Class ColorDialog

java.lang.Object
  extended by org.eclipse.swt.widgets.Dialog
      extended by org.eclipse.swt.widgets.ColorDialog
All Implemented Interfaces:
Adaptable

public class ColorDialog
extends Dialog

Instances of this class allow the user to select a color from a predefined set of available colors.

Styles:
(none)
Events:
(none)

IMPORTANT: This class is intended to be subclassed only within the SWT implementation.

Since:
1.2

Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Dialog
returnCode, shell
 
Constructor Summary
ColorDialog(Shell parent)
          Constructs a new instance of this class given only its parent.
ColorDialog(Shell parent, int style)
          Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
 
Method Summary
 RGB getRGB()
          Returns the currently selected color in the receiver.
 RGB open()
          Makes the receiver visible and brings it to the front of the display.
protected  void prepareOpen()
           
 void setRGB(RGB rgb)
          Sets the receiver's selected color to be the argument.
 
Methods inherited from class org.eclipse.swt.widgets.Dialog
checkOperationMode, checkSubclass, getAdapter, getParent, getStyle, getText, runEventLoop, setText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ColorDialog

public ColorDialog(Shell parent)
Constructs a new instance of this class given only its parent.

Parameters:
parent - a composite control which will be the parent of the new instance
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
See Also:
SWT, Widget.checkSubclass(), Widget.getStyle()

ColorDialog

public ColorDialog(Shell parent,
                   int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:
parent - a composite control which will be the parent of the new instance (cannot be null)
style - the style of control to construct
Throws:
java.lang.IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
See Also:
SWT, Widget.checkSubclass(), Widget.getStyle()
Method Detail

open

public RGB open()
Makes the receiver visible and brings it to the front of the display.

This method is not supported when running the application in JEE_COMPATIBILITY mode. Use DialogUtil#open instead.

Returns:
the selected color, or null if the dialog was cancelled, no color was selected, or an error occurred
Throws:
SWTException -
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
java.lang.UnsupportedOperationException - when running the application in JEE_COMPATIBILITY mode
See Also:
Application.OperationMode

getRGB

public RGB getRGB()
Returns the currently selected color in the receiver.

Returns:
the RGB value for the selected color, may be null
See Also:
PaletteData.getRGBs()

setRGB

public void setRGB(RGB rgb)
Sets the receiver's selected color to be the argument.

Parameters:
rgb - the new RGB value for the selected color, may be null to let the platform select a default when open() is called
See Also:
PaletteData.getRGBs()

prepareOpen

protected void prepareOpen()
Overrides:
prepareOpen in class Dialog

Eclipse Remote Application Platform

Copyright (c) EclipseSource and others 2002, 2013. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0