org.eclipse.birt.chart.model.component.Needle Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.birt.runtime Show documentation
A component of the BIRT runtime
There is a newer version: 4.6.0-20160607
Show newest version
/***********************************************************************
 * Copyright (c) 2004 Actuate Corporation.
 * 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:
 * Actuate Corporation - initial API and implementation
 ***********************************************************************/

package org.eclipse.birt.chart.model.component;

import org.eclipse.birt.chart.model.IChartObject;
import org.eclipse.birt.chart.model.attribute.LineAttributes;
import org.eclipse.birt.chart.model.attribute.LineDecorator;

/**
 * 
 * A representation of the model object 'Needle'.
 * 
 *
 * 
 * 			This type defines a needle of a dial.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.birt.chart.model.component.Needle#getLineAttributes Line Attributes}
 *   {@link org.eclipse.birt.chart.model.component.Needle#getDecorator Decorator}
 * 
 * 
 *
 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getNeedle()
 * @model extendedMetaData="name='Needle' kind='elementOnly'"
 * @extends IChartObject
 * @generated
 */
public interface Needle extends IChartObject
{

	/**
	 * Returns the value of the 'Line Attributes' containment reference.
	 * 
	 * 
	 * 
	 * Specify the line properties for the needle.
	 * 
	 * @return the value of the 'Line Attributes' containment reference.
	 * @see #setLineAttributes(LineAttributes)
	 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getNeedle_LineAttributes()
	 * @model containment="true" required="true"
	 *        extendedMetaData="kind='element' name='LineAttributes'"
	 * @generated
	 */
	LineAttributes getLineAttributes( );

	/**
	 * Sets the value of the '{@link org.eclipse.birt.chart.model.component.Needle#getLineAttributes Line Attributes}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Line Attributes' containment reference.
	 * @see #getLineAttributes()
	 * @generated
	 */
	void setLineAttributes( LineAttributes value );

	/**
	 * Returns the value of the 'Decorator' attribute.
	 * The literals are from the enumeration {@link org.eclipse.birt.chart.model.attribute.LineDecorator}.
	 * 
	 * 
	 * 
	 * Specify the line decorator for the needle.
	 * 
	 * @return the value of the 'Decorator' attribute.
	 * @see org.eclipse.birt.chart.model.attribute.LineDecorator
	 * @see #isSetDecorator()
	 * @see #unsetDecorator()
	 * @see #setDecorator(LineDecorator)
	 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getNeedle_Decorator()
	 * @model unsettable="true" required="true"
	 *        extendedMetaData="kind='element' name='Decorator'"
	 * @generated
	 */
	LineDecorator getDecorator( );

	/**
	 * Sets the value of the '{@link org.eclipse.birt.chart.model.component.Needle#getDecorator Decorator}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Decorator' attribute.
	 * @see org.eclipse.birt.chart.model.attribute.LineDecorator
	 * @see #isSetDecorator()
	 * @see #unsetDecorator()
	 * @see #getDecorator()
	 * @generated
	 */
	void setDecorator( LineDecorator value );

	/**
	 * Unsets the value of the '{@link org.eclipse.birt.chart.model.component.Needle#getDecorator Decorator}' attribute.
	 * 
	 * 
	 * @see #isSetDecorator()
	 * @see #getDecorator()
	 * @see #setDecorator(LineDecorator)
	 * @generated
	 */
	void unsetDecorator( );

	/**
	 * Returns whether the value of the '{@link org.eclipse.birt.chart.model.component.Needle#getDecorator Decorator}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Decorator' attribute is set.
	 * @see #unsetDecorator()
	 * @see #getDecorator()
	 * @see #setDecorator(LineDecorator)
	 * @generated
	 */
	boolean isSetDecorator( );

	/**
	 * @generated
	 */
	Needle copyInstance( );

} // Needle