Class ColorEditor

java.lang.Object
java.beans.PropertyEditorSupport
docking.options.editor.ColorEditor
All Implemented Interfaces:
PropertyEditor

public class ColorEditor extends PropertyEditorSupport
Color editor that uses the JColorChooser.
  • Constructor Details

    • ColorEditor

      public ColorEditor()
      The default constructor.
  • Method Details

    • getCustomEditor

      public Component getCustomEditor()
      A PropertyEditor may chose to make available a full custom Component that edits its property value. It is the responsibility of the PropertyEditor to hook itself up to its editor Component itself and to report property value changes by firing a PropertyChange event.

      The higher-level code that calls getCustomEditor may either embed the Component in some larger property sheet, or it may put it in its own individual dialog, or ...

      Specified by:
      getCustomEditor in interface PropertyEditor
      Overrides:
      getCustomEditor in class PropertyEditorSupport
      Returns:
      A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.
    • supportsCustomEditor

      public boolean supportsCustomEditor()
      Determines whether the propertyEditor can provide a custom editor.
      Specified by:
      supportsCustomEditor in interface PropertyEditor
      Overrides:
      supportsCustomEditor in class PropertyEditorSupport
      Returns:
      True if the propertyEditor can provide a custom editor.
    • setValue

      public void setValue(Object value)
      Set (or change) the object that is to be edited.
      Specified by:
      setValue in interface PropertyEditor
      Overrides:
      setValue in class PropertyEditorSupport
      Parameters:
      value - The new target object to be edited. Note that this object should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold any modified value.
    • getValue

      public Object getValue()
      Get the value.
      Specified by:
      getValue in interface PropertyEditor
      Overrides:
      getValue in class PropertyEditorSupport
    • isPaintable

      public boolean isPaintable()
      Return true which this editor can paint its property value.
      Specified by:
      isPaintable in interface PropertyEditor
      Overrides:
      isPaintable in class PropertyEditorSupport
    • paintValue

      public void paintValue(Graphics gfx, Rectangle box)
      Paint a representation of the value into a given area of screen real estate. Note that the propertyEditor is responsible for doing its own clipping so that it fits into the given rectangle.

      If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop.

      Specified by:
      paintValue in interface PropertyEditor
      Overrides:
      paintValue in class PropertyEditorSupport
      Parameters:
      gfx - Graphics object to paint into.
      box - Rectangle within graphics object into which we should paint.