org.eclipse.swtchart.ISeriesLabel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rwtchart Show documentation
NetXMS fork of SWT Chart Library for RWT
The newest version!
/*******************************************************************************
 * Copyright (c) 2008, 2019 SWTChart project.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 * 
 * Contributors:
 * yoshitaka - initial API and implementation
 *******************************************************************************/
package org.eclipse.swtchart;

import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;

/**
 * A series label.
 */
public interface ISeriesLabel {

	/**
	 * Sets the decimal format {@link java.text.DecimalFormat} or/plus plain string.
	 * 
	 * If formats have been set with setFormats(String[]), the format
	 * set with this method will be ignored.
	 * 
	 * If null is given, default format "#.###########" will be set.
	 *
	 * @param format
	 *            the format
	 */
	void setFormat(String format);

	/**
	 * Gets the format for label.
	 *
	 * @return the format
	 */
	String getFormat();

	/**
	 * Sets the formats for all data points. If null or empty array is given, formats will
	 * be cleared, and the format set with setFormat(String) will be used
	 * instead.
	 *
	 * @param formats
	 *            the formats
	 */
	void setFormats(String[] formats);

	/**
	 * Gets the formats for all data points.
	 *
	 * @return the formats, or empty array if not set
	 */
	String[] getFormats();

	/**
	 * Sets the label color. If null is given, default color will be set.
	 *
	 * @param color
	 *            the label color
	 */
	void setForeground(Color color);

	/**
	 * Gets the label color.
	 *
	 * @return the label color
	 */
	Color getForeground();

	/**
	 * Sets the label font.
	 *
	 * @param font
	 *            the label font
	 */
	void setFont(Font font);

	/**
	 * Gets the label font.
	 *
	 * @return the label font
	 */
	Font getFont();

	/**
	 * Sets the label visibility state.
	 *
	 * @param visible
	 *            the label visibility state
	 */
	void setVisible(boolean visible);

	/**
	 * Gets the label visibility state.
	 *
	 * @return true if label is visible
	 */
	boolean isVisible();
}