Package org.eclipse.jface.preference

Class ColorSelector

  • public class ColorSelector
extends EventManager
    The ColorSelector is a wrapper for a button that displays a selected Color and allows the user to change the selection.

    • Field Detail

      • PROP_COLORCHANGE

        public static final String PROP_COLORCHANGE
        Property name that signifies the selected color of this ColorSelector has changed.
        Since:
        3.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • ColorSelector

        public ColorSelector​(Composite parent)
        Create a new instance of the receiver and the button that it wrappers in the supplied parent Composite.
        Parameters:
        parent - The parent of the button.

    • Method Detail

      • addListener

        public void addListener​(IPropertyChangeListener listener)
        Adds a property change listener to this ColorSelector. Events are fired when the color in the control changes via the user clicking an selecting a new one in the color dialog. No event is fired in the case where setColorValue(RGB) is invoked.
        Parameters:
        listener - a property change listener
        Since:
        3.0

      • getButton

        public Button getButton()
        Get the button control being wrappered by the selector.
        Returns:
        Button

      • getColorValue

        public RGB getColorValue()
        Return the currently displayed color.
        Returns:
        RGB

      • removeListener

        public void removeListener​(IPropertyChangeListener listener)
        Removes the given listener from this ColorSelector. Has no effect if the listener is not registered.
        Parameters:
        listener - a property change listener
        Since:
        3.0

      • setColorValue

        public void setColorValue​(RGB rgb)
        Set the current color value and update the control.
        Parameters:
        rgb - The new color.

      • setEnabled

        public void setEnabled​(boolean state)
        Set whether or not the button is enabled.
        Parameters:
        state - the enabled state.

      • updateColorImage

        protected void updateColorImage()
        Update the image being displayed on the button using the current color setting.

      • open

        public void open()
        Activate the editor for this selector. This causes the color selection dialog to appear and wait for user input.
        Since:
        3.2