org.orbisgis.legend.structure.graphic

Class MarkGraphicLegend

java.lang.Object

org.orbisgis.legend.structure.graphic.MarkGraphicLegend

All Implemented Interfaces:

LegendStructure

Direct Known Subclasses:

ConstantFormWKN

public class MarkGraphicLegend
extends Object
implements LegendStructure

The default LegendStructure for a MarkGraphic instance. When proceeding to an anlysis, it will be obtained only if we are unable to recognize a more accurate pattern.

This LegendStructure realization is dependant upon the following parameters, that are stored here are LegendStructure instances :

• The well-known name
• The view box
• The fill
• The stroke

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
MarkGraphicLegend() Builds a new default MarkGraphicLegend associated to a default MarkGraphic.
MarkGraphicLegend(MarkGraphic mark, ParameterLegend wknLegend, LegendStructure viewBoxLegend, FillLegend fillLegend, StrokeLegend strokeLegend) Build a default LegendStructure that describes a MarkGraphic instance.

Method Summary

Methods

Modifier and Type	Method and Description
LegendStructure	getFillLegend() Get the LegendStructure associated to the Fill of the associated MarkGraphic.
MarkGraphic	getMarkGraphic() Gets the MarkGraphic associated to this LegendStructure.
LegendStructure	getStrokeLegend() Get the LegendStructure associated to the Stroke contained in the inner MarkGraphic instance.
LegendStructure	getViewBoxLegend() Get the LegendStructure associated to the ViewBox contained in the inner MarkGraphic instance.
LegendStructure	getWknLegend() Get the legend associated to the inner well-known name representation.
void	setFillLegend(FillLegend fillLegend) Set the LegendStructure associated to the Fill of the associated
void	setMarkGraphic(MarkGraphic markGraphic) Sets the MarkGraphic associated to this LegendStructure.
void	setStrokeLegend(StrokeLegend strokeLegend) Set the LegendStructure associated to the Stroke contained in the inner MarkGraphic instance.
void	setViewBoxLegend(ViewBoxLegend viewBoxLegend) Set the LegendStructure associated to the ViewBox contained in the inner MarkGraphic instance.
void	setWknLegend(ParameterLegend wknLegend) Sets the legend associated representing the well-known name associated to the inner of this MarkGraphicLegend.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkGraphicLegend

public MarkGraphicLegend()

Builds a new default MarkGraphicLegend associated to a default MarkGraphic.

MarkGraphicLegend

public MarkGraphicLegend(MarkGraphic mark,
                 ParameterLegend wknLegend,
                 LegendStructure viewBoxLegend,
                 FillLegend fillLegend,
                 StrokeLegend strokeLegend)

Build a default LegendStructure that describes a MarkGraphic instance.

Parameters:

viewBoxLegend -

fillLegend -

strokeLegend -

Method Detail

getMarkGraphic

public MarkGraphic getMarkGraphic()

Gets the MarkGraphic associated to this LegendStructure.

Returns:

setMarkGraphic

public void setMarkGraphic(MarkGraphic markGraphic)

Sets the MarkGraphic associated to this LegendStructure.

Parameters:

markGraphic -

getFillLegend

public LegendStructure getFillLegend()

Get the LegendStructure associated to the Fill of the associated MarkGraphic.

Returns:

setFillLegend

public void setFillLegend(FillLegend fillLegend)

Set the LegendStructure associated to the Fill of the associated

Parameters:

fillLegend -

getStrokeLegend

public LegendStructure getStrokeLegend()

Get the LegendStructure associated to the Stroke contained in the inner MarkGraphic instance.

Returns:

setStrokeLegend

public void setStrokeLegend(StrokeLegend strokeLegend)

Set the LegendStructure associated to the Stroke contained in the inner MarkGraphic instance.

Parameters:

strokeLegend -

getViewBoxLegend

public LegendStructure getViewBoxLegend()

Get the LegendStructure associated to the ViewBox contained in the inner MarkGraphic instance.

Returns:

setViewBoxLegend

public void setViewBoxLegend(ViewBoxLegend viewBoxLegend)

Set the LegendStructure associated to the ViewBox contained in the inner MarkGraphic instance.

Parameters:

viewBoxLegend -

getWknLegend

public LegendStructure getWknLegend()

Get the legend associated to the inner well-known name representation.

Returns:

setWknLegend

public void setWknLegend(ParameterLegend wknLegend)

Sets the legend associated representing the well-known name associated to the inner of this MarkGraphicLegend.

Parameters:

wknLegend -