net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/ui/text/IColorManagerExtension.java

   1 /*******************************************************************************
   2  * Copyright (c) 2002 International Business Machines Corp. and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  ******************************************************************************/
  11 package net.sourceforge.phpdt.ui.text;
  12
  13 import org.eclipse.swt.graphics.RGB;
  14
  15 /**
  16  * A color manager extension for extending <code>IColorManager</code>
  17  * instances with new functionality.
  18  *
  19  * @since 2.0
  20  */
  21 public interface IColorManagerExtension {
  22
  23         /**
  24          * Remembers the given color specification under the given key.
  25          *
  26          * @param key
  27          *            the color key
  28          * @param rgb
  29          *            the color specification
  30          * @exception UnsupportedOperationException
  31          *                if there is already a color specification remembered under
  32          *                the given key
  33          */
  34         void bindColor(String key, RGB rgb);
  35
  36         /**
  37          * Forgets the color specification remembered under the given key.
  38          *
  39          * @param key
  40          *            the color key
  41          */
  42         void unbindColor(String key);
  43 }