org.gvsig.chart.legend

Interface IChartLegend

All Superinterfaces:

Cloneable, DrawingObservable, IClassifiedLegend, IClassifiedVectorLegend, ILegend, IVectorialUniqueValueLegend, IVectorLegend, Legend, Persistent

All Known Subinterfaces:

IBarsChartLegend, ILinkedChartLegend, IPieChartLegend

All Known Implementing Classes:

BarsChartLegend, LinkedChartLegend, PieChartLegend

public interface IChartLegend
extends IVectorialUniqueValueLegend

Interface to represents charts legend.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BARSCHART_LEGEND_NAME
static String	LINKED_LEGEND_NAME
static String	PIECHART_LEGEND_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

LEGEND_NAME

Method Summary

Modifier and Type	Method and Description
ISymbol	getBackgroundSymbol() Gets the background symbol of this legend
Color[]	getColors() Gets the colors of represent different parts of chart symbol
String[]	getFieldLabels() Gets the field's labels of the chart.
String	getFieldNormalize() Gets the field to represent the normalize size of chart.
String	getFieldSize() Gets the field to represent the size of chart.
Color	getOutlineColor() Return the color of the outline
int	getOutlineWidth() Return the width of the outline
int	getReferenceSystem()
int	getSize() Return the size of symbol
int	getSizeFrom() Gets the limit size minimum of chart.
int	getSizeOption() Gets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD
int	getSizeTo() Gets the limit size maximum of chart.
int	getUnit() Gets the selected unit, the default selected is in pixels.
boolean	is3D() Return true if the chart is 3D.
boolean	isActiveLimits() Gets if the limits of size chart are active.
boolean	isOnlySelection() Gets if draw only diagrams of selection.
boolean	isOutlineShow() Return true if the chart show outline
void	setActiveLimits(boolean b) Sets if the limits of size chart are active.
void	setBackgroundSymbol(ISymbol backgroundSymbol) Sets the background symbol of this legend
void	setColors(Color[] colors) Sets the colors of represent different parts of chart symbol
void	setFieldNormalize(String selectedItem) Sets the field to represent the normalize size of chart.
void	setFields(String[] fields) Only the fields that will be used inside the Chart (you don't have to include here getFieldSize or getFieldNormalize)
void	setFieldSize(String selectedItem) Sets the field to represent the size of chart.
void	setIs3D(boolean b) Sets if the chart is 3D
void	setLabels(String[] labels)
void	setMaxFeature(double max)
void	setMinFeature(double min)
void	setOnlySelection(boolean onlySelection) Draw only the diagram of selection.
void	setOutlineColor(Color outlineColor) Sets the color of outline
void	setOutlineShow(boolean isOutlineShow) Sets if the chart show outline
void	setOutlineWidth(int outlineWidth) Sets the width of outline
void	setReferenceSystem(int selectedIndex)
void	setSize(int size) Sets size of symbols with the fixed size selected
void	setSizeFrom(int integer) Sets the limit size minimum of chart.
void	setSizeOption(int option) Sets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD
void	setSizeTo(int integer) Sets the limit size maximum of chart.
void	setUnit(int selectedItem) Sets the selected unit, the default selected is in pixels.

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

getColorScheme, getSymbolByValue, getSymbolKey, getZSort, setColorScheme, setValueSymbolByID, setZSort

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend

addSymbol, clear, delSymbol, getClassifyingFieldNames, getClassifyingFieldTypes, replace, setClassifyingFieldNames, setClassifyingFieldTypes

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedLegend

getDescriptions, getSymbols, getValues

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

draw, draw, getDefaultSymbol, getShapeType, getSymbolByFeature, isSuitableForShapeType, isUseDefaultSymbol, print, print, setDefaultSymbol, setShapeType, useDefaultSymbol

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ILegend

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

BARSCHART_LEGEND_NAME

static final String BARSCHART_LEGEND_NAME

See Also:

Constant Field Values

PIECHART_LEGEND_NAME

static final String PIECHART_LEGEND_NAME

See Also:

Constant Field Values

LINKED_LEGEND_NAME

static final String LINKED_LEGEND_NAME

See Also:

Constant Field Values

Method Detail

getBackgroundSymbol

ISymbol getBackgroundSymbol()

Gets the background symbol of this legend

Returns:

ISymbol the symbol for the background

setBackgroundSymbol

void setBackgroundSymbol(ISymbol backgroundSymbol)

Sets the background symbol of this legend

Parameters:

backgroundSymbol - the symbol for the background

is3D

boolean is3D()

Return true if the chart is 3D.

Returns:

boolean if the chart is 3D

setIs3D

void setIs3D(boolean b)

Sets if the chart is 3D

getSize

int getSize()

Return the size of symbol

Returns:

int Size of symbol

setSize

void setSize(int size)

Sets size of symbols with the fixed size selected

isOutlineShow

boolean isOutlineShow()

Return true if the chart show outline

Returns:

boolean if chart show outline

setOutlineShow

void setOutlineShow(boolean isOutlineShow)

Sets if the chart show outline

getOutlineColor

Color getOutlineColor()

Return the color of the outline

Returns:

Color of outline

setOutlineColor

void setOutlineColor(Color outlineColor)

Sets the color of outline

getOutlineWidth

int getOutlineWidth()

Return the width of the outline

Returns:

int width of outline

setOutlineWidth

void setOutlineWidth(int outlineWidth)

Sets the width of outline

getSizeOption

int getSizeOption()

Gets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD

Returns:

integer to represents the option.

getFieldSize

String getFieldSize()

Gets the field to represent the size of chart.

Returns:

String field of size.

getFieldNormalize

String getFieldNormalize()

Gets the field to represent the normalize size of chart.

Returns:

String field of normalize size.

getFieldLabels

String[] getFieldLabels()

Gets the field's labels of the chart.

Returns:

String labels of the fields.

getSizeFrom

int getSizeFrom()

Gets the limit size minimum of chart.

Returns:

integer minimum size.

getSizeTo

int getSizeTo()

Gets the limit size maximum of chart.

Returns:

integer maximum size.

getUnit

int getUnit()

Gets the selected unit, the default selected is in pixels.

Returns:

integer unit selected.

setSizeFrom

void setSizeFrom(int integer)

Sets the limit size minimum of chart.

Parameters:

integer - minimum size.

setSizeTo

void setSizeTo(int integer)

Sets the limit size maximum of chart.

Parameters:

integer - maximum size.

setUnit

void setUnit(int selectedItem)

Sets the selected unit, the default selected is in pixels.

Parameters:

integer - unit selected.

setFieldSize

void setFieldSize(String selectedItem)

Sets the field to represent the size of chart.

Parameters:

String - field of size.

setFieldNormalize

void setFieldNormalize(String selectedItem)

Sets the field to represent the normalize size of chart.

Parameters:

String - field of normalize size.

setSizeOption

void setSizeOption(int option)

Sets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD

isActiveLimits

boolean isActiveLimits()

Gets if the limits of size chart are active.

Returns:

boolean true if the limits of size are active.

setActiveLimits

void setActiveLimits(boolean b)

Sets if the limits of size chart are active.

Parameters:

boolean - true if the limits of size are active.

getColors

Color[] getColors()

Gets the colors of represent different parts of chart symbol

Returns:

Color[] colors of parts

setColors

void setColors(Color[] colors)

Sets the colors of represent different parts of chart symbol

Parameters:

Color[] - colors of parts

setOnlySelection

void setOnlySelection(boolean onlySelection)

Draw only the diagram of selection.

Parameters:

boolean - true if draw only selection.

isOnlySelection

boolean isOnlySelection()

Gets if draw only diagrams of selection.

Returns:

boolean true if draw only selection.

getReferenceSystem

int getReferenceSystem()

setReferenceSystem

void setReferenceSystem(int selectedIndex)

setMinFeature

void setMinFeature(double min)

setMaxFeature

void setMaxFeature(double max)

setFields

void setFields(String[] fields)

Only the fields that will be used inside the Chart (you don't have to include here getFieldSize or getFieldNormalize)

Parameters:

fields -

setLabels

void setLabels(String[] labels)