icolordecorator.java

jfa2ce 源码帮助开发人员更好的理解运用

/*******************************************************************************
 * Copyright (c) 2004, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.viewers;

import org.eclipse.swt.graphics.Color;

/**
 * The IColorDecorator is an interface for objects that return a color to
 * decorate either the foreground and background colors for displaying an
 * an object.
 * 
 * If an IColorDecorator decorates a foreground or background in an object 
 * that also has an IColorProvider the IColorDecorator will take precendence.
 * @see IColorProvider
 * 
 * @since 3.1
 */
public interface IColorDecorator {
	
	/**
	 * Return the foreground Color for element or <code>null</code> if there
	 * is not one.
	 * @param element
	 * @return Color or <code>null</code>
	 */
	public Color decorateForeground(Object element);
	
	/**
	 * Return the background Color for element or <code>null</code> if there
	 * is not one.
	 * @param element
	 * @return Color or <code>null</code>
	 */
	public Color decorateBackground(Object element);

}