view org.eclipse.jface/src/org/eclipse/jface/viewers/IColorDecorator.d @ 12:bc29606a740c

Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2004, 2007 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
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module org.eclipse.jface.viewers.IColorDecorator;

import java.lang.all;

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 precedence.
 * @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);

}