org.eclipse.birt.chart.model.component.ChartPreferences 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.layout.Block;
import org.eclipse.emf.common.util.EList;

/**
 *  A representation of the model object 'Chart Preferences'. 
 *
 * 
 * 
 * 			This type defines the global chart preferences.
 * 			
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.birt.chart.model.component.ChartPreferences#getLabels Labels}
 *   {@link org.eclipse.birt.chart.model.component.ChartPreferences#getBlocks Blocks}
 * 
 * 
 *
 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getChartPreferences()
 * @model extendedMetaData="name='ChartPreferences' kind='elementOnly'"
 * @deprecated only reserved for compatibility
 */
public interface ChartPreferences extends IChartObject
{

	/**
	 * Returns the value of the 'Labels' containment reference list. The list contents are of type
	 * {@link org.eclipse.birt.chart.model.component.Label}.   
	 * 
	 * A collection of labels holding preferences for the various labels used in a chart.
	 * 
	 * 
	 * 
	 * @return the value of the 'Labels' containment reference list.
	 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getChartPreferences_Labels()
	 * @model type="org.eclipse.birt.chart.model.component.Label" containment="true" resolveProxies="false"
	 *        required="true"
	 * @generated
	 */
	EList getLabels( );

	/**
	 * Returns the value of the 'Blocks' containment reference list. The list contents are of type
	 * {@link org.eclipse.birt.chart.model.layout.Block}.   
	 * 
	 * A collection of blocks holding preferences for the different blocks used in a chart.
	 * 
	 * 
	 * 
	 * @return the value of the 'Blocks' containment reference list.
	 * @see org.eclipse.birt.chart.model.component.ComponentPackage#getChartPreferences_Blocks()
	 * @model type="org.eclipse.birt.chart.model.layout.Block" containment="true" resolveProxies="false" required="true"
	 * @generated
	 */
	EList getBlocks( );

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

} // ChartPreferences