org.gvsig.project.documents.view.legend.symbol

Class ChartSymbol

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

org.gvsig.project.documents.view.legend.symbol.ChartSymbol

All Implemented Interfaces:

Cloneable, IChartSymbol, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IFillSymbol, IMarkerSymbol, Persistent

Direct Known Subclasses:

LinkedChartSymbol

public class ChartSymbol
extends AbstractSymbol
implements IChartSymbol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartSymbol.RegisterPersistence
static class	ChartSymbol.RegisterSymbol

Field Summary

Fields

Modifier and Type	Field and Description
protected ChartService	cs
protected static String	FIELD_CHARTSERVICE
protected static String	FIELD_SYMBOL_FOR_SELECTION

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.chart.legend.symbols.IChartSymbol

SIZEFIELD, SIZEFIXED, SIZESUM, SYMBOL_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, SQUARE_STYLE, STAR_STYLE, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

SELECTION_COLOR

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
ChartSymbol()

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel) Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.
void	drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
ChartService	getChart()
Color	getColor() Returns the color of the marker symbol.
int	getFillAlpha() Obtains the transparency of the fill symbol
Color	getFillColor()
IMask	getMask()
Point2D	getOffset() Gets the offset for a marker symbol
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
ILineSymbol	getOutline() Obtains the ILineSymbol interface of the outline
void	getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi) Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
double	getRotation() Returns the rotation (in radians, counter-clockwise) of the marker symbol
double	getSize() Obtains the size of a marker symbol
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
boolean	hasFill()
boolean	hasOutline()
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi) Informs that the geometry will be represented with that symbol in just one pixel or dot
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(Graphics2D g, AffineTransform at, Geometry geom, PrintAttributes properties)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	set3D(boolean b) Sets if the chart is in three dimensions.
void	setAlpha(int alpha) Defines the transparency of a line symbol.
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setChart(ChartService theChart) Sets the ChartService of this symbol.
void	setChartService(ChartService cs)
void	setColor(Color color) Establishes a color for the marker symbol
void	setFillColor(Color color) Sets the color that will be used to draw the filling pattern of this symbol.
void	setHasFill(boolean hasFill)
void	setHasOutline(boolean hasOutline)
void	setMask(IMask mask) Defines a mask for the symbol
void	setOffset(Point2D offset) Establishes the offset currently set for the marker symbol.
void	setOnlySelection(boolean onlySelection) Sets if draw diagrams only by selection.
void	setOutline(ILineSymbol outline) Sets the color of the outline.
void	setOutlineColor(Color color) Sets the color of outline.
void	setOutlineShow(boolean b) Sets if the outline is draw.
void	setOutlineWidth(int width) Sets the width of outline.
void	setRotation(double rotation) Sets the rotation of the marker symbol
void	setSections(String[] names, Color[] colors) Sets the field names and color to draw the different parts of chart.
void	setSize(double size) Sets the size of symbol.
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

clone, cloneForSelection, equals, getDescription, getID, getReferenceSystem, getUnit, isShapeVisible, setDescription, setID, setIsShapeVisible, setReferenceSystem, setUnit

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

getDescription, isShapeVisible, setDescription

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

clone

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

getReferenceSystem, getUnit, setReferenceSystem, setUnit

Field Detail

FIELD_SYMBOL_FOR_SELECTION

protected static final String FIELD_SYMBOL_FOR_SELECTION

See Also:

Constant Field Values

FIELD_CHARTSERVICE

protected static final String FIELD_CHARTSERVICE

See Also:

Constant Field Values

cs

protected ChartService cs

Constructor Detail

ChartSymbol

public ChartSymbol()

Method Detail

getSymbolForSelection

public ISymbol getSymbolForSelection()

Description copied from interface: ISymbol

Returns the derived version of the symbol that will be used to draw the feature when it is selected.

Specified by:

getSymbolForSelection in interface ISymbol

Returns:

ISymbol applied to a feature when it has been selected.

setChartService

public void setChartService(ChartService cs)

getRotation

public double getRotation()

Description copied from interface: IMarkerSymbol

Returns the rotation (in radians, counter-clockwise) of the marker symbol

Specified by:

getRotation in interface IMarkerSymbol

Returns:

double (rotation)

setRotation

public void setRotation(double rotation)

Description copied from interface: IMarkerSymbol

Sets the rotation of the marker symbol

Specified by:

setRotation in interface IMarkerSymbol

getOffset

public Point2D getOffset()

Description copied from interface: IMarkerSymbol

Gets the offset for a marker symbol

Specified by:

getOffset in interface IMarkerSymbol

Returns:

Point2D

setOffset

public void setOffset(Point2D offset)

Description copied from interface: IMarkerSymbol

Establishes the offset currently set for the marker symbol.

Specified by:

setOffset in interface IMarkerSymbol

getSize

public double getSize()

Description copied from interface: IMarkerSymbol

Obtains the size of a marker symbol

Specified by:

getSize in interface IMarkerSymbol

setAlpha

public void setAlpha(int alpha)

Description copied from interface: IMarkerSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface IMarkerSymbol

getMask

public IMask getMask()

Specified by:

getMask in interface IMarkerSymbol

Returns:

the mask of the symbol

setMask

public void setMask(IMask mask)

Description copied from interface: IMarkerSymbol

Defines a mask for the symbol

Specified by:

setMask in interface IMarkerSymbol

draw

public void draw(Graphics2D g,
                 AffineTransform affineTransform,
                 Geometry geom,
                 Feature f,
                 Cancellable cancel)

Description copied from interface: ISymbol

Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.

Specified by:

draw in interface ISymbol

cancel - TODO

getPixExtentPlus

public void getPixExtentPlus(Geometry geom,
                             float[] distances,
                             ViewPort viewPort,
                             int dpi)

Description copied from interface: ISymbol

Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.

After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.

This distance maybe dependent on:

1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.

And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.

Specified by:

getPixExtentPlus in interface ISymbol

isOneDotOrPixel

public boolean isOneDotOrPixel(Geometry geom,
                               double[] positionOfDotOrPixel,
                               ViewPort viewPort,
                               int dpi)

Description copied from interface: ISymbol

Informs that the geometry will be represented with that symbol in just one pixel or dot

Specified by:

isOneDotOrPixel in interface ISymbol

Overrides:

isOneDotOrPixel in class AbstractSymbol

positionOfDotOrPixel - (out) filled with pixel or dot location

Returns:

getOnePointRgb

public int getOnePointRgb()

Description copied from interface: ISymbol

Returns the rgb of the symbol when it is drawn like a point.

Specified by:

getOnePointRgb in interface ISymbol

Specified by:

getOnePointRgb in interface IFillSymbol

Returns:

rgb of the symbol.

getSymbolType

public int getSymbolType()

Description copied from interface: ISymbol

The use of this method -and its mechanism- is being valorated. It probably will be deprecated.

Specified by:

getSymbolType in interface ISymbol

Returns:

FSymbol constants. I think it is better to use isSuitableFor

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Specified by:

isSuitableFor in interface ISymbol

Specified by:

isSuitableFor in interface IFillSymbol

Returns:

drawInsideRectangle

public void drawInsideRectangle(Graphics2D g,
                                AffineTransform scaleInstance,
                                Rectangle r,
                                PrintAttributes properties)
                         throws SymbolDrawingException

Description copied from interface: ISymbol

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.

Specified by:

drawInsideRectangle in interface ISymbol

properties - TODO

Throws:

SymbolDrawingException - TODO

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractSymbol

Throws:

PersistenceException

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractSymbol

Throws:

PersistenceException

print

public void print(Graphics2D g,
                  AffineTransform at,
                  Geometry geom,
                  PrintAttributes properties)

Specified by:

print in interface IPrintable

setSections

public void setSections(String[] names,
                        Color[] colors)

Description copied from interface: IChartSymbol

Sets the field names and color to draw the different parts of chart.

Specified by:

setSections in interface IChartSymbol

setSize

public void setSize(double size)

Description copied from interface: IChartSymbol

Sets the size of symbol.

Specified by:

setSize in interface IChartSymbol

Specified by:

setSize in interface IMarkerSymbol

Parameters:

size - of symbol.

set3D

public void set3D(boolean b)

Description copied from interface: IChartSymbol

Sets if the chart is in three dimensions.

Specified by:

set3D in interface IChartSymbol

setOutlineColor

public void setOutlineColor(Color color)

Description copied from interface: IChartSymbol

Sets the color of outline.

Specified by:

setOutlineColor in interface IChartSymbol

setOutlineShow

public void setOutlineShow(boolean b)

Description copied from interface: IChartSymbol

Sets if the outline is draw.

Specified by:

setOutlineShow in interface IChartSymbol

setOutlineWidth

public void setOutlineWidth(int width)

Description copied from interface: IChartSymbol

Sets the width of outline.

Specified by:

setOutlineWidth in interface IChartSymbol

setChart

public void setChart(ChartService theChart)

Description copied from interface: IChartSymbol

Sets the ChartService of this symbol.

Specified by:

setChart in interface IChartSymbol

getChart

public ChartService getChart()

Specified by:

getChart in interface IChartSymbol

setOnlySelection

public void setOnlySelection(boolean onlySelection)

Description copied from interface: IChartSymbol

Sets if draw diagrams only by selection.

Specified by:

setOnlySelection in interface IChartSymbol

toCartographicSize

public double toCartographicSize(ViewPort viewPort,
                                 double dpi,
                                 Geometry geom)

Description copied from interface: CartographicSupport

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

setCartographicSize

public void setCartographicSize(double cartographicSize,
                                Geometry geom)

Description copied from interface: CartographicSupport

Sets the size of the cartographic element in pixels.

Specified by:

setCartographicSize in interface CartographicSupport

getCartographicSize

public double getCartographicSize(ViewPort viewPort,
                                  double dpi,
                                  Geometry geom)

Description copied from interface: CartographicSupport

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

double containing the size in [screen/printer] pixels for the current symbol

getColor

public Color getColor()

Description copied from interface: IMarkerSymbol

Returns the color of the marker symbol.

Specified by:

getColor in interface ISymbol

Specified by:

getColor in interface IMarkerSymbol

Returns:

Color

setColor

public void setColor(Color color)

Description copied from interface: IMarkerSymbol

Establishes a color for the marker symbol

Specified by:

setColor in interface ISymbol

Specified by:

setColor in interface IMarkerSymbol

Parameters:

color - to render the symbol

setFillColor

public void setFillColor(Color color)

Description copied from interface: IFillSymbol

Sets the color that will be used to draw the filling pattern of this symbol.

Specified by:

setFillColor in interface IFillSymbol

setOutline

public void setOutline(ILineSymbol outline)

Description copied from interface: IFillSymbol

Sets the color of the outline.

Specified by:

setOutline in interface IFillSymbol

getFillColor

public Color getFillColor()

Specified by:

getFillColor in interface IFillSymbol

Returns:

Returns the color.

getOutline

public ILineSymbol getOutline()

Description copied from interface: IFillSymbol

Obtains the ILineSymbol interface of the outline

Specified by:

getOutline in interface IFillSymbol

Returns:

the outline,ILineSymbol.

getFillAlpha

public int getFillAlpha()

Description copied from interface: IFillSymbol

Obtains the transparency of the fill symbol

Specified by:

getFillAlpha in interface IFillSymbol

Returns:

the transparency of the fill symbol

hasFill

public boolean hasFill()

Specified by:

hasFill in interface IFillSymbol

setHasFill

public void setHasFill(boolean hasFill)

Specified by:

setHasFill in interface IFillSymbol

hasOutline

public boolean hasOutline()

Specified by:

hasOutline in interface IFillSymbol

setHasOutline

public void setHasOutline(boolean hasOutline)

Specified by:

setHasOutline in interface IFillSymbol