xdev.ui.utils.ColorParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of csapi Show documentation

XDEV Component Suite

There is a newer version: 6.0.2

package xdev.ui.utils;

/*-
 * #%L
 * XDEV BI Suite
 * %%
 * Copyright (C) 2011 - 2021 XDEV Software
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import java.awt.Color;


/**
 * Parses color values, for example RGB, HEX-Strings or color
 * Integer color values to {@link Color} objects.
 * 
 * @author XDEV Software jwill
 * @since 4.0
 */
public interface ColorParser
{
	/**
	 * Parses RGB color Strings into their {@link Color}
	 * representation.
	 * 
	 * @param rgbColorValue
	 *            the rgbColorValue
	 * 
	 * @return the {@link Color} representation of the given color
	 *         String or null if the given value is
	 *         not valid.
	 */
	public Color convertFromRGBString(String rgbColorValue);
	
	
	/**
	 * Parses HEX color Strings into their {@link Color}
	 * representation.
	 * 
	 * @param hexColorValue
	 *            the hexColorValue.
	 * 
	 * @return the {@link Color} representation of the given color
	 *         String or null if the given value is
	 *         not valid.
	 */
	public Color convertFromHexString(String hexColorValue);
	
	
	/**
	 * Parses Integer colors into their {@link Color}
	 * representation.
	 * 
	 * @param integerColorvalue
	 *            the integerColorvalue.
	 * 
	 * @return the {@link Color} representation of the given color
	 *         Integer or null if the given value is
	 *         not valid.
	 */
	public Color convertFromInteger(Integer integerColorvalue);
}